| Description | : Lists all of the Jobs in the specified Account. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "Jobs_ListJobs",
"$parameters": [
{
"#name": "$filter",
"Description": {
"new": "An OData $filter clause. For more information on constructing this filter, see\nhttps://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs.",
"old": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs."
}
}
],
"$responses": {
"200": {
"$properties": {
"value": {
"$properties": {
"jobManagerTask": [
{
"#name": "commandLine",
"Description": {
"new": "The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).",
"old": "The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)."
}
},
{
"outputFiles": {
"$properties": {
"destination": [
{
"container": [
{
"#name": "uploadHeaders",
"Description": {
"new": "A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.",
"old": "A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types."
}
}
]
}
]
}
}
}
],
"jobPreparationTask": [
{
"#name": "commandLine",
"Description": {
"new": "The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).",
"old": "The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)."
}
}
],
"jobReleaseTask": [
{
"#name": "commandLine",
"Description": {
"new": "The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).",
"old": "The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)."
}
}
],
"poolInfo": [
{
"autoPoolSpecification": [
{
"pool": [
{
"#name": "vmSize",
"Description": {
"new": "The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).",
"old": "The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)."
}
},
{
"virtualMachineConfiguration": [
{
"imageReference": [
{
"#name": "virtualMachineImageId",
"Description": {
"new": "The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.",
"old": "The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration."
}
}
]
},
{
"#name": "dataDisks",
"Description": {
"new": "The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.",
"old": "The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine."
}
},
{
"osDisk": [
{
"ephemeralOSDiskSettings": [
{
"#name": "placement",
"Description": {
"new": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.",
"old": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements."
}
}
]
}
]
}
]
},
{
"networkConfiguration": [
{
"#name": "subnetId",
"Description": {
"new": "The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration",
"old": "The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration"
}
}
]
},
{
"startTask": [
{
"#name": "commandLine",
"Description": {
"new": "The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).",
"old": "The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)."
}
}
]
}
]
}
]
}
],
"networkConfiguration": [
{
"#name": "subnetId",
"Description": {
"new": "The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.",
"old": "The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration."
}
}
]
}
}
}
}
}
}
⚼ Request
GET:
/jobs
{
api-version:
string
,
timeOut:
integer
,
client-request-id:
string
,
return-client-request-id:
boolean
,
ocp-date:
string
,
maxresults:
integer
,
$filter:
string
,
$select:
array
,
$expand:
array
,
}
⚐ Response (200)
{
$headers:
{
,
etag:
string
,
last-modified:
string
,
client-request-id:
string
,
request-id:
string
,
}
$schema:
}
{
,
value:
[
]
,
{
,
id:
string
,
displayName:
string
,
usesTaskDependencies:
boolean
,
url:
string
,
eTag:
string
,
lastModified:
string
,
creationTime:
string
,
state:
enum
,
stateTransitionTime:
string
,
previousState:
enum
,
previousStateTransitionTime:
string
,
priority:
integer
,
allowTaskPreemption:
boolean
,
maxParallelTasks:
integer
,
constraints:
{
,
maxWallClockTime:
string
,
maxTaskRetryCount:
integer
,
}
jobManagerTask:
{
,
id:
string
,
displayName:
string
,
commandLine:
string
,
containerSettings:
{
,
containerRunOptions:
string
,
imageName:
string
,
registry:
{
,
username:
string
,
password:
string
,
registryServer:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
workingDirectory:
enum
,
containerHostBatchBindMounts:
}
[
]
,
{
,
source:
enum
,
isReadOnly:
boolean
,
}
resourceFiles:
[
]
,
{
,
autoStorageContainerName:
string
,
storageContainerUrl:
string
,
httpUrl:
string
,
blobPrefix:
string
,
filePath:
string
,
fileMode:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
outputFiles:
[
]
,
{
,
filePattern:
string
,
destination:
{
,
container:
}
{
,
path:
string
,
containerUrl:
string
,
identityReference:
{
,
resourceId:
string
,
}
uploadHeaders:
}
[
]
,
{
,
name:
string
,
value:
string
,
}
uploadOptions:
}
{
,
uploadCondition:
enum
,
}
environmentSettings:
[
]
,
{
,
name:
string
,
value:
string
,
}
constraints:
{
,
maxWallClockTime:
string
,
retentionTime:
string
,
maxTaskRetryCount:
integer
,
}
requiredSlots:
integer
,
killJobOnCompletion:
boolean
,
userIdentity:
{
,
username:
string
,
autoUser:
}
{
,
scope:
enum
,
elevationLevel:
enum
,
}
runExclusive:
boolean
,
applicationPackageReferences:
[
]
,
{
,
applicationId:
string
,
version:
string
,
}
authenticationTokenSettings:
{
,
access:
}
[
,
string
,
]
allowLowPriorityNode:
boolean
,
}
jobPreparationTask:
{
,
id:
string
,
commandLine:
string
,
containerSettings:
{
,
containerRunOptions:
string
,
imageName:
string
,
registry:
{
,
username:
string
,
password:
string
,
registryServer:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
workingDirectory:
enum
,
containerHostBatchBindMounts:
}
[
]
,
{
,
source:
enum
,
isReadOnly:
boolean
,
}
resourceFiles:
[
]
,
{
,
autoStorageContainerName:
string
,
storageContainerUrl:
string
,
httpUrl:
string
,
blobPrefix:
string
,
filePath:
string
,
fileMode:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
environmentSettings:
[
]
,
{
,
name:
string
,
value:
string
,
}
constraints:
{
,
maxWallClockTime:
string
,
retentionTime:
string
,
maxTaskRetryCount:
integer
,
}
waitForSuccess:
boolean
,
userIdentity:
{
,
username:
string
,
autoUser:
}
{
,
scope:
enum
,
elevationLevel:
enum
,
}
rerunOnNodeRebootAfterSuccess:
boolean
,
}
jobReleaseTask:
{
,
id:
string
,
commandLine:
string
,
containerSettings:
{
,
containerRunOptions:
string
,
imageName:
string
,
registry:
{
,
username:
string
,
password:
string
,
registryServer:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
workingDirectory:
enum
,
containerHostBatchBindMounts:
}
[
]
,
{
,
source:
enum
,
isReadOnly:
boolean
,
}
resourceFiles:
[
]
,
{
,
autoStorageContainerName:
string
,
storageContainerUrl:
string
,
httpUrl:
string
,
blobPrefix:
string
,
filePath:
string
,
fileMode:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
environmentSettings:
[
]
,
{
,
name:
string
,
value:
string
,
}
maxWallClockTime:
string
,
retentionTime:
string
,
userIdentity:
}
{
,
username:
string
,
autoUser:
}
{
,
scope:
enum
,
elevationLevel:
enum
,
}
commonEnvironmentSettings:
[
]
,
{
,
name:
string
,
value:
string
,
}
poolInfo:
{
,
poolId:
string
,
autoPoolSpecification:
}
{
,
autoPoolIdPrefix:
string
,
poolLifetimeOption:
enum
,
keepAlive:
boolean
,
pool:
}
{
,
displayName:
string
,
vmSize:
string
,
virtualMachineConfiguration:
{
,
imageReference:
{
,
publisher:
string
,
offer:
string
,
sku:
string
,
version:
string
,
virtualMachineImageId:
string
,
exactVersion:
string
,
sharedGalleryImageId:
string
,
communityGalleryImageId:
string
,
}
nodeAgentSKUId:
string
,
windowsConfiguration:
{
,
enableAutomaticUpdates:
boolean
,
}
dataDisks:
[
]
,
{
,
lun:
integer
,
caching:
enum
,
diskSizeGB:
integer
,
storageAccountType:
enum
,
}
licenseType:
string
,
containerConfiguration:
{
,
type:
enum
,
containerImageNames:
[
,
string
,
]
containerRegistries:
}
[
]
,
{
,
username:
string
,
password:
string
,
registryServer:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
diskEncryptionConfiguration:
{
,
targets:
}
[
,
string
,
]
nodePlacementConfiguration:
{
,
policy:
enum
,
}
extensions:
[
]
,
{
,
name:
string
,
publisher:
string
,
type:
string
,
typeHandlerVersion:
string
,
autoUpgradeMinorVersion:
boolean
,
enableAutomaticUpgrade:
boolean
,
settings:
object
,
protectedSettings:
object
,
provisionAfterExtensions:
}
[
,
string
,
]
osDisk:
{
,
ephemeralOSDiskSettings:
{
,
placement:
enum
,
}
caching:
enum
,
diskSizeGB:
integer
,
managedDisk:
{
,
storageAccountType:
enum
,
securityProfile:
}
{
,
securityEncryptionType:
enum
,
}
writeAcceleratorEnabled:
boolean
,
}
securityProfile:
{
,
encryptionAtHost:
boolean
,
securityType:
enum
,
uefiSettings:
}
{
,
secureBootEnabled:
boolean
,
vTpmEnabled:
boolean
,
}
serviceArtifactReference:
}
{
,
id:
string
,
}
taskSlotsPerNode:
integer
,
taskSchedulingPolicy:
{
,
nodeFillType:
enum
,
}
resizeTimeout:
string
,
resourceTags:
string
,
targetDedicatedNodes:
integer
,
targetLowPriorityNodes:
integer
,
enableAutoScale:
boolean
,
autoScaleFormula:
string
,
autoScaleEvaluationInterval:
string
,
enableInterNodeCommunication:
boolean
,
networkConfiguration:
{
,
subnetId:
string
,
dynamicVNetAssignmentScope:
enum
,
endpointConfiguration:
{
,
inboundNATPools:
}
[
]
,
{
,
name:
string
,
protocol:
enum
,
backendPort:
integer
,
frontendPortRangeStart:
integer
,
frontendPortRangeEnd:
integer
,
networkSecurityGroupRules:
}
[
]
,
{
,
priority:
integer
,
access:
enum
,
sourceAddressPrefix:
string
,
sourcePortRanges:
}
[
,
string
,
]
publicIPAddressConfiguration:
{
,
provision:
enum
,
ipAddressIds:
}
[
,
string
,
]
enableAcceleratedNetworking:
boolean
,
}
startTask:
{
,
commandLine:
string
,
containerSettings:
{
,
containerRunOptions:
string
,
imageName:
string
,
registry:
{
,
username:
string
,
password:
string
,
registryServer:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
workingDirectory:
enum
,
containerHostBatchBindMounts:
}
[
]
,
{
,
source:
enum
,
isReadOnly:
boolean
,
}
resourceFiles:
[
]
,
{
,
autoStorageContainerName:
string
,
storageContainerUrl:
string
,
httpUrl:
string
,
blobPrefix:
string
,
filePath:
string
,
fileMode:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
environmentSettings:
[
]
,
{
,
name:
string
,
value:
string
,
}
userIdentity:
{
,
username:
string
,
autoUser:
}
{
,
scope:
enum
,
elevationLevel:
enum
,
}
maxTaskRetryCount:
integer
,
waitForSuccess:
boolean
,
}
applicationPackageReferences:
[
]
,
{
,
applicationId:
string
,
version:
string
,
}
userAccounts:
[
]
,
{
,
name:
string
,
password:
string
,
elevationLevel:
enum
,
linuxUserConfiguration:
{
,
uid:
integer
,
gid:
integer
,
sshPrivateKey:
string
,
}
windowsUserConfiguration:
}
{
,
loginMode:
enum
,
}
metadata:
[
]
,
{
,
name:
string
,
value:
string
,
}
mountConfiguration:
[
]
,
{
,
azureBlobFileSystemConfiguration:
{
,
accountName:
string
,
containerName:
string
,
accountKey:
string
,
sasKey:
string
,
blobfuseOptions:
string
,
relativeMountPath:
string
,
identityReference:
}
{
,
resourceId:
string
,
}
nfsMountConfiguration:
{
,
source:
string
,
relativeMountPath:
string
,
mountOptions:
string
,
}
cifsMountConfiguration:
{
,
username:
string
,
source:
string
,
relativeMountPath:
string
,
mountOptions:
string
,
password:
string
,
}
azureFileShareConfiguration:
}
{
,
accountName:
string
,
azureFileUrl:
string
,
accountKey:
string
,
relativeMountPath:
string
,
mountOptions:
string
,
}
targetNodeCommunicationMode:
enum
,
upgradePolicy:
}
{
,
mode:
enum
,
automaticOSUpgradePolicy:
{
,
disableAutomaticRollback:
boolean
,
enableAutomaticOSUpgrade:
boolean
,
useRollingUpgradePolicy:
boolean
,
osRollingUpgradeDeferral:
boolean
,
}
rollingUpgradePolicy:
}
{
,
enableCrossZoneUpgrade:
boolean
,
maxBatchInstancePercent:
integer
,
maxUnhealthyInstancePercent:
integer
,
maxUnhealthyUpgradedInstancePercent:
integer
,
pauseTimeBetweenBatches:
string
,
prioritizeUnhealthyInstances:
boolean
,
rollbackFailedInstancesOnPolicyBreach:
boolean
,
}
onAllTasksComplete:
enum
,
onTaskFailure:
enum
,
networkConfiguration:
{
,
subnetId:
string
,
skipWithdrawFromVNet:
boolean
,
}
metadata:
[
]
,
{
,
name:
string
,
value:
string
,
}
executionInfo:
{
,
startTime:
string
,
endTime:
string
,
poolId:
string
,
schedulingError:
{
,
category:
enum
,
code:
string
,
message:
string
,
details:
}
[
]
,
{
,
name:
string
,
value:
string
,
}
terminateReason:
string
,
}
stats:
}
{
,
url:
string
,
startTime:
string
,
lastUpdateTime:
string
,
userCPUTime:
string
,
kernelCPUTime:
string
,
wallClockTime:
string
,
readIOps:
integer
,
writeIOps:
integer
,
readIOGiB:
number
,
writeIOGiB:
number
,
numSucceededTasks:
integer
,
numFailedTasks:
integer
,
numTaskRetries:
integer
,
waitTime:
string
,
}
odata.nextLink:
string
,
}
⚐ Response (default)
{
code:
string
,
message:
{
,
lang:
string
,
value:
string
,
}
values:
}
[
]
,
{
,
key:
string
,
value:
string
,
}