batch

class pulumi_azure.batch.Account(resource_name, opts=None, location=None, name=None, pool_allocation_mode=None, resource_group_name=None, storage_account_id=None, tags=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.
  • 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.
account_endpoint = None

The account endpoint used to interact with the Batch service.

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.

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.Certificate(resource_name, opts=None, account_name=None, certificate=None, format=None, password=None, resource_group_name=None, thumbprint=None, thumbprint_algorithm=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’.

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

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, __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.
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.

certificates = None

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

container_configuration = None

The container configuration used in the pool’s VMs.

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.

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.

storage_image_reference = None

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

vm_size = None

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

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.

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.

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