batch¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.batch.Account(resource_name, opts=None, key_vault_reference=None, location=None, name=None, pool_allocation_mode=None, resource_group_name=None, storage_account_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Batch account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="westeurope")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_batch_account_account = azure.batch.Account("exampleBatch/accountAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    pool_allocation_mode="BatchService",
    storage_account_id=example_account.id,
    tags={
        "env": "test",
    })

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• key_vault_reference (pulumi.Input[dict]) – A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

• location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

• name (pulumi.Input[str]) – Specifies the name of the Batch account. Changing this forces a new resource to be created.

• pool_allocation_mode (pulumi.Input[str]) – Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.

• resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

• storage_account_id (pulumi.Input[str]) – Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The key_vault_reference object supports the following:

• id (pulumi.Input[str]) - The Azure identifier of the Azure KeyVault to use.

• url (pulumi.Input[str]) - The HTTPS URL of the Azure KeyVault to use.

account_endpoint: pulumi.Output[str] = None¶

The account endpoint used to interact with the Batch service.

key_vault_reference: pulumi.Output[dict] = None¶

A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

• id (str) - The Azure identifier of the Azure KeyVault to use.

• url (str) - The HTTPS URL of the Azure KeyVault to use.

location: pulumi.Output[str] = None¶

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶

Specifies the name of the Batch account. Changing this forces a new resource to be created.

pool_allocation_mode: pulumi.Output[str] = None¶

Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.

primary_access_key: pulumi.Output[str] = None¶

The Batch account primary access key.

resource_group_name: pulumi.Output[str] = None¶

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

secondary_access_key: pulumi.Output[str] = None¶

The Batch account secondary access key.

storage_account_id: pulumi.Output[str] = None¶

Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.

tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, account_endpoint=None, key_vault_reference=None, location=None, name=None, pool_allocation_mode=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, storage_account_id=None, tags=None)¶

Get an existing Account resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_endpoint (pulumi.Input[str]) – The account endpoint used to interact with the Batch service.

• key_vault_reference (pulumi.Input[dict]) – A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

• location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

• name (pulumi.Input[str]) – Specifies the name of the Batch account. Changing this forces a new resource to be created.

• pool_allocation_mode (pulumi.Input[str]) – Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.

• primary_access_key (pulumi.Input[str]) – The Batch account primary access key.

• resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

• secondary_access_key (pulumi.Input[str]) – The Batch account secondary access key.

• storage_account_id (pulumi.Input[str]) – Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The key_vault_reference object supports the following:

• id (pulumi.Input[str]) - The Azure identifier of the Azure KeyVault to use.

• url (pulumi.Input[str]) - The HTTPS URL of the Azure KeyVault to use.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.batch.Application(resource_name, opts=None, account_name=None, allow_updates=None, default_version=None, display_name=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages Azure Batch Application instance.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_batch_account_account = azure.batch.Account("exampleBatch/accountAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    pool_allocation_mode="BatchService",
    storage_account_id=example_account.id)
example_application = azure.batch.Application("exampleApplication",
    resource_group_name=example_resource_group.name,
    account_name=example_batch / account_account["name"])

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_name (pulumi.Input[str]) – The name of the Batch account. Changing this forces a new resource to be created.

• allow_updates (pulumi.Input[bool]) – A value indicating whether packages within the application may be overwritten using the same version string. Defaults to true.

• default_version (pulumi.Input[str]) – The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.

• display_name (pulumi.Input[str]) – The display name for the application.

• name (pulumi.Input[str]) – The name of the application. This must be unique within the account. Changing this forces a new resource to be created.

• resource_group_name (pulumi.Input[str]) – The name of the resource group that contains the Batch account. Changing this forces a new resource to be created.

account_name: pulumi.Output[str] = None¶

The name of the Batch account. Changing this forces a new resource to be created.

allow_updates: pulumi.Output[bool] = None¶

A value indicating whether packages within the application may be overwritten using the same version string. Defaults to true.

default_version: pulumi.Output[str] = None¶

The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.

display_name: pulumi.Output[str] = None¶

The display name for the application.

name: pulumi.Output[str] = None¶

The name of the application. This must be unique within the account. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶

The name of the resource group that contains the Batch account. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, account_name=None, allow_updates=None, default_version=None, display_name=None, name=None, resource_group_name=None)¶

