We recommend using Azure Native.
Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
azure.batch.getPool
Explore with Pulumi AI
Use this data source to access information about an existing Batch pool
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.batch.getPool({
name: "testbatchpool",
accountName: "testbatchaccount",
resourceGroupName: "test",
});
import pulumi
import pulumi_azure as azure
example = azure.batch.get_pool(name="testbatchpool",
account_name="testbatchaccount",
resource_group_name="test")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/batch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := batch.LookupPool(ctx, &batch.LookupPoolArgs{
Name: "testbatchpool",
AccountName: "testbatchaccount",
ResourceGroupName: "test",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Batch.GetPool.Invoke(new()
{
Name = "testbatchpool",
AccountName = "testbatchaccount",
ResourceGroupName = "test",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.batch.BatchFunctions;
import com.pulumi.azure.batch.inputs.GetPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = BatchFunctions.getPool(GetPoolArgs.builder()
.name("testbatchpool")
.accountName("testbatchaccount")
.resourceGroupName("test")
.build());
}
}
variables:
example:
fn::invoke:
Function: azure:batch:getPool
Arguments:
name: testbatchpool
accountName: testbatchaccount
resourceGroupName: test
Using getPool
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
def get_pool(account_name: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(account_name: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput
> Note: This function is named LookupPool
in the Go SDK.
public static class GetPool
{
public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:batch/getPool:getPool
arguments:
# arguments dictionary
The following arguments are supported:
- Account
Name string - The Azure Storage Account name.
- Name string
- The name of the user account.
- Resource
Group stringName
- Account
Name string - The Azure Storage Account name.
- Name string
- The name of the user account.
- Resource
Group stringName
- account
Name String - The Azure Storage Account name.
- name String
- The name of the user account.
- resource
Group StringName
- account
Name string - The Azure Storage Account name.
- name string
- The name of the user account.
- resource
Group stringName
- account_
name str - The Azure Storage Account name.
- name str
- The name of the user account.
- resource_
group_ strname
- account
Name String - The Azure Storage Account name.
- name String
- The name of the user account.
- resource
Group StringName
getPool Result
The following output properties are available:
- Account
Name string - The Azure Storage Account name.
- Auto
Scales List<GetPool Auto Scale> - A
auto_scale
block that describes the scale settings when using auto scale. - Certificates
List<Get
Pool Certificate> - One or more
certificate
blocks that describe the certificates installed on each compute node in the pool. - Container
Configurations List<GetPool Container Configuration> - The container configuration used in the pool's VMs.
- Data
Disks List<GetPool Data Disk> - A
data_disks
block describes the data disk settings. - Disk
Encryptions List<GetPool Disk Encryption> - A
disk_encryption
block describes the disk encryption configuration applied on compute nodes in the pool. - Display
Name string - Extensions
List<Get
Pool Extension> - An
extensions
block describes the extension settings - Fixed
Scales List<GetPool Fixed Scale> - A
fixed_scale
block that describes the scale settings when using fixed scale. - Id string
- The provider-assigned unique ID for this managed resource.
- Inter
Node stringCommunication - Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool.
- License
Type string - The type of on-premises license to be used when deploying the operating system.
- Max
Tasks intPer Node - The maximum number of tasks that can run concurrently on a single compute node in the pool.
- Metadata Dictionary<string, string>
- Mounts
List<Get
Pool Mount> - A
mount
block that describes mount configuration. - Name string
- The name of the user account.
- Network
Configurations List<GetPool Network Configuration> - Node
Agent stringSku Id - The SKU of the node agents in the Batch pool.
- Node
Placements List<GetPool Node Placement> - A
node_placement
block that describes the placement policy for allocating nodes in the pool. - Os
Disk stringPlacement - Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
- Resource
Group stringName - Start
Tasks List<GetPool Start Task> - A
start_task
block that describes the start task settings for the Batch pool. - Storage
Image List<GetReferences Pool Storage Image Reference> - The reference of the storage image used by the nodes in the Batch pool.
- Task
Scheduling List<GetPolicies Pool Task Scheduling Policy> - A
task_scheduling_policy
block that describes how tasks are distributed across compute nodes in a pool. - User
Accounts List<GetPool User Account> - A
user_accounts
block that describes the list of user accounts to be created on each node in the pool. - Vm
Size string - The size of the VM created in the Batch pool.
- Windows
List<Get
Pool Window> - A
windows
block that describes the Windows configuration in the pool.
- Account
Name string - The Azure Storage Account name.
- Auto
Scales []GetPool Auto Scale - A
auto_scale
block that describes the scale settings when using auto scale. - Certificates
[]Get
Pool Certificate - One or more
certificate
blocks that describe the certificates installed on each compute node in the pool. - Container
Configurations []GetPool Container Configuration - The container configuration used in the pool's VMs.
- Data
Disks []GetPool Data Disk - A
data_disks
block describes the data disk settings. - Disk
Encryptions []GetPool Disk Encryption - A
disk_encryption
block describes the disk encryption configuration applied on compute nodes in the pool. - Display
Name string - Extensions
[]Get
Pool Extension - An
extensions
block describes the extension settings - Fixed
Scales []GetPool Fixed Scale - A
fixed_scale
block that describes the scale settings when using fixed scale. - Id string
- The provider-assigned unique ID for this managed resource.
- Inter
Node stringCommunication - Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool.
- License
Type string - The type of on-premises license to be used when deploying the operating system.
- Max
Tasks intPer Node - The maximum number of tasks that can run concurrently on a single compute node in the pool.
- Metadata map[string]string
- Mounts
[]Get
Pool Mount - A
mount
block that describes mount configuration. - Name string
- The name of the user account.
- Network
Configurations []GetPool Network Configuration - Node
Agent stringSku Id - The SKU of the node agents in the Batch pool.
- Node
Placements []GetPool Node Placement - A
node_placement
block that describes the placement policy for allocating nodes in the pool. - Os
Disk stringPlacement - Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
- Resource
Group stringName - Start
Tasks []GetPool Start Task - A
start_task
block that describes the start task settings for the Batch pool. - Storage
Image []GetReferences Pool Storage Image Reference - The reference of the storage image used by the nodes in the Batch pool.
- Task
Scheduling []GetPolicies Pool Task Scheduling Policy - A
task_scheduling_policy
block that describes how tasks are distributed across compute nodes in a pool. - User
Accounts []GetPool User Account - A
user_accounts
block that describes the list of user accounts to be created on each node in the pool. - Vm
Size string - The size of the VM created in the Batch pool.
- Windows
[]Get
Pool Window - A
windows
block that describes the Windows configuration in the pool.
- account
Name String - The Azure Storage Account name.
- auto
Scales List<GetPool Auto Scale> - A
auto_scale
block that describes the scale settings when using auto scale. - certificates
List<Get
Pool Certificate> - One or more
certificate
blocks that describe the certificates installed on each compute node in the pool. - container
Configurations List<GetPool Container Configuration> - The container configuration used in the pool's VMs.
- data
Disks List<GetPool Data Disk> - A
data_disks
block describes the data disk settings. - disk
Encryptions List<GetPool Disk Encryption> - A
disk_encryption
block describes the disk encryption configuration applied on compute nodes in the pool. - display
Name String - extensions
List<Get
Pool Extension> - An
extensions
block describes the extension settings - fixed
Scales List<GetPool Fixed Scale> - A
fixed_scale
block that describes the scale settings when using fixed scale. - id String
- The provider-assigned unique ID for this managed resource.
- inter
Node StringCommunication - Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool.
- license
Type String - The type of on-premises license to be used when deploying the operating system.
- max
Tasks IntegerPer Node - The maximum number of tasks that can run concurrently on a single compute node in the pool.
- metadata Map<String,String>
- mounts
List<Get
Pool Mount> - A
mount
block that describes mount configuration. - name String
- The name of the user account.
- network
Configurations List<GetPool Network Configuration> - node
Agent StringSku Id - The SKU of the node agents in the Batch pool.
- node
Placements List<GetPool Node Placement> - A
node_placement
block that describes the placement policy for allocating nodes in the pool. - os
Disk StringPlacement - Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
- resource
Group StringName - start
Tasks List<GetPool Start Task> - A
start_task
block that describes the start task settings for the Batch pool. - storage
Image List<GetReferences Pool Storage Image Reference> - The reference of the storage image used by the nodes in the Batch pool.
- task
Scheduling List<GetPolicies Pool Task Scheduling Policy> - A
task_scheduling_policy
block that describes how tasks are distributed across compute nodes in a pool. - user
Accounts List<GetPool User Account> - A
user_accounts
block that describes the list of user accounts to be created on each node in the pool. - vm
Size String - The size of the VM created in the Batch pool.
- windows
List<Get
Pool Window> - A
windows
block that describes the Windows configuration in the pool.
- account
Name string - The Azure Storage Account name.
- auto
Scales GetPool Auto Scale[] - A
auto_scale
block that describes the scale settings when using auto scale. - certificates
Get
Pool Certificate[] - One or more
certificate
blocks that describe the certificates installed on each compute node in the pool. - container
Configurations GetPool Container Configuration[] - The container configuration used in the pool's VMs.
- data
Disks GetPool Data Disk[] - A
data_disks
block describes the data disk settings. - disk
Encryptions GetPool Disk Encryption[] - A
disk_encryption
block describes the disk encryption configuration applied on compute nodes in the pool. - display
Name string - extensions
Get
Pool Extension[] - An
extensions
block describes the extension settings - fixed
Scales GetPool Fixed Scale[] - A
fixed_scale
block that describes the scale settings when using fixed scale. - id string
- The provider-assigned unique ID for this managed resource.
- inter
Node stringCommunication - Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool.
- license
Type string - The type of on-premises license to be used when deploying the operating system.
- max
Tasks numberPer Node - The maximum number of tasks that can run concurrently on a single compute node in the pool.
- metadata {[key: string]: string}
- mounts
Get
Pool Mount[] - A
mount
block that describes mount configuration. - name string
- The name of the user account.
- network
Configurations GetPool Network Configuration[] - node
Agent stringSku Id - The SKU of the node agents in the Batch pool.
- node
Placements GetPool Node Placement[] - A
node_placement
block that describes the placement policy for allocating nodes in the pool. - os
Disk stringPlacement - Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
- resource
Group stringName - start
Tasks GetPool Start Task[] - A
start_task
block that describes the start task settings for the Batch pool. - storage
Image GetReferences Pool Storage Image Reference[] - The reference of the storage image used by the nodes in the Batch pool.
- task
Scheduling GetPolicies Pool Task Scheduling Policy[] - A
task_scheduling_policy
block that describes how tasks are distributed across compute nodes in a pool. - user
Accounts GetPool User Account[] - A
user_accounts
block that describes the list of user accounts to be created on each node in the pool. - vm
Size string - The size of the VM created in the Batch pool.
- windows
Get
Pool Window[] - A
windows
block that describes the Windows configuration in the pool.
- account_
name str - The Azure Storage Account name.
- auto_
scales Sequence[GetPool Auto Scale] - A
auto_scale
block that describes the scale settings when using auto scale. - certificates
Sequence[Get
Pool Certificate] - One or more
certificate
blocks that describe the certificates installed on each compute node in the pool. - container_
configurations Sequence[GetPool Container Configuration] - The container configuration used in the pool's VMs.
- data_
disks Sequence[GetPool Data Disk] - A
data_disks
block describes the data disk settings. - disk_
encryptions Sequence[GetPool Disk Encryption] - A
disk_encryption
block describes the disk encryption configuration applied on compute nodes in the pool. - display_
name str - extensions
Sequence[Get
Pool Extension] - An
extensions
block describes the extension settings - fixed_
scales Sequence[GetPool Fixed Scale] - A
fixed_scale
block that describes the scale settings when using fixed scale. - id str
- The provider-assigned unique ID for this managed resource.
- inter_
node_ strcommunication - Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool.
- license_
type str - The type of on-premises license to be used when deploying the operating system.
- max_
tasks_ intper_ node - The maximum number of tasks that can run concurrently on a single compute node in the pool.
- metadata Mapping[str, str]
- mounts
Sequence[Get
Pool Mount] - A
mount
block that describes mount configuration. - name str
- The name of the user account.
- network_
configurations Sequence[GetPool Network Configuration] - node_
agent_ strsku_ id - The SKU of the node agents in the Batch pool.
- node_
placements Sequence[GetPool Node Placement] - A
node_placement
block that describes the placement policy for allocating nodes in the pool. - os_
disk_ strplacement - Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
- resource_
group_ strname - start_
tasks Sequence[GetPool Start Task] - A
start_task
block that describes the start task settings for the Batch pool. - storage_
image_ Sequence[Getreferences Pool Storage Image Reference] - The reference of the storage image used by the nodes in the Batch pool.
- task_
scheduling_ Sequence[Getpolicies Pool Task Scheduling Policy] - A
task_scheduling_policy
block that describes how tasks are distributed across compute nodes in a pool. - user_
accounts Sequence[GetPool User Account] - A
user_accounts
block that describes the list of user accounts to be created on each node in the pool. - vm_
size str - The size of the VM created in the Batch pool.
- windows
Sequence[Get
Pool Window] - A
windows
block that describes the Windows configuration in the pool.
- account
Name String - The Azure Storage Account name.
- auto
Scales List<Property Map> - A
auto_scale
block that describes the scale settings when using auto scale. - certificates List<Property Map>
- One or more
certificate
blocks that describe the certificates installed on each compute node in the pool. - container
Configurations List<Property Map> - The container configuration used in the pool's VMs.
- data
Disks List<Property Map> - A
data_disks
block describes the data disk settings. - disk
Encryptions List<Property Map> - A
disk_encryption
block describes the disk encryption configuration applied on compute nodes in the pool. - display
Name String - extensions List<Property Map>
- An
extensions
block describes the extension settings - fixed
Scales List<Property Map> - A
fixed_scale
block that describes the scale settings when using fixed scale. - id String
- The provider-assigned unique ID for this managed resource.
- inter
Node StringCommunication - Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool.
- license
Type String - The type of on-premises license to be used when deploying the operating system.
- max
Tasks NumberPer Node - The maximum number of tasks that can run concurrently on a single compute node in the pool.
- metadata Map<String>
- mounts List<Property Map>
- A
mount
block that describes mount configuration. - name String
- The name of the user account.
- network
Configurations List<Property Map> - node
Agent StringSku Id - The SKU of the node agents in the Batch pool.
- node
Placements List<Property Map> - A
node_placement
block that describes the placement policy for allocating nodes in the pool. - os
Disk StringPlacement - Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
- resource
Group StringName - start
Tasks List<Property Map> - A
start_task
block that describes the start task settings for the Batch pool. - storage
Image List<Property Map>References - The reference of the storage image used by the nodes in the Batch pool.
- task
Scheduling List<Property Map>Policies - A
task_scheduling_policy
block that describes how tasks are distributed across compute nodes in a pool. - user
Accounts List<Property Map> - A
user_accounts
block that describes the list of user accounts to be created on each node in the pool. - vm
Size String - The size of the VM created in the Batch pool.
- windows List<Property Map>
- A
windows
block that describes the Windows configuration in the pool.
Supporting Types
GetPoolAutoScale
- Evaluation
Interval string - The interval to wait before evaluating if the pool needs to be scaled.
- Formula string
- The autoscale formula that needs to be used for scaling the Batch pool.
- Evaluation
Interval string - The interval to wait before evaluating if the pool needs to be scaled.
- Formula string
- The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation
Interval String - The interval to wait before evaluating if the pool needs to be scaled.
- formula String
- The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation
Interval string - The interval to wait before evaluating if the pool needs to be scaled.
- formula string
- The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation_
interval str - The interval to wait before evaluating if the pool needs to be scaled.
- formula str
- The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation
Interval String - The interval to wait before evaluating if the pool needs to be scaled.
- formula String
- The autoscale formula that needs to be used for scaling the Batch pool.
GetPoolCertificate
- Id string
- The fully qualified ID of the certificate installed on the pool.
- Store
Location string - The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
. - Store
Name string - The name of the certificate store on the compute node into which the certificate is installed.
- Visibilities List<string>
- Which user accounts on the compute node have access to the private data of the certificate.
- Id string
- The fully qualified ID of the certificate installed on the pool.
- Store
Location string - The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
. - Store
Name string - The name of the certificate store on the compute node into which the certificate is installed.
- Visibilities []string
- Which user accounts on the compute node have access to the private data of the certificate.
- id String
- The fully qualified ID of the certificate installed on the pool.
- store
Location String - The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
. - store
Name String - The name of the certificate store on the compute node into which the certificate is installed.
- visibilities List<String>
- Which user accounts on the compute node have access to the private data of the certificate.
- id string
- The fully qualified ID of the certificate installed on the pool.
- store
Location string - The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
. - store
Name string - The name of the certificate store on the compute node into which the certificate is installed.
- visibilities string[]
- Which user accounts on the compute node have access to the private data of the certificate.
- id str
- The fully qualified ID of the certificate installed on the pool.
- store_
location str - The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
. - store_
name str - The name of the certificate store on the compute node into which the certificate is installed.
- visibilities Sequence[str]
- Which user accounts on the compute node have access to the private data of the certificate.
- id String
- The fully qualified ID of the certificate installed on the pool.
- store
Location String - The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
. - store
Name String - The name of the certificate store on the compute node into which the certificate is installed.
- visibilities List<String>
- Which user accounts on the compute node have access to the private data of the certificate.
GetPoolContainerConfiguration
- Container
Image List<string>Names - A list of container image names to use, as would be specified by
docker pull
. - Container
Registries List<GetPool Container Configuration Container Registry> - Additional container registries from which container images can be pulled by the pool's VMs.
- Type string
- The type of container configuration.
- Container
Image []stringNames - A list of container image names to use, as would be specified by
docker pull
. - Container
Registries []GetPool Container Configuration Container Registry - Additional container registries from which container images can be pulled by the pool's VMs.
- Type string
- The type of container configuration.
- container
Image List<String>Names - A list of container image names to use, as would be specified by
docker pull
. - container
Registries List<GetPool Container Configuration Container Registry> - Additional container registries from which container images can be pulled by the pool's VMs.
- type String
- The type of container configuration.
- container
Image string[]Names - A list of container image names to use, as would be specified by
docker pull
. - container
Registries GetPool Container Configuration Container Registry[] - Additional container registries from which container images can be pulled by the pool's VMs.
- type string
- The type of container configuration.
- container_
image_ Sequence[str]names - A list of container image names to use, as would be specified by
docker pull
. - container_
registries Sequence[GetPool Container Configuration Container Registry] - Additional container registries from which container images can be pulled by the pool's VMs.
- type str
- The type of container configuration.
- container
Image List<String>Names - A list of container image names to use, as would be specified by
docker pull
. - container
Registries List<Property Map> - Additional container registries from which container images can be pulled by the pool's VMs.
- type String
- The type of container configuration.
GetPoolContainerConfigurationContainerRegistry
- Password string
- The password for the user account.
- Registry
Server string - The container registry URL. The default is "docker.io".
- User
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- User
Name string - The user to use for authentication against the CIFS file system.
- Password string
- The password for the user account.
- Registry
Server string - The container registry URL. The default is "docker.io".
- User
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- User
Name string - The user to use for authentication against the CIFS file system.
- password String
- The password for the user account.
- registry
Server String - The container registry URL. The default is "docker.io".
- user
Assigned StringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user
Name String - The user to use for authentication against the CIFS file system.
- password string
- The password for the user account.
- registry
Server string - The container registry URL. The default is "docker.io".
- user
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user
Name string - The user to use for authentication against the CIFS file system.
- password str
- The password for the user account.
- registry_
server str - The container registry URL. The default is "docker.io".
- user_
assigned_ stridentity_ id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user_
name str - The user to use for authentication against the CIFS file system.
- password String
- The password for the user account.
- registry
Server String - The container registry URL. The default is "docker.io".
- user
Assigned StringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user
Name String - The user to use for authentication against the CIFS file system.
GetPoolDataDisk
- Caching string
- The caching mode of data disks.
- Disk
Size intGb - The initial disk size in GB when creating new data disk.
- Lun int
- The lun is used to uniquely identify each data disk.
- Storage
Account stringType - The storage account type to be used for the data disk.
- Caching string
- The caching mode of data disks.
- Disk
Size intGb - The initial disk size in GB when creating new data disk.
- Lun int
- The lun is used to uniquely identify each data disk.
- Storage
Account stringType - The storage account type to be used for the data disk.
- caching String
- The caching mode of data disks.
- disk
Size IntegerGb - The initial disk size in GB when creating new data disk.
- lun Integer
- The lun is used to uniquely identify each data disk.
- storage
Account StringType - The storage account type to be used for the data disk.
- caching string
- The caching mode of data disks.
- disk
Size numberGb - The initial disk size in GB when creating new data disk.
- lun number
- The lun is used to uniquely identify each data disk.
- storage
Account stringType - The storage account type to be used for the data disk.
- caching str
- The caching mode of data disks.
- disk_
size_ intgb - The initial disk size in GB when creating new data disk.
- lun int
- The lun is used to uniquely identify each data disk.
- storage_
account_ strtype - The storage account type to be used for the data disk.
- caching String
- The caching mode of data disks.
- disk
Size NumberGb - The initial disk size in GB when creating new data disk.
- lun Number
- The lun is used to uniquely identify each data disk.
- storage
Account StringType - The storage account type to be used for the data disk.
GetPoolDiskEncryption
- Disk
Encryption stringTarget - On Linux pool, only
TemporaryDisk
is supported; on Windows pool,OsDisk
andTemporaryDisk
must be specified.
- Disk
Encryption stringTarget - On Linux pool, only
TemporaryDisk
is supported; on Windows pool,OsDisk
andTemporaryDisk
must be specified.
- disk
Encryption StringTarget - On Linux pool, only
TemporaryDisk
is supported; on Windows pool,OsDisk
andTemporaryDisk
must be specified.
- disk
Encryption stringTarget - On Linux pool, only
TemporaryDisk
is supported; on Windows pool,OsDisk
andTemporaryDisk
must be specified.
- disk_
encryption_ strtarget - On Linux pool, only
TemporaryDisk
is supported; on Windows pool,OsDisk
andTemporaryDisk
must be specified.
- disk
Encryption StringTarget - On Linux pool, only
TemporaryDisk
is supported; on Windows pool,OsDisk
andTemporaryDisk
must be specified.
GetPoolExtension
- Auto
Upgrade boolMinor Version - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- Name string
- The name of the user account.
- Protected
Settings string - The extension can contain either
protected_settings
orprovision_after_extensions
or no protected settings at all. - Provision
After List<string>Extensions - The collection of extension names. Collection of extension names after which this extension needs to be provisioned.
- Publisher string
- The name of the extension handler publisher.The name of the extension handler publisher.
- Settings
Json string - JSON formatted public settings for the extension.
- Type string
- The type of container configuration.
- Type
Handler stringVersion - The version of script handler.
- Auto
Upgrade boolMinor Version - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- Name string
- The name of the user account.
- Protected
Settings string - The extension can contain either
protected_settings
orprovision_after_extensions
or no protected settings at all. - Provision
After []stringExtensions - The collection of extension names. Collection of extension names after which this extension needs to be provisioned.
- Publisher string
- The name of the extension handler publisher.The name of the extension handler publisher.
- Settings
Json string - JSON formatted public settings for the extension.
- Type string
- The type of container configuration.
- Type
Handler stringVersion - The version of script handler.
- auto
Upgrade BooleanMinor Version - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- name String
- The name of the user account.
- protected
Settings String - The extension can contain either
protected_settings
orprovision_after_extensions
or no protected settings at all. - provision
After List<String>Extensions - The collection of extension names. Collection of extension names after which this extension needs to be provisioned.
- publisher String
- The name of the extension handler publisher.The name of the extension handler publisher.
- settings
Json String - JSON formatted public settings for the extension.
- type String
- The type of container configuration.
- type
Handler StringVersion - The version of script handler.
- auto
Upgrade booleanMinor Version - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- name string
- The name of the user account.
- protected
Settings string - The extension can contain either
protected_settings
orprovision_after_extensions
or no protected settings at all. - provision
After string[]Extensions - The collection of extension names. Collection of extension names after which this extension needs to be provisioned.
- publisher string
- The name of the extension handler publisher.The name of the extension handler publisher.
- settings
Json string - JSON formatted public settings for the extension.
- type string
- The type of container configuration.
- type
Handler stringVersion - The version of script handler.
- auto_
upgrade_ boolminor_ version - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- name str
- The name of the user account.
- protected_
settings str - The extension can contain either
protected_settings
orprovision_after_extensions
or no protected settings at all. - provision_
after_ Sequence[str]extensions - The collection of extension names. Collection of extension names after which this extension needs to be provisioned.
- publisher str
- The name of the extension handler publisher.The name of the extension handler publisher.
- settings_
json str - JSON formatted public settings for the extension.
- type str
- The type of container configuration.
- type_
handler_ strversion - The version of script handler.
- auto
Upgrade BooleanMinor Version - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- name String
- The name of the user account.
- protected
Settings String - The extension can contain either
protected_settings
orprovision_after_extensions
or no protected settings at all. - provision
After List<String>Extensions - The collection of extension names. Collection of extension names after which this extension needs to be provisioned.
- publisher String
- The name of the extension handler publisher.The name of the extension handler publisher.
- settings
Json String - JSON formatted public settings for the extension.
- type String
- The type of container configuration.
- type
Handler StringVersion - The version of script handler.
GetPoolFixedScale
- Resize
Timeout string - The timeout for resize operations.
- Target
Dedicated intNodes - The number of nodes in the Batch pool.
- Target
Low intPriority Nodes - The number of low priority nodes in the Batch pool.
- Resize
Timeout string - The timeout for resize operations.
- Target
Dedicated intNodes - The number of nodes in the Batch pool.
- Target
Low intPriority Nodes - The number of low priority nodes in the Batch pool.
- resize
Timeout String - The timeout for resize operations.
- target
Dedicated IntegerNodes - The number of nodes in the Batch pool.
- target
Low IntegerPriority Nodes - The number of low priority nodes in the Batch pool.
- resize
Timeout string - The timeout for resize operations.
- target
Dedicated numberNodes - The number of nodes in the Batch pool.
- target
Low numberPriority Nodes - The number of low priority nodes in the Batch pool.
- resize_
timeout str - The timeout for resize operations.
- target_
dedicated_ intnodes - The number of nodes in the Batch pool.
- target_
low_ intpriority_ nodes - The number of low priority nodes in the Batch pool.
- resize
Timeout String - The timeout for resize operations.
- target
Dedicated NumberNodes - The number of nodes in the Batch pool.
- target
Low NumberPriority Nodes - The number of low priority nodes in the Batch pool.
GetPoolMount
- Cifs
Mounts List<GetPool Mount Cifs Mount> - A
cifs_mount
block defined as below. - Nfs
Mounts List<GetPool Mount Nfs Mount> - A
nfs_mount
block defined as below. - Azure
Blob List<GetFile Systems Pool Mount Azure Blob File System> - A
azure_blob_file_system
block defined as below. - List<Get
Pool Mount Azure File Share> - A
azure_file_share
block defined as below.
- Cifs
Mounts []GetPool Mount Cifs Mount - A
cifs_mount
block defined as below. - Nfs
Mounts []GetPool Mount Nfs Mount - A
nfs_mount
block defined as below. - Azure
Blob []GetFile Systems Pool Mount Azure Blob File System - A
azure_blob_file_system
block defined as below. - []Get
Pool Mount Azure File Share - A
azure_file_share
block defined as below.
- cifs
Mounts List<GetPool Mount Cifs Mount> - A
cifs_mount
block defined as below. - nfs
Mounts List<GetPool Mount Nfs Mount> - A
nfs_mount
block defined as below. - azure
Blob List<GetFile Systems Pool Mount Azure Blob File System> - A
azure_blob_file_system
block defined as below. - List<Get
Pool Mount Azure File Share> - A
azure_file_share
block defined as below.
- cifs
Mounts GetPool Mount Cifs Mount[] - A
cifs_mount
block defined as below. - nfs
Mounts GetPool Mount Nfs Mount[] - A
nfs_mount
block defined as below. - azure
Blob GetFile Systems Pool Mount Azure Blob File System[] - A
azure_blob_file_system
block defined as below. - Get
Pool Mount Azure File Share[] - A
azure_file_share
block defined as below.
- cifs_
mounts Sequence[GetPool Mount Cifs Mount] - A
cifs_mount
block defined as below. - nfs_
mounts Sequence[GetPool Mount Nfs Mount] - A
nfs_mount
block defined as below. - azure_
blob_ Sequence[Getfile_ systems Pool Mount Azure Blob File System] - A
azure_blob_file_system
block defined as below. - Sequence[Get
Pool Mount Azure File Share] - A
azure_file_share
block defined as below.
- cifs
Mounts List<Property Map> - A
cifs_mount
block defined as below. - nfs
Mounts List<Property Map> - A
nfs_mount
block defined as below. - azure
Blob List<Property Map>File Systems - A
azure_blob_file_system
block defined as below. - List<Property Map>
- A
azure_file_share
block defined as below.
GetPoolMountAzureBlobFileSystem
- Account
Key string - The Azure Storage Account key.
- Account
Name string - The Azure Storage Account name.
- Blobfuse
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Container
Name string - The Azure Blob Storage Container name.
- Identity
Id string - The ARM resource id of the user assigned identity. This property is mutually exclusive with both
account_key
andsas_key
; exactly one must be specified. - Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - Sas
Key string - The Azure Storage SAS token. This property is mutually exclusive with both
account_key
andidentity_id
; exactly one must be specified.
- Account
Key string - The Azure Storage Account key.
- Account
Name string - The Azure Storage Account name.
- Blobfuse
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Container
Name string - The Azure Blob Storage Container name.
- Identity
Id string - The ARM resource id of the user assigned identity. This property is mutually exclusive with both
account_key
andsas_key
; exactly one must be specified. - Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - Sas
Key string - The Azure Storage SAS token. This property is mutually exclusive with both
account_key
andidentity_id
; exactly one must be specified.
- account
Key String - The Azure Storage Account key.
- account
Name String - The Azure Storage Account name.
- blobfuse
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- container
Name String - The Azure Blob Storage Container name.
- identity
Id String - The ARM resource id of the user assigned identity. This property is mutually exclusive with both
account_key
andsas_key
; exactly one must be specified. - relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - sas
Key String - The Azure Storage SAS token. This property is mutually exclusive with both
account_key
andidentity_id
; exactly one must be specified.
- account
Key string - The Azure Storage Account key.
- account
Name string - The Azure Storage Account name.
- blobfuse
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- container
Name string - The Azure Blob Storage Container name.
- identity
Id string - The ARM resource id of the user assigned identity. This property is mutually exclusive with both
account_key
andsas_key
; exactly one must be specified. - relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - sas
Key string - The Azure Storage SAS token. This property is mutually exclusive with both
account_key
andidentity_id
; exactly one must be specified.
- account_
key str - The Azure Storage Account key.
- account_
name str - The Azure Storage Account name.
- blobfuse_
options str - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- container_
name str - The Azure Blob Storage Container name.
- identity_
id str - The ARM resource id of the user assigned identity. This property is mutually exclusive with both
account_key
andsas_key
; exactly one must be specified. - relative_
mount_ strpath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - sas_
key str - The Azure Storage SAS token. This property is mutually exclusive with both
account_key
andidentity_id
; exactly one must be specified.
- account
Key String - The Azure Storage Account key.
- account
Name String - The Azure Storage Account name.
- blobfuse
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- container
Name String - The Azure Blob Storage Container name.
- identity
Id String - The ARM resource id of the user assigned identity. This property is mutually exclusive with both
account_key
andsas_key
; exactly one must be specified. - relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - sas
Key String - The Azure Storage SAS token. This property is mutually exclusive with both
account_key
andidentity_id
; exactly one must be specified.
GetPoolMountAzureFileShare
- Account
Key string - The Azure Storage Account key.
- Account
Name string - The Azure Storage Account name.
- Azure
File stringUrl - The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
- Mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable.
- Account
Key string - The Azure Storage Account key.
- Account
Name string - The Azure Storage Account name.
- Azure
File stringUrl - The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
- Mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable.
- account
Key String - The Azure Storage Account key.
- account
Name String - The Azure Storage Account name.
- azure
File StringUrl - The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
- mount
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable.
- account
Key string - The Azure Storage Account key.
- account
Name string - The Azure Storage Account name.
- azure
File stringUrl - The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
- mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable.
- account_
key str - The Azure Storage Account key.
- account_
name str - The Azure Storage Account name.
- azure_
file_ strurl - The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
- mount_
options str - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative_
mount_ strpath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable.
- account
Key String - The Azure Storage Account key.
- account
Name String - The Azure Storage Account name.
- azure
File StringUrl - The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
- mount
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable.
GetPoolMountCifsMount
- Mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Password string
- The password for the user account.
- Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - Source string
- The URI of the file system to mount.
- User
Name string - The user to use for authentication against the CIFS file system.
- Mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Password string
- The password for the user account.
- Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - Source string
- The URI of the file system to mount.
- User
Name string - The user to use for authentication against the CIFS file system.
- mount
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- password String
- The password for the user account.
- relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source String
- The URI of the file system to mount.
- user
Name String - The user to use for authentication against the CIFS file system.
- mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- password string
- The password for the user account.
- relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source string
- The URI of the file system to mount.
- user
Name string - The user to use for authentication against the CIFS file system.
- mount_
options str - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- password str
- The password for the user account.
- relative_
mount_ strpath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source str
- The URI of the file system to mount.
- user_
name str - The user to use for authentication against the CIFS file system.
- mount
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- password String
- The password for the user account.
- relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source String
- The URI of the file system to mount.
- user
Name String - The user to use for authentication against the CIFS file system.
GetPoolMountNfsMount
- Mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - Source string
- The URI of the file system to mount.
- Mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- Relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - Source string
- The URI of the file system to mount.
- mount
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source String
- The URI of the file system to mount.
- mount
Options string - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative
Mount stringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source string
- The URI of the file system to mount.
- mount_
options str - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative_
mount_ strpath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source str
- The URI of the file system to mount.
- mount
Options String - Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
- relative
Mount StringPath - The relative path on compute node where the file system will be mounted All file systems are mounted relative to the Batch mounts directory, accessible via the
AZ_BATCH_NODE_MOUNTS_DIR
environment variable. - source String
- The URI of the file system to mount.
GetPoolNetworkConfiguration
- Accelerated
Networking boolEnabled - Dynamic
Vnet stringAssignment Scope - The scope of dynamic vnet assignment.
- Endpoint
Configurations List<GetPool Network Configuration Endpoint Configuration> - The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- Public
Address stringProvisioning Type - Type of public IP address provisioning.
- Public
Ips List<string> - A list of public IP ids that will be allocated to nodes.
- Subnet
Id string - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- Accelerated
Networking boolEnabled - Dynamic
Vnet stringAssignment Scope - The scope of dynamic vnet assignment.
- Endpoint
Configurations []GetPool Network Configuration Endpoint Configuration - The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- Public
Address stringProvisioning Type - Type of public IP address provisioning.
- Public
Ips []string - A list of public IP ids that will be allocated to nodes.
- Subnet
Id string - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- accelerated
Networking BooleanEnabled - dynamic
Vnet StringAssignment Scope - The scope of dynamic vnet assignment.
- endpoint
Configurations List<GetPool Network Configuration Endpoint Configuration> - The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- public
Address StringProvisioning Type - Type of public IP address provisioning.
- public
Ips List<String> - A list of public IP ids that will be allocated to nodes.
- subnet
Id String - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- accelerated
Networking booleanEnabled - dynamic
Vnet stringAssignment Scope - The scope of dynamic vnet assignment.
- endpoint
Configurations GetPool Network Configuration Endpoint Configuration[] - The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- public
Address stringProvisioning Type - Type of public IP address provisioning.
- public
Ips string[] - A list of public IP ids that will be allocated to nodes.
- subnet
Id string - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- accelerated_
networking_ boolenabled - dynamic_
vnet_ strassignment_ scope - The scope of dynamic vnet assignment.
- endpoint_
configurations Sequence[GetPool Network Configuration Endpoint Configuration] - The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- public_
address_ strprovisioning_ type - Type of public IP address provisioning.
- public_
ips Sequence[str] - A list of public IP ids that will be allocated to nodes.
- subnet_
id str - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- accelerated
Networking BooleanEnabled - dynamic
Vnet StringAssignment Scope - The scope of dynamic vnet assignment.
- endpoint
Configurations List<Property Map> - The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- public
Address StringProvisioning Type - Type of public IP address provisioning.
- public
Ips List<String> - A list of public IP ids that will be allocated to nodes.
- subnet
Id String - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
GetPoolNetworkConfigurationEndpointConfiguration
- Backend
Port int - The port number on the compute node.
- Frontend
Port stringRange - The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
. - Name string
- The name of the user account.
- Network
Security List<GetGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule> - The list of network security group rules that are applied to the endpoint.
- Protocol string
- The protocol of the endpoint.
- Backend
Port int - The port number on the compute node.
- Frontend
Port stringRange - The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
. - Name string
- The name of the user account.
- Network
Security []GetGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule - The list of network security group rules that are applied to the endpoint.
- Protocol string
- The protocol of the endpoint.
- backend
Port Integer - The port number on the compute node.
- frontend
Port StringRange - The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
. - name String
- The name of the user account.
- network
Security List<GetGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule> - The list of network security group rules that are applied to the endpoint.
- protocol String
- The protocol of the endpoint.
- backend
Port number - The port number on the compute node.
- frontend
Port stringRange - The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
. - name string
- The name of the user account.
- network
Security GetGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule[] - The list of network security group rules that are applied to the endpoint.
- protocol string
- The protocol of the endpoint.
- backend_
port int - The port number on the compute node.
- frontend_
port_ strrange - The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
. - name str
- The name of the user account.
- network_
security_ Sequence[Getgroup_ rules Pool Network Configuration Endpoint Configuration Network Security Group Rule] - The list of network security group rules that are applied to the endpoint.
- protocol str
- The protocol of the endpoint.
- backend
Port Number - The port number on the compute node.
- frontend
Port StringRange - The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
. - name String
- The name of the user account.
- network
Security List<Property Map>Group Rules - The list of network security group rules that are applied to the endpoint.
- protocol String
- The protocol of the endpoint.
GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule
- Access string
- The action that should be taken for a specified IP address, subnet range or tag.
- Priority int
- The priority for this rule.
- Source
Address stringPrefix - The source address prefix or tag to match for the rule.
- Source
Port List<string>Ranges - The source port ranges to match for the rule.
- Access string
- The action that should be taken for a specified IP address, subnet range or tag.
- Priority int
- The priority for this rule.
- Source
Address stringPrefix - The source address prefix or tag to match for the rule.
- Source
Port []stringRanges - The source port ranges to match for the rule.
- access String
- The action that should be taken for a specified IP address, subnet range or tag.
- priority Integer
- The priority for this rule.
- source
Address StringPrefix - The source address prefix or tag to match for the rule.
- source
Port List<String>Ranges - The source port ranges to match for the rule.
- access string
- The action that should be taken for a specified IP address, subnet range or tag.
- priority number
- The priority for this rule.
- source
Address stringPrefix - The source address prefix or tag to match for the rule.
- source
Port string[]Ranges - The source port ranges to match for the rule.
- access str
- The action that should be taken for a specified IP address, subnet range or tag.
- priority int
- The priority for this rule.
- source_
address_ strprefix - The source address prefix or tag to match for the rule.
- source_
port_ Sequence[str]ranges - The source port ranges to match for the rule.
- access String
- The action that should be taken for a specified IP address, subnet range or tag.
- priority Number
- The priority for this rule.
- source
Address StringPrefix - The source address prefix or tag to match for the rule.
- source
Port List<String>Ranges - The source port ranges to match for the rule.
GetPoolNodePlacement
- Policy string
- The placement policy for allocating nodes in the pool.
- Policy string
- The placement policy for allocating nodes in the pool.
- policy String
- The placement policy for allocating nodes in the pool.
- policy string
- The placement policy for allocating nodes in the pool.
- policy str
- The placement policy for allocating nodes in the pool.
- policy String
- The placement policy for allocating nodes in the pool.
GetPoolStartTask
- Command
Line string - The command line executed by the start task.
- Containers
List<Get
Pool Start Task Container> - The settings for the container under which the start task runs.
- Resource
Files List<GetPool Start Task Resource File> - One or more
resource_file
blocks that describe the files to be downloaded to a compute node. - Task
Retry intMaximum - The number of retry count
- User
Identities List<GetPool Start Task User Identity> - A
user_identity
block that describes the user identity under which the start task runs. - Wait
For boolSuccess - A flag that indicates if the Batch pool should wait for the start task to be completed.
- Common
Environment Dictionary<string, string>Properties - A map of strings (key,value) that represents the environment variables to set in the start task.
- Command
Line string - The command line executed by the start task.
- Containers
[]Get
Pool Start Task Container - The settings for the container under which the start task runs.
- Resource
Files []GetPool Start Task Resource File - One or more
resource_file
blocks that describe the files to be downloaded to a compute node. - Task
Retry intMaximum - The number of retry count
- User
Identities []GetPool Start Task User Identity - A
user_identity
block that describes the user identity under which the start task runs. - Wait
For boolSuccess - A flag that indicates if the Batch pool should wait for the start task to be completed.
- Common
Environment map[string]stringProperties - A map of strings (key,value) that represents the environment variables to set in the start task.
- command
Line String - The command line executed by the start task.
- containers
List<Get
Pool Start Task Container> - The settings for the container under which the start task runs.
- resource
Files List<GetPool Start Task Resource File> - One or more
resource_file
blocks that describe the files to be downloaded to a compute node. - task
Retry IntegerMaximum - The number of retry count
- user
Identities List<GetPool Start Task User Identity> - A
user_identity
block that describes the user identity under which the start task runs. - wait
For BooleanSuccess - A flag that indicates if the Batch pool should wait for the start task to be completed.
- common
Environment Map<String,String>Properties - A map of strings (key,value) that represents the environment variables to set in the start task.
- command
Line string - The command line executed by the start task.
- containers
Get
Pool Start Task Container[] - The settings for the container under which the start task runs.
- resource
Files GetPool Start Task Resource File[] - One or more
resource_file
blocks that describe the files to be downloaded to a compute node. - task
Retry numberMaximum - The number of retry count
- user
Identities GetPool Start Task User Identity[] - A
user_identity
block that describes the user identity under which the start task runs. - wait
For booleanSuccess - A flag that indicates if the Batch pool should wait for the start task to be completed.
- common
Environment {[key: string]: string}Properties - A map of strings (key,value) that represents the environment variables to set in the start task.
- command_
line str - The command line executed by the start task.
- containers
Sequence[Get
Pool Start Task Container] - The settings for the container under which the start task runs.
- resource_
files Sequence[GetPool Start Task Resource File] - One or more
resource_file
blocks that describe the files to be downloaded to a compute node. - task_
retry_ intmaximum - The number of retry count
- user_
identities Sequence[GetPool Start Task User Identity] - A
user_identity
block that describes the user identity under which the start task runs. - wait_
for_ boolsuccess - A flag that indicates if the Batch pool should wait for the start task to be completed.
- common_
environment_ Mapping[str, str]properties - A map of strings (key,value) that represents the environment variables to set in the start task.
- command
Line String - The command line executed by the start task.
- containers List<Property Map>
- The settings for the container under which the start task runs.
- resource
Files List<Property Map> - One or more
resource_file
blocks that describe the files to be downloaded to a compute node. - task
Retry NumberMaximum - The number of retry count
- user
Identities List<Property Map> - A
user_identity
block that describes the user identity under which the start task runs. - wait
For BooleanSuccess - A flag that indicates if the Batch pool should wait for the start task to be completed.
- common
Environment Map<String>Properties - A map of strings (key,value) that represents the environment variables to set in the start task.
GetPoolStartTaskContainer
- Image
Name string - The image to use to create the container in which the task will run.
- Registries
List<Get
Pool Start Task Container Registry> - The same reference as
container_registries
block defined as follows. - Run
Options string - Additional options to the container create command.
- Working
Directory string - A flag to indicate where the container task working directory is.
- Image
Name string - The image to use to create the container in which the task will run.
- Registries
[]Get
Pool Start Task Container Registry - The same reference as
container_registries
block defined as follows. - Run
Options string - Additional options to the container create command.
- Working
Directory string - A flag to indicate where the container task working directory is.
- image
Name String - The image to use to create the container in which the task will run.
- registries
List<Get
Pool Start Task Container Registry> - The same reference as
container_registries
block defined as follows. - run
Options String - Additional options to the container create command.
- working
Directory String - A flag to indicate where the container task working directory is.
- image
Name string - The image to use to create the container in which the task will run.
- registries
Get
Pool Start Task Container Registry[] - The same reference as
container_registries
block defined as follows. - run
Options string - Additional options to the container create command.
- working
Directory string - A flag to indicate where the container task working directory is.
- image_
name str - The image to use to create the container in which the task will run.
- registries
Sequence[Get
Pool Start Task Container Registry] - The same reference as
container_registries
block defined as follows. - run_
options str - Additional options to the container create command.
- working_
directory str - A flag to indicate where the container task working directory is.
- image
Name String - The image to use to create the container in which the task will run.
- registries List<Property Map>
- The same reference as
container_registries
block defined as follows. - run
Options String - Additional options to the container create command.
- working
Directory String - A flag to indicate where the container task working directory is.
GetPoolStartTaskContainerRegistry
- Password string
- The password for the user account.
- Registry
Server string - The container registry URL. The default is "docker.io".
- User
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- User
Name string - The user to use for authentication against the CIFS file system.
- Password string
- The password for the user account.
- Registry
Server string - The container registry URL. The default is "docker.io".
- User
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- User
Name string - The user to use for authentication against the CIFS file system.
- password String
- The password for the user account.
- registry
Server String - The container registry URL. The default is "docker.io".
- user
Assigned StringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user
Name String - The user to use for authentication against the CIFS file system.
- password string
- The password for the user account.
- registry
Server string - The container registry URL. The default is "docker.io".
- user
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user
Name string - The user to use for authentication against the CIFS file system.
- password str
- The password for the user account.
- registry_
server str - The container registry URL. The default is "docker.io".
- user_
assigned_ stridentity_ id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user_
name str - The user to use for authentication against the CIFS file system.
- password String
- The password for the user account.
- registry
Server String - The container registry URL. The default is "docker.io".
- user
Assigned StringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- user
Name String - The user to use for authentication against the CIFS file system.
GetPoolStartTaskResourceFile
- Auto
Storage stringContainer Name - The storage container name in the auto storage account.
- Blob
Prefix string - The blob prefix used when downloading blobs from an Azure Storage container.
- File
Mode string - The file permission mode attribute represented as a string in octal format (e.g.
"0644"
). - File
Path string - The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified. - Http
Url string - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- Storage
Container stringUrl - The URL of the blob container within Azure Blob Storage.
- User
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- Auto
Storage stringContainer Name - The storage container name in the auto storage account.
- Blob
Prefix string - The blob prefix used when downloading blobs from an Azure Storage container.
- File
Mode string - The file permission mode attribute represented as a string in octal format (e.g.
"0644"
). - File
Path string - The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified. - Http
Url string - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- Storage
Container stringUrl - The URL of the blob container within Azure Blob Storage.
- User
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- auto
Storage StringContainer Name - The storage container name in the auto storage account.
- blob
Prefix String - The blob prefix used when downloading blobs from an Azure Storage container.
- file
Mode String - The file permission mode attribute represented as a string in octal format (e.g.
"0644"
). - file
Path String - The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified. - http
Url String - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage
Container StringUrl - The URL of the blob container within Azure Blob Storage.
- user
Assigned StringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- auto
Storage stringContainer Name - The storage container name in the auto storage account.
- blob
Prefix string - The blob prefix used when downloading blobs from an Azure Storage container.
- file
Mode string - The file permission mode attribute represented as a string in octal format (e.g.
"0644"
). - file
Path string - The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified. - http
Url string - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage
Container stringUrl - The URL of the blob container within Azure Blob Storage.
- user
Assigned stringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- auto_
storage_ strcontainer_ name - The storage container name in the auto storage account.
- blob_
prefix str - The blob prefix used when downloading blobs from an Azure Storage container.
- file_
mode str - The file permission mode attribute represented as a string in octal format (e.g.
"0644"
). - file_
path str - The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified. - http_
url str - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage_
container_ strurl - The URL of the blob container within Azure Blob Storage.
- user_
assigned_ stridentity_ id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
- auto
Storage StringContainer Name - The storage container name in the auto storage account.
- blob
Prefix String - The blob prefix used when downloading blobs from an Azure Storage container.
- file
Mode String - The file permission mode attribute represented as a string in octal format (e.g.
"0644"
). - file
Path String - The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified. - http
Url String - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage
Container StringUrl - The URL of the blob container within Azure Blob Storage.
- user
Assigned StringIdentity Id - The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
GetPoolStartTaskUserIdentity
- Auto
Users List<GetPool Start Task User Identity Auto User> - A
auto_user
block that describes the user identity under which the start task runs. - User
Name string - The user to use for authentication against the CIFS file system.
- Auto
Users []GetPool Start Task User Identity Auto User - A
auto_user
block that describes the user identity under which the start task runs. - User
Name string - The user to use for authentication against the CIFS file system.
- auto
Users List<GetPool Start Task User Identity Auto User> - A
auto_user
block that describes the user identity under which the start task runs. - user
Name String - The user to use for authentication against the CIFS file system.
- auto
Users GetPool Start Task User Identity Auto User[] - A
auto_user
block that describes the user identity under which the start task runs. - user
Name string - The user to use for authentication against the CIFS file system.
- auto_
users Sequence[GetPool Start Task User Identity Auto User] - A
auto_user
block that describes the user identity under which the start task runs. - user_
name str - The user to use for authentication against the CIFS file system.
- auto
Users List<Property Map> - A
auto_user
block that describes the user identity under which the start task runs. - user
Name String - The user to use for authentication against the CIFS file system.
GetPoolStartTaskUserIdentityAutoUser
- Elevation
Level string - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- Scope string
- The scope of the user identity under which the start task runs.
- Elevation
Level string - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- Scope string
- The scope of the user identity under which the start task runs.
- elevation
Level String - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- scope String
- The scope of the user identity under which the start task runs.
- elevation
Level string - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- scope string
- The scope of the user identity under which the start task runs.
- elevation_
level str - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- scope str
- The scope of the user identity under which the start task runs.
- elevation
Level String - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- scope String
- The scope of the user identity under which the start task runs.
GetPoolStorageImageReference
GetPoolTaskSchedulingPolicy
- Node
Fill stringType - Supported values are
Pack
andSpread
.Pack
means as many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.Spread
means that tasks should be assigned evenly across all nodes in the pool.
- Node
Fill stringType - Supported values are
Pack
andSpread
.Pack
means as many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.Spread
means that tasks should be assigned evenly across all nodes in the pool.
- node
Fill StringType - Supported values are
Pack
andSpread
.Pack
means as many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.Spread
means that tasks should be assigned evenly across all nodes in the pool.
- node
Fill stringType - Supported values are
Pack
andSpread
.Pack
means as many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.Spread
means that tasks should be assigned evenly across all nodes in the pool.
- node_
fill_ strtype - Supported values are
Pack
andSpread
.Pack
means as many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.Spread
means that tasks should be assigned evenly across all nodes in the pool.
- node
Fill StringType - Supported values are
Pack
andSpread
.Pack
means as many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.Spread
means that tasks should be assigned evenly across all nodes in the pool.
GetPoolUserAccount
- Elevation
Level string - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- Linux
User List<GetConfigurations Pool User Account Linux User Configuration> - The
linux_user_configuration
block defined below is a linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - Name string
- The name of the user account.
- Password string
- The password for the user account.
- Windows
User List<GetConfigurations Pool User Account Windows User Configuration> - The
windows_user_configuration
block defined below is a windows-specific user configuration for the user account. This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
- Elevation
Level string - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- Linux
User []GetConfigurations Pool User Account Linux User Configuration - The
linux_user_configuration
block defined below is a linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - Name string
- The name of the user account.
- Password string
- The password for the user account.
- Windows
User []GetConfigurations Pool User Account Windows User Configuration - The
windows_user_configuration
block defined below is a windows-specific user configuration for the user account. This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
- elevation
Level String - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- linux
User List<GetConfigurations Pool User Account Linux User Configuration> - The
linux_user_configuration
block defined below is a linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - name String
- The name of the user account.
- password String
- The password for the user account.
- windows
User List<GetConfigurations Pool User Account Windows User Configuration> - The
windows_user_configuration
block defined below is a windows-specific user configuration for the user account. This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
- elevation
Level string - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- linux
User GetConfigurations Pool User Account Linux User Configuration[] - The
linux_user_configuration
block defined below is a linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - name string
- The name of the user account.
- password string
- The password for the user account.
- windows
User GetConfigurations Pool User Account Windows User Configuration[] - The
windows_user_configuration
block defined below is a windows-specific user configuration for the user account. This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
- elevation_
level str - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- linux_
user_ Sequence[Getconfigurations Pool User Account Linux User Configuration] - The
linux_user_configuration
block defined below is a linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - name str
- The name of the user account.
- password str
- The password for the user account.
- windows_
user_ Sequence[Getconfigurations Pool User Account Windows User Configuration] - The
windows_user_configuration
block defined below is a windows-specific user configuration for the user account. This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
- elevation
Level String - The elevation level of the user account. "NonAdmin" - The auto user is a standard user without elevated access. "Admin" - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- linux
User List<Property Map>Configurations - The
linux_user_configuration
block defined below is a linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - name String
- The name of the user account.
- password String
- The password for the user account.
- windows
User List<Property Map>Configurations - The
windows_user_configuration
block defined below is a windows-specific user configuration for the user account. This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
GetPoolUserAccountLinuxUserConfiguration
- Gid int
- The user ID of the user account.
- Ssh
Private stringKey - The SSH private key for the user account.
- Uid int
- The group ID for the user account.
- Gid int
- The user ID of the user account.
- Ssh
Private stringKey - The SSH private key for the user account.
- Uid int
- The group ID for the user account.
- gid Integer
- The user ID of the user account.
- ssh
Private StringKey - The SSH private key for the user account.
- uid Integer
- The group ID for the user account.
- gid number
- The user ID of the user account.
- ssh
Private stringKey - The SSH private key for the user account.
- uid number
- The group ID for the user account.
- gid int
- The user ID of the user account.
- ssh_
private_ strkey - The SSH private key for the user account.
- uid int
- The group ID for the user account.
- gid Number
- The user ID of the user account.
- ssh
Private StringKey - The SSH private key for the user account.
- uid Number
- The group ID for the user account.
GetPoolUserAccountWindowsUserConfiguration
- Login
Mode string - Specifies login mode for the user.
- Login
Mode string - Specifies login mode for the user.
- login
Mode String - Specifies login mode for the user.
- login
Mode string - Specifies login mode for the user.
- login_
mode str - Specifies login mode for the user.
- login
Mode String - Specifies login mode for the user.
GetPoolWindow
- Enable
Automatic boolUpdates - Whether automatic updates are enabled on the virtual machine.
- Enable
Automatic boolUpdates - Whether automatic updates are enabled on the virtual machine.
- enable
Automatic BooleanUpdates - Whether automatic updates are enabled on the virtual machine.
- enable
Automatic booleanUpdates - Whether automatic updates are enabled on the virtual machine.
- enable_
automatic_ boolupdates - Whether automatic updates are enabled on the virtual machine.
- enable
Automatic BooleanUpdates - Whether automatic updates are enabled on the virtual machine.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.