Azure Classic
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:
- Account
Name string The name of the Batch account.
- Name string
The name of the endpoint.
- Resource
Group stringName
- Account
Name string The name of the Batch account.
- Name string
The name of the endpoint.
- Resource
Group stringName
- account
Name String The name of the Batch account.
- name String
The name of the endpoint.
- resource
Group StringName
- account
Name string The name of the Batch account.
- name string
The name of the endpoint.
- resource
Group stringName
- account_
name str The name of the Batch account.
- name str
The name of the endpoint.
- resource_
group_ strname
- account
Name String The name of the Batch account.
- name String
The name of the endpoint.
- resource
Group StringName
getPool Result
The following output properties are available:
- Account
Name string The name of the Batch account.
- Auto
Scales List<GetPool Auto Scale> A
auto_scale
block that describes the scale settings when using auto scale.- Certificates
List<Get
Pool Certificate> One or more
certificate
blocks that describe the certificates installed on each compute node in the pool.- Container
Configurations List<GetPool Container Configuration> The container configuration used in the pool's VMs.
- Display
Name string - Fixed
Scales List<GetPool Fixed Scale> A
fixed_scale
block that describes the scale settings when using fixed scale.- Id string
The provider-assigned unique ID for this managed resource.
- Max
Tasks intPer Node The maximum number of tasks that can run concurrently on a single compute node in the pool.
- Metadata Dictionary<string, string>
- Name string
The name of the endpoint.
- Network
Configurations List<GetPool Network Configuration> - Node
Agent stringSku Id The SKU of the node agents in the Batch pool.
- Resource
Group stringName - Start
Tasks List<GetPool Start Task> A
start_task
block that describes the start task settings for the Batch pool.- Storage
Image List<GetReferences Pool Storage Image Reference> The reference of the storage image used by the nodes in the Batch pool.
- Vm
Size string The size of the VM created in the Batch pool.
- Account
Name string The name of the Batch account.
- Auto
Scales []GetPool Auto Scale A
auto_scale
block that describes the scale settings when using auto scale.- Certificates
[]Get
Pool Certificate One or more
certificate
blocks that describe the certificates installed on each compute node in the pool.- Container
Configurations []GetPool Container Configuration The container configuration used in the pool's VMs.
- Display
Name string - Fixed
Scales []GetPool Fixed Scale A
fixed_scale
block that describes the scale settings when using fixed scale.- Id string
The provider-assigned unique ID for this managed resource.
- Max
Tasks intPer Node The maximum number of tasks that can run concurrently on a single compute node in the pool.
- Metadata map[string]string
- Name string
The name of the endpoint.
- Network
Configurations []GetPool Network Configuration - Node
Agent stringSku Id The SKU of the node agents in the Batch pool.
- Resource
Group stringName - Start
Tasks []GetPool Start Task A
start_task
block that describes the start task settings for the Batch pool.- Storage
Image []GetReferences Pool Storage Image Reference The reference of the storage image used by the nodes in the Batch pool.
- Vm
Size string The size of the VM created in the Batch pool.
- account
Name String The name of the Batch account.
- auto
Scales ListPool Auto Scale> A
auto_scale
block that describes the scale settings when using auto scale.- certificates
List
Pool Certificate> One or more
certificate
blocks that describe the certificates installed on each compute node in the pool.- container
Configurations ListPool Container Configuration> The container configuration used in the pool's VMs.
- display
Name String - fixed
Scales ListPool Fixed Scale> A
fixed_scale
block that describes the scale settings when using fixed scale.- id String
The provider-assigned unique ID for this managed resource.
- max
Tasks IntegerPer Node 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.
- network
Configurations ListPool Network Configuration> - node
Agent StringSku Id The SKU of the node agents in the Batch pool.
- resource
Group StringName - start
Tasks ListPool Start Task> A
start_task
block that describes the start task settings for the Batch pool.- storage
Image ListReferences Pool Storage Image Reference> The reference of the storage image used by the nodes in the Batch pool.
- vm
Size String The size of the VM created in the Batch pool.
- account
Name string The name of the Batch account.
- auto
Scales GetPool Auto Scale[] A
auto_scale
block that describes the scale settings when using auto scale.- certificates
Get
Pool Certificate[] One or more
certificate
blocks that describe the certificates installed on each compute node in the pool.- container
Configurations GetPool Container Configuration[] The container configuration used in the pool's VMs.
- display
Name string - fixed
Scales GetPool Fixed Scale[] A
fixed_scale
block that describes the scale settings when using fixed scale.- id string
The provider-assigned unique ID for this managed resource.
- max
Tasks numberPer Node The maximum number of tasks that can run concurrently on a single compute node in the pool.
- metadata {[key: string]: string}
- name string
The name of the endpoint.
- network
Configurations GetPool Network Configuration[] - node
Agent stringSku Id The SKU of the node agents in the Batch pool.
- resource
Group stringName - start
Tasks GetPool Start Task[] A
start_task
block that describes the start task settings for the Batch pool.- storage
Image GetReferences Pool Storage Image Reference[] The reference of the storage image used by the nodes in the Batch pool.
- vm
Size string The size of the VM created in the Batch pool.
- account_
name str The name of the Batch account.
- auto_
scales Sequence[GetPool Auto Scale] A
auto_scale
block that describes the scale settings when using auto scale.- certificates
Sequence[Get
Pool Certificate] One or more
certificate
blocks that describe the certificates installed on each compute node in the pool.- container_
configurations Sequence[GetPool Container Configuration] The container configuration used in the pool's VMs.
- display_
name str - fixed_
scales Sequence[GetPool Fixed Scale] A
fixed_scale
block that describes the scale settings when using fixed scale.- id str
The provider-assigned unique ID for this managed resource.
- max_
tasks_ intper_ node The maximum number of tasks that can run concurrently on a single compute node in the pool.
- metadata Mapping[str, str]
- name str
The name of the endpoint.
- network_
configurations Sequence[GetPool Network Configuration] - node_
agent_ strsku_ id The SKU of the node agents in the Batch pool.
- resource_
group_ strname - start_
tasks Sequence[GetPool Start Task] A
start_task
block that describes the start task settings for the Batch pool.- storage_
image_ Sequence[Getreferences Pool Storage Image Reference] The reference of the storage image used by the nodes in the Batch pool.
- vm_
size str The size of the VM created in the Batch pool.
- account
Name String The name of the Batch account.
- auto
Scales 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.- container
Configurations List The container configuration used in the pool's VMs.
- display
Name String - fixed
Scales 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.
- max
Tasks NumberPer Node 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.
- network
Configurations List - node
Agent StringSku Id The SKU of the node agents in the Batch pool.
- resource
Group StringName - start
Tasks List A
start_task
block that describes the start task settings for the Batch pool.- storage
Image ListReferences The reference of the storage image used by the nodes in the Batch pool.
- vm
Size String The size of the VM created in the Batch pool.
Supporting Types
GetPoolAutoScale
- Evaluation
Interval string The interval to wait before evaluating if the pool needs to be scaled.
- Formula string
The autoscale formula that needs to be used for scaling the Batch pool.
- Evaluation
Interval string The interval to wait before evaluating if the pool needs to be scaled.
- Formula string
The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation
Interval String The interval to wait before evaluating if the pool needs to be scaled.
- formula String
The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation
Interval string The interval to wait before evaluating if the pool needs to be scaled.
- formula string
The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation_
interval str The interval to wait before evaluating if the pool needs to be scaled.
- formula str
The autoscale formula that needs to be used for scaling the Batch pool.
- evaluation
Interval String The interval to wait before evaluating if the pool needs to be scaled.
- formula String
The autoscale formula that needs to be used for scaling the Batch pool.
GetPoolCertificate
- Id string
The fully qualified ID of the certificate installed on the pool.
- Store
Location string The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
.- Store
Name string The name of the certificate store on the compute node into which the certificate is installed.
- Visibilities List<string>
Which user accounts on the compute node have access to the private data of the certificate.
- Id string
The fully qualified ID of the certificate installed on the pool.
- Store
Location string The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
.- Store
Name string The name of the certificate store on the compute node into which the certificate is installed.
- Visibilities []string
Which user accounts on the compute node have access to the private data of the certificate.
- id String
The fully qualified ID of the certificate installed on the pool.
- store
Location String The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
.- store
Name String The name of the certificate store on the compute node into which the certificate is installed.
- visibilities
List
Which user accounts on the compute node have access to the private data of the certificate.
- id string
The fully qualified ID of the certificate installed on the pool.
- store
Location string The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
.- store
Name string The name of the certificate store on the compute node into which the certificate is installed.
- visibilities string[]
Which user accounts on the compute node have access to the private data of the certificate.
- id str
The fully qualified ID of the certificate installed on the pool.
- store_
location str The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
.- store_
name str The name of the certificate store on the compute node into which the certificate is installed.
- visibilities Sequence[str]
Which user accounts on the compute node have access to the private data of the certificate.
- id String
The fully qualified ID of the certificate installed on the pool.
- store
Location String The location of the certificate store on the compute node into which the certificate is installed, either
CurrentUser
orLocalMachine
.- store
Name String The name of the certificate store on the compute node into which the certificate is installed.
- visibilities
List
Which user accounts on the compute node have access to the private data of the certificate.
GetPoolContainerConfiguration
- Container
Image List<string>Names A list of container image names to use, as would be specified by
docker pull
.- Container
Registries List<GetPool Container Configuration Container Registry> Additional container registries from which container images can be pulled by the pool's VMs.
- Type string
The type of container configuration.
- Container
Image []stringNames A list of container image names to use, as would be specified by
docker pull
.- Container
Registries []GetPool Container Configuration Container Registry Additional container registries from which container images can be pulled by the pool's VMs.
- Type string
The type of container configuration.
- container
Image ListNames A list of container image names to use, as would be specified by
docker pull
.- container
Registries ListPool Container Configuration Container Registry> Additional container registries from which container images can be pulled by the pool's VMs.
- type String
The type of container configuration.
- container
Image string[]Names A list of container image names to use, as would be specified by
docker pull
.- container
Registries GetPool Container Configuration Container Registry[] Additional container registries from which container images can be pulled by the pool's VMs.
- type string
The type of container configuration.
- container_
image_ Sequence[str]names A list of container image names to use, as would be specified by
docker pull
.- container_
registries Sequence[GetPool Container Configuration Container Registry] Additional container registries from which container images can be pulled by the pool's VMs.
- type str
The type of container configuration.
- container
Image ListNames A list of container image names to use, as would be specified by
docker pull
.- container
Registries 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.
- Registry
Server string The container registry URL. The default is "docker.io".
- User
Name string The user name to log into the registry server.
- Password string
The password to log into the registry server.
- Registry
Server string The container registry URL. The default is "docker.io".
- User
Name string The user name to log into the registry server.
- password String
The password to log into the registry server.
- registry
Server String The container registry URL. The default is "docker.io".
- user
Name String The user name to log into the registry server.
- password string
The password to log into the registry server.
- registry
Server string The container registry URL. The default is "docker.io".
- user
Name 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.
- registry
Server String The container registry URL. The default is "docker.io".
- user
Name String The user name to log into the registry server.
GetPoolFixedScale
- Resize
Timeout string The timeout for resize operations.
- Target
Dedicated intNodes The number of nodes in the Batch pool.
- Target
Low intPriority Nodes The number of low priority nodes in the Batch pool.
- Resize
Timeout string The timeout for resize operations.
- Target
Dedicated intNodes The number of nodes in the Batch pool.
- Target
Low intPriority Nodes The number of low priority nodes in the Batch pool.
- resize
Timeout String The timeout for resize operations.
- target
Dedicated IntegerNodes The number of nodes in the Batch pool.
- target
Low IntegerPriority Nodes The number of low priority nodes in the Batch pool.
- resize
Timeout string The timeout for resize operations.
- target
Dedicated numberNodes The number of nodes in the Batch pool.
- target
Low numberPriority Nodes The number of low priority nodes in the Batch pool.
- resize_
timeout str The timeout for resize operations.
- target_
dedicated_ intnodes The number of nodes in the Batch pool.
- target_
low_ intpriority_ nodes The number of low priority nodes in the Batch pool.
- resize
Timeout String The timeout for resize operations.
- target
Dedicated NumberNodes The number of nodes in the Batch pool.
- target
Low NumberPriority Nodes The number of low priority nodes in the Batch pool.
GetPoolNetworkConfiguration
- Endpoint
Configurations List<GetPool Network Configuration Endpoint Configuration> The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- Subnet
Id string The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- Endpoint
Configurations []GetPool Network Configuration Endpoint Configuration The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- Subnet
Id string The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- endpoint
Configurations ListPool Network Configuration Endpoint Configuration> The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- subnet
Id String The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- endpoint
Configurations GetPool Network Configuration Endpoint Configuration[] The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- subnet
Id string The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- endpoint_
configurations Sequence[GetPool Network Configuration Endpoint Configuration] The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- subnet_
id str The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
- endpoint
Configurations List The inbound NAT pools that are used to address specific ports on the individual compute node externally.
- subnet
Id String The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.
GetPoolNetworkConfigurationEndpointConfiguration
- Backend
Port int The port number on the compute node.
- Frontend
Port stringRange The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
.- Name string
The name of the endpoint.
- Network
Security List<GetGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule> The list of network security group rules that are applied to the endpoint.
- Protocol string
The protocol of the endpoint.
- Backend
Port int The port number on the compute node.
- Frontend
Port stringRange The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
.- Name string
The name of the endpoint.
- Network
Security []GetGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule The list of network security group rules that are applied to the endpoint.
- Protocol string
The protocol of the endpoint.
- backend
Port Integer The port number on the compute node.
- frontend
Port StringRange The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
.- name String
The name of the endpoint.
- network
Security ListGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule> The list of network security group rules that are applied to the endpoint.
- protocol String
The protocol of the endpoint.
- backend
Port number The port number on the compute node.
- frontend
Port stringRange The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
.- name string
The name of the endpoint.
- network
Security GetGroup Rules Pool Network Configuration Endpoint Configuration Network Security Group Rule[] The list of network security group rules that are applied to the endpoint.
- protocol string
The protocol of the endpoint.
- backend_
port int The port number on the compute node.
- frontend_
port_ strrange The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
.- name str
The name of the endpoint.
- network_
security_ Sequence[Getgroup_ rules Pool Network Configuration Endpoint Configuration Network Security Group Rule] The list of network security group rules that are applied to the endpoint.
- protocol str
The protocol of the endpoint.
- backend
Port Number The port number on the compute node.
- frontend
Port StringRange The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of
1000-1100
.- name String
The name of the endpoint.
- network
Security ListGroup Rules The list of network security group rules that are applied to the endpoint.
- protocol String
The protocol of the endpoint.
GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule
- Access string
The action that should be taken for a specified IP address, subnet range or tag.
- Priority int
The priority for this rule.
- Source
Address stringPrefix The source address prefix or tag to match for the rule.
- Access string
The action that should be taken for a specified IP address, subnet range or tag.
- Priority int
The priority for this rule.
- Source
Address stringPrefix The source address prefix or tag to match for the rule.
- access String
The action that should be taken for a specified IP address, subnet range or tag.
- priority Integer
The priority for this rule.
- source
Address StringPrefix The source address prefix or tag to match for the rule.
- access string
The action that should be taken for a specified IP address, subnet range or tag.
- priority number
The priority for this rule.
- source
Address stringPrefix The source address prefix or tag to match for the rule.
- access str
The action that should be taken for a specified IP address, subnet range or tag.
- priority int
The priority for this rule.
- source_
address_ strprefix The source address prefix or tag to match for the rule.
- access String
The action that should be taken for a specified IP address, subnet range or tag.
- priority Number
The priority for this rule.
- source
Address StringPrefix The source address prefix or tag to match for the rule.
GetPoolStartTask
- Command
Line string The command line executed by the start task.
- Resource
Files List<GetPool Start Task Resource File> One or more
resource_file
blocks that describe the files to be downloaded to a compute node.- Task
Retry intMaximum The number of retry count
- User
Identities List<GetPool Start Task User Identity> A
user_identity
block that describes the user identity under which the start task runs.- Wait
For boolSuccess A flag that indicates if the Batch pool should wait for the start task to be completed.
- Common
Environment Dictionary<string, string>Properties A map of strings (key,value) that represents the environment variables to set in the start task.
- Command
Line string The command line executed by the start task.
- Resource
Files []GetPool Start Task Resource File One or more
resource_file
blocks that describe the files to be downloaded to a compute node.- Task
Retry intMaximum The number of retry count
- User
Identities []GetPool Start Task User Identity A
user_identity
block that describes the user identity under which the start task runs.- Wait
For boolSuccess A flag that indicates if the Batch pool should wait for the start task to be completed.
- Common
Environment map[string]stringProperties A map of strings (key,value) that represents the environment variables to set in the start task.
- command
Line String The command line executed by the start task.
- resource
Files ListPool Start Task Resource File> One or more
resource_file
blocks that describe the files to be downloaded to a compute node.- task
Retry IntegerMaximum The number of retry count
- user
Identities ListPool Start Task User Identity> A
user_identity
block that describes the user identity under which the start task runs.- wait
For BooleanSuccess A flag that indicates if the Batch pool should wait for the start task to be completed.
- common
Environment MapProperties A map of strings (key,value) that represents the environment variables to set in the start task.
- command
Line string The command line executed by the start task.
- resource
Files GetPool Start Task Resource File[] One or more
resource_file
blocks that describe the files to be downloaded to a compute node.- task
Retry numberMaximum The number of retry count
- user
Identities GetPool Start Task User Identity[] A
user_identity
block that describes the user identity under which the start task runs.- wait
For booleanSuccess A flag that indicates if the Batch pool should wait for the start task to be completed.
- common
Environment {[key: string]: string}Properties A map of strings (key,value) that represents the environment variables to set in the start task.
- command_
line str The command line executed by the start task.
- resource_
files Sequence[GetPool Start Task Resource File] One or more
resource_file
blocks that describe the files to be downloaded to a compute node.- task_
retry_ intmaximum The number of retry count
- user_
identities Sequence[GetPool Start Task User Identity] A
user_identity
block that describes the user identity under which the start task runs.- wait_
for_ boolsuccess A flag that indicates if the Batch pool should wait for the start task to be completed.
- common_
environment_ Mapping[str, str]properties A map of strings (key,value) that represents the environment variables to set in the start task.
- command
Line String The command line executed by the start task.
- resource
Files List One or more
resource_file
blocks that describe the files to be downloaded to a compute node.- task
Retry NumberMaximum The number of retry count
- user
Identities List A
user_identity
block that describes the user identity under which the start task runs.- wait
For BooleanSuccess A flag that indicates if the Batch pool should wait for the start task to be completed.
- common
Environment MapProperties A map of strings (key,value) that represents the environment variables to set in the start task.
GetPoolStartTaskResourceFile
- Auto
Storage stringContainer Name The storage container name in the auto storage account.
- Blob
Prefix string The blob prefix used when downloading blobs from an Azure Storage container.
- File
Mode string The file permission mode attribute represented as a string in octal format (e.g.
"0644"
).- File
Path string The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified.- Http
Url string The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- Storage
Container stringUrl The URL of the blob container within Azure Blob Storage.
- Auto
Storage stringContainer Name The storage container name in the auto storage account.
- Blob
Prefix string The blob prefix used when downloading blobs from an Azure Storage container.
- File
Mode string The file permission mode attribute represented as a string in octal format (e.g.
"0644"
).- File
Path string The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified.- Http
Url string The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- Storage
Container stringUrl The URL of the blob container within Azure Blob Storage.
- auto
Storage StringContainer Name The storage container name in the auto storage account.
- blob
Prefix String The blob prefix used when downloading blobs from an Azure Storage container.
- file
Mode String The file permission mode attribute represented as a string in octal format (e.g.
"0644"
).- file
Path String The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified.- http
Url String The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage
Container StringUrl The URL of the blob container within Azure Blob Storage.
- auto
Storage stringContainer Name The storage container name in the auto storage account.
- blob
Prefix string The blob prefix used when downloading blobs from an Azure Storage container.
- file
Mode string The file permission mode attribute represented as a string in octal format (e.g.
"0644"
).- file
Path string The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified.- http
Url string The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage
Container stringUrl The URL of the blob container within Azure Blob Storage.
- auto_
storage_ strcontainer_ name The storage container name in the auto storage account.
- blob_
prefix str The blob prefix used when downloading blobs from an Azure Storage container.
- file_
mode str The file permission mode attribute represented as a string in octal format (e.g.
"0644"
).- file_
path str The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified.- http_
url str The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage_
container_ strurl The URL of the blob container within Azure Blob Storage.
- auto
Storage StringContainer Name The storage container name in the auto storage account.
- blob
Prefix String The blob prefix used when downloading blobs from an Azure Storage container.
- file
Mode String The file permission mode attribute represented as a string in octal format (e.g.
"0644"
).- file
Path String The location on the compute node to which to download the file, relative to the task's working directory. If the
http_url
property is specified, thefile_path
is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if theauto_storage_container_name
orstorage_container_url
property is specified.- http
Url String The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
- storage
Container StringUrl The URL of the blob container within Azure Blob Storage.
GetPoolStartTaskUserIdentity
- Auto
Users List<GetPool Start Task User Identity Auto User> A
auto_user
block that describes the user identity under which the start task runs.- User
Name string The user name to log into the registry server.
- Auto
Users []GetPool Start Task User Identity Auto User A
auto_user
block that describes the user identity under which the start task runs.- User
Name string The user name to log into the registry server.
- auto
Users ListPool Start Task User Identity Auto User> A
auto_user
block that describes the user identity under which the start task runs.- user
Name String The user name to log into the registry server.
- auto
Users GetPool Start Task User Identity Auto User[] A
auto_user
block that describes the user identity under which the start task runs.- user
Name string The user name to log into the registry server.
- auto_
users Sequence[GetPool Start Task User Identity Auto User] A
auto_user
block that describes the user identity under which the start task runs.- user_
name str The user name to log into the registry server.
GetPoolStartTaskUserIdentityAutoUser
- Elevation
Level 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 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 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 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.
- elevation
Level 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
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.