Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.6.0 published on Friday, May 20, 2022 by Pulumi

getPool

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Batch.GetPool.InvokeAsync(new Azure.Batch.GetPoolArgs
        {
            AccountName = "testbatchaccount",
            Name = "testbatchpool",
            ResourceGroupName = "test",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/batch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := batch.LookupPool(ctx, &batch.LookupPoolArgs{
			AccountName:       "testbatchaccount",
			Name:              "testbatchpool",
			ResourceGroupName: "test",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(BatchFunctions.getPool(GetPoolArgs.builder()
            .accountName("testbatchaccount")
            .name("testbatchpool")
            .resourceGroupName("test")
            .build()));

        }
}
import pulumi
import pulumi_azure as azure

example = azure.batch.get_pool(account_name="testbatchaccount",
    name="testbatchpool",
    resource_group_name="test")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.batch.getPool({
    accountName: "testbatchaccount",
    name: "testbatchpool",
    resourceGroupName: "test",
}));
variables:
  example:
    Fn::Invoke:
      Function: azure:batch:getPool
      Arguments:
        accountName: testbatchaccount
        name: testbatchpool
        resourceGroupName: test

Using getPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
def get_pool(account_name: Optional[str] = None,
             name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(account_name: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput

> Note: This function is named LookupPool in the Go SDK.

public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure:batch/getPool:getPool
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AccountName string

The name of the Batch account.

Name string

The name of the endpoint.

ResourceGroupName string
AccountName string

The name of the Batch account.

Name string

The name of the endpoint.

ResourceGroupName string
accountName String

The name of the Batch account.

name String

The name of the endpoint.

resourceGroupName String
accountName string

The name of the Batch account.

name string

The name of the endpoint.

resourceGroupName string
account_name str

The name of the Batch account.

name str

The name of the endpoint.

resource_group_name str
accountName String

The name of the Batch account.

name String

The name of the endpoint.

resourceGroupName String

getPool Result

The following output properties are available:

AccountName string

The name of the Batch account.

AutoScales List<GetPoolAutoScale>

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

Certificates List<GetPoolCertificate>

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

ContainerConfigurations List<GetPoolContainerConfiguration>

The container configuration used in the pool's VMs.

DisplayName string
FixedScales List<GetPoolFixedScale>

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

Id string

The provider-assigned unique ID for this managed resource.

MaxTasksPerNode int

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

Metadata Dictionary<string, string>
Name string

The name of the endpoint.

NetworkConfigurations List<GetPoolNetworkConfiguration>
NodeAgentSkuId string

The SKU of the node agents in the Batch pool.

ResourceGroupName string
StartTasks List<GetPoolStartTask>

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

StorageImageReferences List<GetPoolStorageImageReference>

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

VmSize string

The size of the VM created in the Batch pool.

AccountName string

The name of the Batch account.

AutoScales []GetPoolAutoScale

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

Certificates []GetPoolCertificate

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

ContainerConfigurations []GetPoolContainerConfiguration

The container configuration used in the pool's VMs.

DisplayName string
FixedScales []GetPoolFixedScale

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

Id string

The provider-assigned unique ID for this managed resource.

MaxTasksPerNode int

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

Metadata map[string]string
Name string

The name of the endpoint.

NetworkConfigurations []GetPoolNetworkConfiguration
NodeAgentSkuId string

The SKU of the node agents in the Batch pool.

ResourceGroupName string
StartTasks []GetPoolStartTask

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

StorageImageReferences []GetPoolStorageImageReference

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

VmSize string

The size of the VM created in the Batch pool.

accountName String

The name of the Batch account.

autoScales ListPoolAutoScale>

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

certificates ListPoolCertificate>

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

containerConfigurations ListPoolContainerConfiguration>

The container configuration used in the pool's VMs.

displayName String
fixedScales ListPoolFixedScale>

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

id String

The provider-assigned unique ID for this managed resource.

maxTasksPerNode Integer

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

metadata Map
name String

The name of the endpoint.

networkConfigurations ListPoolNetworkConfiguration>
nodeAgentSkuId String

The SKU of the node agents in the Batch pool.

resourceGroupName String
startTasks ListPoolStartTask>

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

storageImageReferences ListPoolStorageImageReference>

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

vmSize String

The size of the VM created in the Batch pool.

accountName string

The name of the Batch account.

autoScales GetPoolAutoScale[]

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

certificates GetPoolCertificate[]

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

containerConfigurations GetPoolContainerConfiguration[]

The container configuration used in the pool's VMs.

displayName string
fixedScales GetPoolFixedScale[]

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

id string

The provider-assigned unique ID for this managed resource.

maxTasksPerNode number

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

metadata {[key: string]: string}
name string

The name of the endpoint.

networkConfigurations GetPoolNetworkConfiguration[]
nodeAgentSkuId string

The SKU of the node agents in the Batch pool.

resourceGroupName string
startTasks GetPoolStartTask[]

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

storageImageReferences GetPoolStorageImageReference[]

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

vmSize string

The size of the VM created in the Batch pool.

account_name str

The name of the Batch account.

auto_scales Sequence[GetPoolAutoScale]

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

certificates Sequence[GetPoolCertificate]

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

container_configurations Sequence[GetPoolContainerConfiguration]

The container configuration used in the pool's VMs.

display_name str
fixed_scales Sequence[GetPoolFixedScale]

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

id str

The provider-assigned unique ID for this managed resource.

max_tasks_per_node int

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

metadata Mapping[str, str]
name str

The name of the endpoint.

network_configurations Sequence[GetPoolNetworkConfiguration]
node_agent_sku_id str

The SKU of the node agents in the Batch pool.

resource_group_name str
start_tasks Sequence[GetPoolStartTask]

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

storage_image_references Sequence[GetPoolStorageImageReference]

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

vm_size str

The size of the VM created in the Batch pool.

accountName String

The name of the Batch account.

autoScales List

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

certificates List

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

containerConfigurations List

The container configuration used in the pool's VMs.

displayName String
fixedScales List

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

id String

The provider-assigned unique ID for this managed resource.

maxTasksPerNode Number

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

metadata Map
name String

The name of the endpoint.

networkConfigurations List
nodeAgentSkuId String

The SKU of the node agents in the Batch pool.

resourceGroupName String
startTasks List

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

storageImageReferences List

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

vmSize String

The size of the VM created in the Batch pool.

Supporting Types

GetPoolAutoScale

EvaluationInterval string

The interval to wait before evaluating if the pool needs to be scaled.

Formula string

The autoscale formula that needs to be used for scaling the Batch pool.

EvaluationInterval string

The interval to wait before evaluating if the pool needs to be scaled.

Formula string

The autoscale formula that needs to be used for scaling the Batch pool.

evaluationInterval String

The interval to wait before evaluating if the pool needs to be scaled.

formula String

The autoscale formula that needs to be used for scaling the Batch pool.

evaluationInterval string

The interval to wait before evaluating if the pool needs to be scaled.

formula string

The autoscale formula that needs to be used for scaling the Batch pool.

evaluation_interval str

The interval to wait before evaluating if the pool needs to be scaled.

formula str

The autoscale formula that needs to be used for scaling the Batch pool.

evaluationInterval String

The interval to wait before evaluating if the pool needs to be scaled.

formula String

The autoscale formula that needs to be used for scaling the Batch pool.

GetPoolCertificate

Id string

The fully qualified ID of the certificate installed on the pool.

StoreLocation string

The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

StoreName string

The name of the certificate store on the compute node into which the certificate is installed.

Visibilities List<string>

Which user accounts on the compute node have access to the private data of the certificate.

Id string

The fully qualified ID of the certificate installed on the pool.

StoreLocation string

The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

StoreName string

The name of the certificate store on the compute node into which the certificate is installed.

Visibilities []string

Which user accounts on the compute node have access to the private data of the certificate.

id String

The fully qualified ID of the certificate installed on the pool.

storeLocation String

The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

storeName String

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.

id string

The fully qualified ID of the certificate installed on the pool.

storeLocation string

The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

storeName string

The name of the certificate store on the compute node into which the certificate is installed.

visibilities string[]

Which user accounts on the compute node have access to the private data of the certificate.

id str

The fully qualified ID of the certificate installed on the pool.

store_location str

The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

store_name str

The name of the certificate store on the compute node into which the certificate is installed.

visibilities Sequence[str]

Which user accounts on the compute node have access to the private data of the certificate.

id String

The fully qualified ID of the certificate installed on the pool.

storeLocation String

The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

storeName String

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.

GetPoolContainerConfiguration

ContainerImageNames List<string>

A list of container image names to use, as would be specified by docker pull.

ContainerRegistries List<GetPoolContainerConfigurationContainerRegistry>

Additional container registries from which container images can be pulled by the pool's VMs.

Type string

The type of container configuration.

ContainerImageNames []string

A list of container image names to use, as would be specified by docker pull.

ContainerRegistries []GetPoolContainerConfigurationContainerRegistry

Additional container registries from which container images can be pulled by the pool's VMs.

Type string

The type of container configuration.

containerImageNames List

A list of container image names to use, as would be specified by docker pull.

containerRegistries ListPoolContainerConfigurationContainerRegistry>

Additional container registries from which container images can be pulled by the pool's VMs.

type String

The type of container configuration.

containerImageNames string[]

A list of container image names to use, as would be specified by docker pull.

containerRegistries GetPoolContainerConfigurationContainerRegistry[]

Additional container registries from which container images can be pulled by the pool's VMs.

type string

The type of container configuration.

container_image_names Sequence[str]

A list of container image names to use, as would be specified by docker pull.

container_registries Sequence[GetPoolContainerConfigurationContainerRegistry]

Additional container registries from which container images can be pulled by the pool's VMs.

type str

The type of container configuration.

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.

type String

The type of container configuration.

GetPoolContainerConfigurationContainerRegistry

Password string

The password to log into the registry server.

RegistryServer string

The container registry URL. The default is "docker.io".

UserName string

The user name to log into the registry server.

Password string

The password to log into the registry server.

RegistryServer string

The container registry URL. The default is "docker.io".

UserName string

The user name to log into the registry server.

password String

The password to log into the registry server.

registryServer String

The container registry URL. The default is "docker.io".

userName String

The user name to log into the registry server.

password string

The password to log into the registry server.

registryServer string

The container registry URL. The default is "docker.io".

userName string

The user name to log into the registry server.

password str

The password to log into the registry server.

registry_server str

The container registry URL. The default is "docker.io".

user_name str

The user name to log into the registry server.

password String

The password to log into the registry server.

registryServer String

The container registry URL. The default is "docker.io".

userName String

The user name to log into the registry server.

GetPoolFixedScale

ResizeTimeout string

The timeout for resize operations.

TargetDedicatedNodes int

The number of nodes in the Batch pool.

TargetLowPriorityNodes int

The number of low priority nodes in the Batch pool.

ResizeTimeout string

The timeout for resize operations.

TargetDedicatedNodes int

The number of nodes in the Batch pool.

TargetLowPriorityNodes int

The number of low priority nodes in the Batch pool.

resizeTimeout String

The timeout for resize operations.

targetDedicatedNodes Integer

The number of nodes in the Batch pool.

targetLowPriorityNodes Integer

The number of low priority nodes in the Batch pool.

resizeTimeout string

The timeout for resize operations.

targetDedicatedNodes number

The number of nodes in the Batch pool.

targetLowPriorityNodes number

The number of low priority nodes in the Batch pool.

resize_timeout str

The timeout for resize operations.

target_dedicated_nodes int

The number of nodes in the Batch pool.

target_low_priority_nodes int

The number of low priority nodes in the Batch pool.

resizeTimeout String

The timeout for resize operations.

targetDedicatedNodes Number

The number of nodes in the Batch pool.

targetLowPriorityNodes Number

The number of low priority nodes in the Batch pool.

GetPoolNetworkConfiguration

EndpointConfigurations List<GetPoolNetworkConfigurationEndpointConfiguration>

The inbound NAT pools that are used to address specific ports on the individual compute node externally.

SubnetId string

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

EndpointConfigurations []GetPoolNetworkConfigurationEndpointConfiguration

The inbound NAT pools that are used to address specific ports on the individual compute node externally.

SubnetId string

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

endpointConfigurations ListPoolNetworkConfigurationEndpointConfiguration>

The inbound NAT pools that are used to address specific ports on the individual compute node externally.

subnetId String

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

endpointConfigurations GetPoolNetworkConfigurationEndpointConfiguration[]

The inbound NAT pools that are used to address specific ports on the individual compute node externally.

subnetId string

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

endpoint_configurations Sequence[GetPoolNetworkConfigurationEndpointConfiguration]

The inbound NAT pools that are used to address specific ports on the individual compute node externally.

subnet_id str

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

endpointConfigurations List

The inbound NAT pools that are used to address specific ports on the individual compute node externally.

subnetId String

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

GetPoolNetworkConfigurationEndpointConfiguration

BackendPort int

The port number on the compute node.

FrontendPortRange string

The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.

Name string

The name of the endpoint.

NetworkSecurityGroupRules List<GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule>

The list of network security group rules that are applied to the endpoint.

Protocol string

The protocol of the endpoint.

BackendPort int

The port number on the compute node.

FrontendPortRange string

The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.

Name string

The name of the endpoint.

NetworkSecurityGroupRules []GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

The list of network security group rules that are applied to the endpoint.

Protocol string

The protocol of the endpoint.

backendPort Integer

The port number on the compute node.

frontendPortRange String

The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.

name String

The name of the endpoint.

networkSecurityGroupRules ListPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule>

The list of network security group rules that are applied to the endpoint.

protocol String

The protocol of the endpoint.

backendPort number

The port number on the compute node.

frontendPortRange string

The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.

name string

The name of the endpoint.

networkSecurityGroupRules GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule[]

The list of network security group rules that are applied to the endpoint.

protocol string

The protocol of the endpoint.

backend_port int

The port number on the compute node.

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

network_security_group_rules Sequence[GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule]

The list of network security group rules that are applied to the endpoint.

protocol str

The protocol of the endpoint.

backendPort Number

The port number on the compute node.

frontendPortRange String

The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.

name String

The name of the endpoint.

networkSecurityGroupRules List

The list of network security group rules that are applied to the endpoint.

protocol String

The protocol of the endpoint.

GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

Access string

The action that should be taken for a specified IP address, subnet range or tag.

Priority int

The priority for this rule.

SourceAddressPrefix string

The source address prefix or tag to match for the rule.

Access string

The action that should be taken for a specified IP address, subnet range or tag.

Priority int

The priority for this rule.

SourceAddressPrefix string

The source address prefix or tag to match for the rule.

access String

The action that should be taken for a specified IP address, subnet range or tag.

priority Integer

The priority for this rule.

sourceAddressPrefix String

The source address prefix or tag to match for the rule.

access string

The action that should be taken for a specified IP address, subnet range or tag.

priority number

The priority for this rule.

sourceAddressPrefix string

The source address prefix or tag to match for the rule.

access str

The action that should be taken for a specified IP address, subnet range or tag.

priority int

The priority for this rule.

source_address_prefix str

The source address prefix or tag to match for the rule.

access String

The action that should be taken for a specified IP address, subnet range or tag.

priority Number

The priority for this rule.

sourceAddressPrefix String

The source address prefix or tag to match for the rule.

GetPoolStartTask

CommandLine string

The command line executed by the start task.

ResourceFiles List<GetPoolStartTaskResourceFile>

One or more resource_file blocks that describe the files to be downloaded to a compute node.

TaskRetryMaximum int

The number of retry count

UserIdentities List<GetPoolStartTaskUserIdentity>

A user_identity block that describes the user identity under which the start task runs.

WaitForSuccess bool

A flag that indicates if the Batch pool should wait for the start task to be completed.

CommonEnvironmentProperties Dictionary<string, string>

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

CommandLine string

The command line executed by the start task.

ResourceFiles []GetPoolStartTaskResourceFile

One or more resource_file blocks that describe the files to be downloaded to a compute node.

TaskRetryMaximum int

The number of retry count

UserIdentities []GetPoolStartTaskUserIdentity

A user_identity block that describes the user identity under which the start task runs.

WaitForSuccess bool

A flag that indicates if the Batch pool should wait for the start task to be completed.

CommonEnvironmentProperties map[string]string

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

commandLine String

The command line executed by the start task.

resourceFiles ListPoolStartTaskResourceFile>

One or more resource_file blocks that describe the files to be downloaded to a compute node.

taskRetryMaximum Integer

The number of retry count

userIdentities ListPoolStartTaskUserIdentity>

A user_identity block that describes the user identity under which the start task runs.

waitForSuccess Boolean

A flag that indicates if the Batch pool should wait for the start task to be completed.

commonEnvironmentProperties Map

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

commandLine string

The command line executed by the start task.

resourceFiles GetPoolStartTaskResourceFile[]

One or more resource_file blocks that describe the files to be downloaded to a compute node.

taskRetryMaximum number

The number of retry count

userIdentities GetPoolStartTaskUserIdentity[]

A user_identity block that describes the user identity under which the start task runs.

waitForSuccess boolean

A flag that indicates if the Batch pool should wait for the start task to be completed.

commonEnvironmentProperties {[key: string]: string}

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

command_line str

The command line executed by the start task.

resource_files Sequence[GetPoolStartTaskResourceFile]

One or more resource_file blocks that describe the files to be downloaded to a compute node.

task_retry_maximum int

The number of retry count

user_identities Sequence[GetPoolStartTaskUserIdentity]

A user_identity block that describes the user identity under which the start task runs.

wait_for_success bool

A flag that indicates if the Batch pool should wait for the start task to be completed.

common_environment_properties Mapping[str, str]

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

commandLine String

The command line executed by the start task.

resourceFiles List

One or more resource_file blocks that describe the files to be downloaded to a compute node.

taskRetryMaximum Number

The number of retry count

userIdentities List

A user_identity block that describes the user identity under which the start task runs.

waitForSuccess Boolean

A flag that indicates if the Batch pool should wait for the start task to be completed.

commonEnvironmentProperties Map

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

GetPoolStartTaskResourceFile

AutoStorageContainerName string

The storage container name in the auto storage account.

BlobPrefix string

The blob prefix used when downloading blobs from an Azure Storage container.

FileMode string

The file permission mode attribute represented as a string in octal format (e.g. "0644").

FilePath string

The location on the compute node to which to download the file, relative to the task's working directory. If the http_url property is specified, 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 string

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

StorageContainerUrl string

The URL of the blob container within Azure Blob Storage.

AutoStorageContainerName string

The storage container name in the auto storage account.

BlobPrefix string

The blob prefix used when downloading blobs from an Azure Storage container.

FileMode string

The file permission mode attribute represented as a string in octal format (e.g. "0644").

FilePath string

The location on the compute node to which to download the file, relative to the task's working directory. If the http_url property is specified, 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 string

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

StorageContainerUrl string

The URL of the blob container within Azure Blob Storage.

autoStorageContainerName String

The storage container name in the auto storage account.

blobPrefix String

The blob prefix used when downloading blobs from an Azure Storage container.

fileMode String

The file permission mode attribute represented as a string in octal format (e.g. "0644").

filePath String

The location on the compute node to which to download the file, relative to the task's working directory. If the http_url property is specified, 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 String

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

storageContainerUrl String

The URL of the blob container within Azure Blob Storage.

autoStorageContainerName string

The storage container name in the auto storage account.

blobPrefix string

The blob prefix used when downloading blobs from an Azure Storage container.

fileMode string

The file permission mode attribute represented as a string in octal format (e.g. "0644").

filePath string

The location on the compute node to which to download the file, relative to the task's working directory. If the http_url property is specified, 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 string

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

storageContainerUrl string

The URL of the blob container within Azure Blob Storage.

auto_storage_container_name str

The storage container name in the auto storage account.

blob_prefix str

The blob prefix used when downloading blobs from an Azure Storage container.

file_mode str

The file permission mode attribute represented as a string in octal format (e.g. "0644").

file_path str

The location on the compute node to which to download the file, relative to the task's working directory. If the http_url property is specified, 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.

http_url str

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

storage_container_url str

The URL of the blob container within Azure Blob Storage.

autoStorageContainerName String

The storage container name in the auto storage account.

blobPrefix String

The blob prefix used when downloading blobs from an Azure Storage container.

fileMode String

The file permission mode attribute represented as a string in octal format (e.g. "0644").

filePath String

The location on the compute node to which to download the file, relative to the task's working directory. If the http_url property is specified, 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 String

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

storageContainerUrl String

The URL of the blob container within Azure Blob Storage.

GetPoolStartTaskUserIdentity

AutoUsers List<GetPoolStartTaskUserIdentityAutoUser>

A auto_user block that describes the user identity under which the start task runs.

UserName string

The user name to log into the registry server.

AutoUsers []GetPoolStartTaskUserIdentityAutoUser

A auto_user block that describes the user identity under which the start task runs.

UserName string

The user name to log into the registry server.

autoUsers ListPoolStartTaskUserIdentityAutoUser>

A auto_user block that describes the user identity under which the start task runs.

userName String

The user name to log into the registry server.

autoUsers GetPoolStartTaskUserIdentityAutoUser[]

A auto_user block that describes the user identity under which the start task runs.

userName string

The user name to log into the registry server.

auto_users Sequence[GetPoolStartTaskUserIdentityAutoUser]

A auto_user block that describes the user identity under which the start task runs.

user_name str

The user name to log into the registry server.

autoUsers List

A auto_user block that describes the user identity under which the start task runs.

userName String

The user name to log into the registry server.

GetPoolStartTaskUserIdentityAutoUser

ElevationLevel string

The elevation level of the user identity under which the start task runs.

Scope string

The scope of the user identity under which the start task runs.

ElevationLevel string

The elevation level of the user identity under which the start task runs.

Scope string

The scope of the user identity under which the start task runs.

elevationLevel String

The elevation level of the user identity under which the start task runs.

scope String

The scope of the user identity under which the start task runs.

elevationLevel string

The elevation level of the user identity under which the start task runs.

scope string

The scope of the user identity under which the start task runs.

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

elevationLevel String

The elevation level of the user identity under which the start task runs.

scope String

The scope of the user identity under which the start task runs.

GetPoolStorageImageReference

Id string

The fully qualified ID of the certificate installed on the pool.

Offer string
Publisher string
Sku string
Version string
Id string

The fully qualified ID of the certificate installed on the pool.

Offer string
Publisher string
Sku string
Version string
id String

The fully qualified ID of the certificate installed on the pool.

offer String
publisher String
sku String
version String
id string

The fully qualified ID of the certificate installed on the pool.

offer string
publisher string
sku string
version string
id str

The fully qualified ID of the certificate installed on the pool.

offer str
publisher str
sku str
version str
id String

The fully qualified ID of the certificate installed on the pool.

offer String
publisher String
sku String
version String

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.