Get an existing Application resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_name (pulumi.Input[str]) – The name of the Batch account. Changing this forces a new resource to be created.

• allow_updates (pulumi.Input[bool]) – A value indicating whether packages within the application may be overwritten using the same version string. Defaults to true.

• default_version (pulumi.Input[str]) – The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.

• display_name (pulumi.Input[str]) – The display name for the application.

• name (pulumi.Input[str]) – The name of the application. This must be unique within the account. Changing this forces a new resource to be created.

• resource_group_name (pulumi.Input[str]) – The name of the resource group that contains the Batch account. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.batch.AwaitableGetAccountResult(account_endpoint=None, id=None, key_vault_references=None, location=None, name=None, pool_allocation_mode=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, storage_account_id=None, tags=None)¶

class pulumi_azure.batch.AwaitableGetCertificateResult(account_name=None, format=None, id=None, name=None, public_data=None, resource_group_name=None, thumbprint=None, thumbprint_algorithm=None)¶

class pulumi_azure.batch.AwaitableGetPoolResult(account_name=None, auto_scales=None, certificates=None, container_configurations=None, display_name=None, fixed_scales=None, id=None, max_tasks_per_node=None, metadata=None, name=None, network_configuration=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, storage_image_references=None, vm_size=None)¶

class pulumi_azure.batch.Certificate(resource_name, opts=None, account_name=None, certificate=None, format=None, password=None, resource_group_name=None, thumbprint=None, thumbprint_algorithm=None, __props__=None, __name__=None, __opts__=None)¶

Manages a certificate in an Azure Batch account.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_name (pulumi.Input[str]) – Specifies the name of the Batch account. Changing this forces a new resource to be created.

• certificate (pulumi.Input[str]) – The base64-encoded contents of the certificate.

• format (pulumi.Input[str]) – The format of the certificate. Possible values are Cer or Pfx.

• password (pulumi.Input[str]) – The password to access the certificate’s private key. This must and can only be specified when format is Pfx.

• resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

• thumbprint (pulumi.Input[str]) – The thumbprint of the certificate. At this time the only supported value is ‘SHA1’.

account_name: pulumi.Output[str] = None¶

Specifies the name of the Batch account. Changing this forces a new resource to be created.

certificate: pulumi.Output[str] = None¶

The base64-encoded contents of the certificate.

format: pulumi.Output[str] = None¶

The format of the certificate. Possible values are Cer or Pfx.

name: pulumi.Output[str] = None¶

The generated name of the certificate.

password: pulumi.Output[str] = None¶

The password to access the certificate’s private key. This must and can only be specified when format is Pfx.

public_data: pulumi.Output[str] = None¶

The public key of the certificate.

resource_group_name: pulumi.Output[str] = None¶

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

thumbprint: pulumi.Output[str] = None¶

The thumbprint of the certificate. At this time the only supported value is ‘SHA1’.

static get(resource_name, id, opts=None, account_name=None, certificate=None, format=None, name=None, password=None, public_data=None, resource_group_name=None, thumbprint=None, thumbprint_algorithm=None)¶

Get an existing Certificate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_name (pulumi.Input[str]) – Specifies the name of the Batch account. Changing this forces a new resource to be created.

• certificate (pulumi.Input[str]) – The base64-encoded contents of the certificate.

• format (pulumi.Input[str]) – The format of the certificate. Possible values are Cer or Pfx.

• name (pulumi.Input[str]) – The generated name of the certificate.

• password (pulumi.Input[str]) – The password to access the certificate’s private key. This must and can only be specified when format is Pfx.

• public_data (pulumi.Input[str]) – The public key of the certificate.

• resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

• thumbprint (pulumi.Input[str]) – The thumbprint of the certificate. At this time the only supported value is ‘SHA1’.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.batch.GetAccountResult(account_endpoint=None, id=None, key_vault_references=None, location=None, name=None, pool_allocation_mode=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, storage_account_id=None, tags=None)¶

A collection of values returned by getAccount.

account_endpoint = None¶

The account endpoint used to interact with the Batch service.

id = None¶

The provider-assigned unique ID for this managed resource.

key_vault_references = None¶

The key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

location = None¶

