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.

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 Batch account ID.

  • url (pulumi.Input[str])

account_endpoint = None

The account endpoint used to interact with the Batch service.

key_vault_reference = 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 Batch account ID.

  • url (str)

location = None

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

name = None

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

pool_allocation_mode = None

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

primary_access_key = None

The Batch account primary access key.

resource_group_name = 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 = None

The Batch account secondary access key.

storage_account_id = None

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

tags = 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 Batch account ID.

  • url (pulumi.Input[str])

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)

Manage Azure Batch Application instance.

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 = None

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

allow_updates = None

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

default_version = 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 = None

The display name for the application.

name = 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 = 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, 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, id=None)
class pulumi_azure.batch.AwaitableGetCertificateResult(account_name=None, format=None, name=None, public_data=None, resource_group_name=None, thumbprint=None, thumbprint_algorithm=None, id=None)
class pulumi_azure.batch.AwaitableGetPoolResult(account_name=None, auto_scales=None, certificates=None, container_configurations=None, display_name=None, fixed_scales=None, max_tasks_per_node=None, name=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, storage_image_references=None, vm_size=None, id=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 = None

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

certificate = None

The base64-encoded contents of the certificate.

format = None

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

name = None

The generated name of the certificate.

password = None

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

public_data = None

The public key of the certificate.

resource_group_name = None

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

thumbprint = 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, 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, id=None)

A collection of values returned by getAccount.

account_endpoint = None

The account endpoint used to interact with the Batch service.

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.

id = None

id is the provider-assigned unique ID for this managed resource.

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

A collection of values returned by getCertificate.

format = None

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

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.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.batch.GetPoolResult(account_name=None, auto_scales=None, certificates=None, container_configurations=None, display_name=None, fixed_scales=None, max_tasks_per_node=None, name=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, storage_image_references=None, vm_size=None, id=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.

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 Batch pool.

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.

id = None

id is the provider-assigned unique ID for this managed resource.

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, name=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.

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

  • 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])

  • formula (pulumi.Input[str])

The certificates object supports the following:

  • id (pulumi.Input[str]) - The Batch pool ID.

  • storeLocation (pulumi.Input[str])

  • storeName (pulumi.Input[str])

  • visibilities (pulumi.Input[list])

The container_configuration object supports the following:

  • containerRegistries (pulumi.Input[list])

    • password (pulumi.Input[str])

    • registryServer (pulumi.Input[str])

    • userName (pulumi.Input[str])

  • type (pulumi.Input[str])

The fixed_scale object supports the following:

  • resizeTimeout (pulumi.Input[str])

  • targetDedicatedNodes (pulumi.Input[float])

  • targetLowPriorityNodes (pulumi.Input[float])

The start_task object supports the following:

  • commandLine (pulumi.Input[str])

  • environment (pulumi.Input[dict])

  • maxTaskRetryCount (pulumi.Input[float])

  • resourceFiles (pulumi.Input[list])

    • autoStorageContainerName (pulumi.Input[str])

    • blobPrefix (pulumi.Input[str])

    • fileMode (pulumi.Input[str])

    • filePath (pulumi.Input[str])

    • httpUrl (pulumi.Input[str])

    • storageContainerUrl (pulumi.Input[str])

  • userIdentity (pulumi.Input[dict])

    • autoUser (pulumi.Input[dict])

      • elevationLevel (pulumi.Input[str])

      • scope (pulumi.Input[str])

    • userName (pulumi.Input[str])

  • waitForSuccess (pulumi.Input[bool])

The storage_image_reference object supports the following:

  • id (pulumi.Input[str]) - The Batch pool ID.

  • offer (pulumi.Input[str])

  • publisher (pulumi.Input[str])

  • sku (pulumi.Input[str])

  • version (pulumi.Input[str])

account_name = 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 = None

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

  • evaluationInterval (str)

  • formula (str)

certificates = None

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

  • id (str) - The Batch pool ID.

  • storeLocation (str)

  • storeName (str)

  • visibilities (list)

container_configuration = None

The container configuration used in the pool’s VMs.

  • containerRegistries (list)

    • password (str)

    • registryServer (str)

    • userName (str)

  • type (str)

display_name = None

Specifies the display name of the Batch pool.

fixed_scale = None

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

  • resizeTimeout (str)

  • targetDedicatedNodes (float)

  • targetLowPriorityNodes (float)

max_tasks_per_node = 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.

name = None

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

node_agent_sku_id = None

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

resource_group_name = 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 = None

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

  • commandLine (str)

  • environment (dict)

  • maxTaskRetryCount (float)

  • resourceFiles (list)

    • autoStorageContainerName (str)

    • blobPrefix (str)

    • fileMode (str)

    • filePath (str)

    • httpUrl (str)

    • storageContainerUrl (str)

  • userIdentity (dict)

    • autoUser (dict)

      • elevationLevel (str)

      • scope (str)

    • userName (str)

  • waitForSuccess (bool)

storage_image_reference = None

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

  • id (str) - The Batch pool ID.

  • offer (str)

  • publisher (str)

  • sku (str)

  • version (str)

vm_size = 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, name=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.

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

  • 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])

  • formula (pulumi.Input[str])

The certificates object supports the following:

  • id (pulumi.Input[str]) - The Batch pool ID.

  • storeLocation (pulumi.Input[str])

  • storeName (pulumi.Input[str])

  • visibilities (pulumi.Input[list])

The container_configuration object supports the following:

  • containerRegistries (pulumi.Input[list])

    • password (pulumi.Input[str])

    • registryServer (pulumi.Input[str])

    • userName (pulumi.Input[str])

  • type (pulumi.Input[str])

The fixed_scale object supports the following:

  • resizeTimeout (pulumi.Input[str])

  • targetDedicatedNodes (pulumi.Input[float])

  • targetLowPriorityNodes (pulumi.Input[float])

The start_task object supports the following:

  • commandLine (pulumi.Input[str])

  • environment (pulumi.Input[dict])

  • maxTaskRetryCount (pulumi.Input[float])

  • resourceFiles (pulumi.Input[list])

    • autoStorageContainerName (pulumi.Input[str])

    • blobPrefix (pulumi.Input[str])

    • fileMode (pulumi.Input[str])

    • filePath (pulumi.Input[str])

    • httpUrl (pulumi.Input[str])

    • storageContainerUrl (pulumi.Input[str])

  • userIdentity (pulumi.Input[dict])

    • autoUser (pulumi.Input[dict])

      • elevationLevel (pulumi.Input[str])

      • scope (pulumi.Input[str])

    • userName (pulumi.Input[str])

  • waitForSuccess (pulumi.Input[bool])

The storage_image_reference object supports the following:

  • id (pulumi.Input[str]) - The Batch pool ID.

  • offer (pulumi.Input[str])

  • publisher (pulumi.Input[str])

  • sku (pulumi.Input[str])

  • version (pulumi.Input[str])

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.

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.

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, resource_group_name=None, start_task=None, opts=None)

Use this data source to access information about an existing 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 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) - (Optional) 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").

    • filePath (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.