The Azure Region in which this Batch account exists.

name = None¶

The Batch account name.

pool_allocation_mode = None¶

The pool allocation mode configured for this Batch account.

primary_access_key = None¶

The Batch account primary access key.

secondary_access_key = None¶

The Batch account secondary access key.

storage_account_id = None¶

The ID of the Storage Account used for this Batch account.

tags = None¶

A map of tags assigned to the Batch account.

class pulumi_azure.batch.GetCertificateResult(account_name=None, format=None, id=None, name=None, public_data=None, resource_group_name=None, thumbprint=None, thumbprint_algorithm=None)¶

A collection of values returned by getCertificate.

format = None¶

The format of the certificate, such as Cer or Pfx.

id = None¶

The provider-assigned unique ID for this managed resource.

public_data = None¶

The public key of the certificate.

thumbprint = None¶

The thumbprint of the certificate.

thumbprint_algorithm = None¶

The algorithm of the certificate thumbprint.

class pulumi_azure.batch.GetPoolResult(account_name=None, auto_scales=None, certificates=None, container_configurations=None, display_name=None, fixed_scales=None, id=None, max_tasks_per_node=None, metadata=None, name=None, network_configuration=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, storage_image_references=None, vm_size=None)¶

A collection of values returned by getPool.

account_name = None¶

The name of the Batch account.

auto_scales = None¶

A auto_scale block that describes the scale settings when using auto scale.

certificates = None¶

One or more certificate blocks that describe the certificates installed on each compute node in the pool.

container_configurations = None¶

The container configuration used in the pool’s VMs.

fixed_scales = None¶

A fixed_scale block that describes the scale settings when using fixed scale.

id = None¶

The provider-assigned unique ID for this managed resource.

max_tasks_per_node = None¶

The maximum number of tasks that can run concurrently on a single compute node in the pool.

name = None¶

The name of the endpoint.

node_agent_sku_id = None¶

The Sku of the node agents in the Batch pool.

start_task = None¶

A start_task block that describes the start task settings for the Batch pool.

storage_image_references = None¶

The reference of the storage image used by the nodes in the Batch pool.

vm_size = None¶

The size of the VM created in the Batch pool.

class pulumi_azure.batch.Pool(resource_name, opts=None, account_name=None, auto_scale=None, certificates=None, container_configuration=None, display_name=None, fixed_scale=None, max_tasks_per_node=None, metadata=None, name=None, network_configuration=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, stop_pending_resize_operation=None, storage_image_reference=None, vm_size=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Batch pool.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_name (pulumi.Input[str]) – Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.

• auto_scale (pulumi.Input[dict]) – A auto_scale block that describes the scale settings when using auto scale.

• certificates (pulumi.Input[list]) – One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.

• container_configuration (pulumi.Input[dict]) – The container configuration used in the pool’s VMs.

• display_name (pulumi.Input[str]) – Specifies the display name of the Batch pool.

• fixed_scale (pulumi.Input[dict]) – A fixed_scale block that describes the scale settings when using fixed scale.

• max_tasks_per_node (pulumi.Input[float]) – Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.

• metadata (pulumi.Input[dict]) – A map of custom batch pool metadata.

• name (pulumi.Input[str]) – Specifies the name of the Batch pool. Changing this forces a new resource to be created.

• network_configuration (pulumi.Input[dict]) – A network_configuration block that describes the network configurations for the Batch pool.

• node_agent_sku_id (pulumi.Input[str]) – Specifies the Sku of the node agents that will be created in the Batch pool.

• resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.

• start_task (pulumi.Input[dict]) – A start_task block that describes the start task settings for the Batch pool.

• storage_image_reference (pulumi.Input[dict]) – A storage_image_reference for the virtual machines that will compose the Batch pool.

• vm_size (pulumi.Input[str]) – Specifies the size of the VM created in the Batch pool.

The auto_scale object supports the following:

• evaluationInterval (pulumi.Input[str]) - The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

• formula (pulumi.Input[str]) - The autoscale formula that needs to be used for scaling the Batch pool.

The certificates object supports the following:

• id (pulumi.Input[str]) - The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.

• storeLocation (pulumi.Input[str]) - The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.

• storeName (pulumi.Input[str]) - The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

• visibilities (pulumi.Input[list]) - Which user accounts on the compute node should have access to the private data of the certificate.

The container_configuration object supports the following:

• containerImageNames (pulumi.Input[list]) - A list of container image names to use, as would be specified by docker pull.

• containerRegistries (pulumi.Input[list]) - Additional container registries from which container images can be pulled by the pool’s VMs.

  • password (pulumi.Input[str]) - The password to log into the registry server. Changing this forces a new resource to be created.

  • registryServer (pulumi.Input[str]) - The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.

  • userName (pulumi.Input[str]) - The user name to log into the registry server. Changing this forces a new resource to be created.

• type (pulumi.Input[str]) - The type of container configuration. Possible value is DockerCompatible.

The fixed_scale object supports the following:

• resizeTimeout (pulumi.Input[str]) - The timeout for resize operations. Defaults to PT15M.

• targetDedicatedNodes (pulumi.Input[float]) - The number of nodes in the Batch pool. Defaults to 1.

• targetLowPriorityNodes (pulumi.Input[float]) - The number of low priority nodes in the Batch pool. Defaults to 0.

The network_configuration object supports the following:

• endpointConfigurations (pulumi.Input[list]) - A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inbound_nat_pools block below. Changing this forces a new resource to be created.

  • backend_port (pulumi.Input[float]) - The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.

  • frontendPortRange (pulumi.Input[str]) - The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) - The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.

  • networkSecurityGroupRules (pulumi.Input[list]) - A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the network_security_group_rules block below. Changing this forces a new resource to be created.

    • access (pulumi.Input[str]) - The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.

    • priority (pulumi.Input[float]) - The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.

    • source_address_prefix (pulumi.Input[str]) - The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

  • protocol (pulumi.Input[str]) - The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.

• publicIps (pulumi.Input[list]) - A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

• subnet_id (pulumi.Input[str]) - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.

The start_task object supports the following:

• commandLine (pulumi.Input[str]) - The command line executed by the start task.

• environment (pulumi.Input[dict]) - A map of strings (key,value) that represents the environment variables to set in the start task.

• maxTaskRetryCount (pulumi.Input[float]) - The number of retry count. Defaults to 1.

• resourceFiles (pulumi.Input[list]) - One or more resource_file blocks that describe the files to be downloaded to a compute node.

  • autoStorageContainerName (pulumi.Input[str]) - The storage container name in the auto storage account.

  • blobPrefix (pulumi.Input[str]) - The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when auto_storage_container_name or storage_container_url is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

  • fileMode (pulumi.Input[str]) - The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resource_file which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

  • file_path (pulumi.Input[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, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified, file_path is optional and is the directory to download the files to. In the case where file_path is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task’s working directory (for example by using ‘..’).

  • httpUrl (pulumi.Input[str]) - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

  • storageContainerUrl (pulumi.Input[str]) - The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

• userIdentity (pulumi.Input[dict]) - A user_identity block that describes the user identity under which the start task runs.

  • autoUser (pulumi.Input[dict]) - A auto_user block that describes the user identity under which the start task runs.

    • elevationLevel (pulumi.Input[str]) - The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.

    • scope (pulumi.Input[str]) - The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

  • userName (pulumi.Input[str]) - The username to be used by the Batch pool start task.

• waitForSuccess (pulumi.Input[bool]) - A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

The storage_image_reference object supports the following:

• id (pulumi.Input[str]) - Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

• offer (pulumi.Input[str]) - Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.

• publisher (pulumi.Input[str]) - Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.

• sku (pulumi.Input[str]) - Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.

• version (pulumi.Input[str]) - Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

account_name: pulumi.Output[str] = None¶

Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.

auto_scale: pulumi.Output[dict] = None¶

A auto_scale block that describes the scale settings when using auto scale.

• evaluationInterval (str) - The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

• formula (str) - The autoscale formula that needs to be used for scaling the Batch pool.

certificates: pulumi.Output[list] = None¶

One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.

• id (str) - The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.

• storeLocation (str) - The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.

• storeName (str) - The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

• visibilities (list) - Which user accounts on the compute node should have access to the private data of the certificate.

container_configuration: pulumi.Output[dict] = None¶

The container configuration used in the pool’s VMs.

• containerImageNames (list) - A list of container image names to use, as would be specified by docker pull.

• containerRegistries (list) - Additional container registries from which container images can be pulled by the pool’s VMs.

  • password (str) - The password to log into the registry server. Changing this forces a new resource to be created.

  • registryServer (str) - The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.

  • userName (str) - The user name to log into the registry server. Changing this forces a new resource to be created.

• type (str) - The type of container configuration. Possible value is DockerCompatible.

display_name: pulumi.Output[str] = None¶

Specifies the display name of the Batch pool.

fixed_scale: pulumi.Output[dict] = None¶

A fixed_scale block that describes the scale settings when using fixed scale.

• resizeTimeout (str) - The timeout for resize operations. Defaults to PT15M.

• targetDedicatedNodes (float) - The number of nodes in the Batch pool. Defaults to 1.

• targetLowPriorityNodes (float) - The number of low priority nodes in the Batch pool. Defaults to 0.

max_tasks_per_node: pulumi.Output[float] = None¶

Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.

metadata: pulumi.Output[dict] = None¶

A map of custom batch pool metadata.

name: pulumi.Output[str] = None¶

Specifies the name of the Batch pool. Changing this forces a new resource to be created.

network_configuration: pulumi.Output[dict] = None¶

A network_configuration block that describes the network configurations for the Batch pool.

• endpointConfigurations (list) - A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inbound_nat_pools block below. Changing this forces a new resource to be created.

  • backend_port (float) - The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.

  • frontendPortRange (str) - The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.

  • name (str) - The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.

  • networkSecurityGroupRules (list) - A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the network_security_group_rules block below. Changing this forces a new resource to be created.

    • access (str) - The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.

    • priority (float) - The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.

    • source_address_prefix (str) - The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

  • protocol (str) - The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.

• publicIps (list) - A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

• subnet_id (str) - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.

node_agent_sku_id: pulumi.Output[str] = None¶

Specifies the Sku of the node agents that will be created in the Batch pool.

resource_group_name: pulumi.Output[str] = None¶

The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.

start_task: pulumi.Output[dict] = None¶

A start_task block that describes the start task settings for the Batch pool.

• commandLine (str) - The command line executed by the start task.

• environment (dict) - A map of strings (key,value) that represents the environment variables to set in the start task.

• maxTaskRetryCount (float) - The number of retry count. Defaults to 1.

• resourceFiles (list) - One or more resource_file blocks that describe the files to be downloaded to a compute node.

  • autoStorageContainerName (str) - The storage container name in the auto storage account.

  • blobPrefix (str) - The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when auto_storage_container_name or storage_container_url is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

  • fileMode (str) - The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resource_file which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

  • 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, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified, file_path is optional and is the directory to download the files to. In the case where file_path is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task’s working directory (for example by using ‘..’).

  • httpUrl (str) - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

  • storageContainerUrl (str) - The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

• userIdentity (dict) - A user_identity block that describes the user identity under which the start task runs.

  • autoUser (dict) - A auto_user block that describes the user identity under which the start task runs.

    • elevationLevel (str) - The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.

    • scope (str) - The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

  • userName (str) - The username to be used by the Batch pool start task.

• waitForSuccess (bool) - A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

storage_image_reference: pulumi.Output[dict] = None¶

A storage_image_reference for the virtual machines that will compose the Batch pool.

• id (str) - Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

• offer (str) - Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.

• publisher (str) - Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.

• sku (str) - Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.

• version (str) - Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

vm_size: pulumi.Output[str] = None¶

Specifies the size of the VM created in the Batch pool.

static get(resource_name, id, opts=None, account_name=None, auto_scale=None, certificates=None, container_configuration=None, display_name=None, fixed_scale=None, max_tasks_per_node=None, metadata=None, name=None, network_configuration=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, stop_pending_resize_operation=None, storage_image_reference=None, vm_size=None)¶

Get an existing Pool resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_name (pulumi.Input[str]) – Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.

• auto_scale (pulumi.Input[dict]) – A auto_scale block that describes the scale settings when using auto scale.

• certificates (pulumi.Input[list]) – One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.

• container_configuration (pulumi.Input[dict]) – The container configuration used in the pool’s VMs.

• display_name (pulumi.Input[str]) – Specifies the display name of the Batch pool.

• fixed_scale (pulumi.Input[dict]) – A fixed_scale block that describes the scale settings when using fixed scale.

• max_tasks_per_node (pulumi.Input[float]) – Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.

• metadata (pulumi.Input[dict]) – A map of custom batch pool metadata.

• name (pulumi.Input[str]) – Specifies the name of the Batch pool. Changing this forces a new resource to be created.

• network_configuration (pulumi.Input[dict]) – A network_configuration block that describes the network configurations for the Batch pool.

• node_agent_sku_id (pulumi.Input[str]) – Specifies the Sku of the node agents that will be created in the Batch pool.

• resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.

• start_task (pulumi.Input[dict]) – A start_task block that describes the start task settings for the Batch pool.

• storage_image_reference (pulumi.Input[dict]) – A storage_image_reference for the virtual machines that will compose the Batch pool.

• vm_size (pulumi.Input[str]) – Specifies the size of the VM created in the Batch pool.

The auto_scale object supports the following:

• evaluationInterval (pulumi.Input[str]) - The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

• formula (pulumi.Input[str]) - The autoscale formula that needs to be used for scaling the Batch pool.

The certificates object supports the following:

• id (pulumi.Input[str]) - The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.

• storeLocation (pulumi.Input[str]) - The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.

• storeName (pulumi.Input[str]) - The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

• visibilities (pulumi.Input[list]) - Which user accounts on the compute node should have access to the private data of the certificate.

The container_configuration object supports the following:

• containerImageNames (pulumi.Input[list]) - A list of container image names to use, as would be specified by docker pull.

• containerRegistries (pulumi.Input[list]) - Additional container registries from which container images can be pulled by the pool’s VMs.

  • password (pulumi.Input[str]) - The password to log into the registry server. Changing this forces a new resource to be created.

  • registryServer (pulumi.Input[str]) - The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.

  • userName (pulumi.Input[str]) - The user name to log into the registry server. Changing this forces a new resource to be created.

• type (pulumi.Input[str]) - The type of container configuration. Possible value is DockerCompatible.

The fixed_scale object supports the following:

• resizeTimeout (pulumi.Input[str]) - The timeout for resize operations. Defaults to PT15M.

• targetDedicatedNodes (pulumi.Input[float]) - The number of nodes in the Batch pool. Defaults to 1.

• targetLowPriorityNodes (pulumi.Input[float]) - The number of low priority nodes in the Batch pool. Defaults to 0.

The network_configuration object supports the following:

• endpointConfigurations (pulumi.Input[list]) - A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inbound_nat_pools block below. Changing this forces a new resource to be created.

  • backend_port (pulumi.Input[float]) - The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.

  • frontendPortRange (pulumi.Input[str]) - The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) - The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.

  • networkSecurityGroupRules (pulumi.Input[list]) - A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the network_security_group_rules block below. Changing this forces a new resource to be created.

    • access (pulumi.Input[str]) - The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.

    • priority (pulumi.Input[float]) - The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.

    • source_address_prefix (pulumi.Input[str]) - The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

  • protocol (pulumi.Input[str]) - The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.

• publicIps (pulumi.Input[list]) - A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

• subnet_id (pulumi.Input[str]) - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.

The start_task object supports the following:

• commandLine (pulumi.Input[str]) - The command line executed by the start task.

• environment (pulumi.Input[dict]) - A map of strings (key,value) that represents the environment variables to set in the start task.

• maxTaskRetryCount (pulumi.Input[float]) - The number of retry count. Defaults to 1.

• resourceFiles (pulumi.Input[list]) - One or more resource_file blocks that describe the files to be downloaded to a compute node.

  • autoStorageContainerName (pulumi.Input[str]) - The storage container name in the auto storage account.

  • blobPrefix (pulumi.Input[str]) - The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when auto_storage_container_name or storage_container_url is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

  • fileMode (pulumi.Input[str]) - The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resource_file which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

  • file_path (pulumi.Input[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, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified, file_path is optional and is the directory to download the files to. In the case where file_path is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task’s working directory (for example by using ‘..’).

  • httpUrl (pulumi.Input[str]) - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

  • storageContainerUrl (pulumi.Input[str]) - The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

• userIdentity (pulumi.Input[dict]) - A user_identity block that describes the user identity under which the start task runs.

  • autoUser (pulumi.Input[dict]) - A auto_user block that describes the user identity under which the start task runs.

    • elevationLevel (pulumi.Input[str]) - The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.

    • scope (pulumi.Input[str]) - The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

  • userName (pulumi.Input[str]) - The username to be used by the Batch pool start task.

• waitForSuccess (pulumi.Input[bool]) - A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

The storage_image_reference object supports the following:

• id (pulumi.Input[str]) - Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

• offer (pulumi.Input[str]) - Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.

• publisher (pulumi.Input[str]) - Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.

• sku (pulumi.Input[str]) - Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.

• version (pulumi.Input[str]) - Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.batch.get_account(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Batch Account.

import pulumi
import pulumi_azure as azure

example = azure.batch.get_account(name="testbatchaccount",
    resource_group_name="test")
pulumi.export("poolAllocationMode", example.pool_allocation_mode)

Parameters

• name (str) – The name of the Batch account.

• resource_group_name (str) – The Name of the Resource Group where this Batch account exists.

pulumi_azure.batch.get_certificate(account_name=None, name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing certificate in a Batch Account.

import pulumi
import pulumi_azure as azure

example = azure.batch.get_certificate(name="SHA1-42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
    account_name="examplebatchaccount",
    resource_group_name="example")
pulumi.export("thumbprint", example.thumbprint)

Parameters

• account_name (str) – The name of the Batch account.

• name (str) – The name of the Batch certificate.

• resource_group_name (str) – The Name of the Resource Group where this Batch account exists.

pulumi_azure.batch.get_pool(account_name=None, certificates=None, name=None, network_configuration=None, resource_group_name=None, start_task=None, opts=None)¶

Use this data source to access information about an existing Batch pool

import pulumi
import pulumi_azure as azure

example = azure.batch.get_pool(account_name="testbatchaccount",
    name="testbatchpool",
    resource_group_name="test")

Parameters

• account_name (str) – The name of the Batch account.

• certificates (list) – One or more certificate blocks that describe the certificates installed on each compute node in the pool.

• name (str) – The name of the endpoint.

• start_task (dict) – A start_task block that describes the start task settings for the Batch pool.

The certificates object supports the following:

• id (str) - The fully qualified ID of the certificate installed on the pool.

• storeLocation (str) - The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

• storeName (str) - The name of the certificate store on the compute node into which the certificate is installed.

• visibilities (list) - Which user accounts on the compute node have access to the private data of the certificate.

The network_configuration object supports the following:

• endpointConfiguration (dict) - The inbound NAT pools that are used to address specific ports on the individual compute node externally.

  • backend_port (float) - The port number on the compute node.

  • frontendPortRange (str) - 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 endpoint.

  • networkSecurityGroupRules (list) - The list of network security group rules that are applied to the endpoint.

    • access (str) - The action that should be taken for a specified IP address, subnet range or tag.

    • priority (float) - The priority for this rule.

    • source_address_prefix (str) - The source address prefix or tag to match for the rule.

  • protocol (str) - The protocol of the endpoint.

• subnet_id (str) - The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

The start_task object supports the following:

• commandLine (str) - The command line executed by the start task.

• environment (dict) - A map of strings (key,value) that represents the environment variables to set in the start task.

• maxTaskRetryCount (float) - The number of retry count.

• resourceFiles (list) - One or more resource_file blocks that describe the files to be downloaded to a compute node.

  • autoStorageContainerName (str) - The storage container name in the auto storage account.

  • blobPrefix (str) - The blob prefix used when downloading blobs from an Azure Storage container.

  • fileMode (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, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified.

  • httpUrl (str) - The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

  • storageContainerUrl (str) - The URL of the blob container within Azure Blob Storage.

• userIdentities (list) - A user_identity block that describes the user identity under which the start task runs.

  • autoUsers (list) - A auto_user block that describes the user identity under which the start task runs.

    • elevationLevel (str) - The elevation level of the user identity under which the start task runs.

    • scope (str) - The scope of the user identity under which the start task runs.

  • userName (str) - The user name to log into the registry server.

• waitForSuccess (bool) - A flag that indicates if the Batch pool should wait for the start task to be completed.