Job - Get
Gets information about the specified Job.
GET {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
The base URL for all Azure Batch service requests. |
job
|
path | True |
string |
The ID of the Job. |
api-version
|
query | True |
string |
Client API Version. |
$expand
|
query |
string |
An OData $expand clause. |
|
$select
|
query |
string |
An OData $select clause. |
|
timeout
|
query |
integer int32 |
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. |
Request Header
Media Types: "application/json; odata=minimalmetadata"
Name | Required | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Whether the server should return the client-request-id in the response. |
|
ocp-date |
string date-time-rfc1123 |
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. |
|
If-Match |
string |
An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. |
|
If-None-Match |
string |
An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. |
|
If-Modified-Since |
string date-time-rfc1123 |
A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
A response containing the Job. Headers
|
|
Other Status Codes |
The error from the Batch service. |
Security
azure_auth
Microsoft Entra OAuth 2.0 auth code flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Impersonate your user account |
Authorization
Type:
apiKey
In:
header
Examples
Job get
Sample request
GET account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0
Sample response
{
"id": "jobId",
"url": "https://account.region.batch.azure.com/jobs/jobId",
"eTag": "0x8D4100FC49F0278",
"lastModified": "2016-11-19T00:05:27.5391608Z",
"creationTime": "2016-11-19T00:05:25.311915Z",
"state": "completed",
"stateTransitionTime": "2016-11-19T00:05:27.578581Z",
"previousState": "active",
"previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
"priority": 0,
"maxParallelTasks": -1,
"allowTaskPreemption": false,
"usesTaskDependencies": false,
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "poolId"
},
"executionInfo": {
"startTime": "2016-11-19T00:05:25.3309105Z",
"endTime": "2016-11-19T00:05:27.578581Z",
"poolId": "poolId",
"terminateReason": "UserTerminate"
},
"onAllTasksComplete": "noaction",
"onTaskFailure": "noaction"
}
Definitions
Name | Description |
---|---|
Access |
The Batch resources to which the token grants access. |
Application |
A reference to an Package to be deployed to Compute Nodes. |
Authentication |
The settings for an authentication token that the Task can use to perform Batch service operations. |
Auto |
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. |
Auto |
The scope for the auto user |
Auto |
Specifies the parameters for the auto user that runs a Task on the Batch service. |
Azure |
Information used to connect to an Azure Storage Container using Blobfuse. |
Azure |
Information used to connect to an Azure Fileshare. |
Batch |
An error response received from the Azure Batch service. |
Batch |
An item of additional information included in an Azure Batch error response. |
Caching |
The type of caching to enable for the disk. |
Certificate |
A reference to a Certificate to be installed on Compute Nodes in a Pool. |
Certificate |
The location of the Certificate store on the Compute Node into which to install the Certificate. |
Certificate |
Which user Accounts on the Compute Node should have access to the private data of the Certificate. |
CIFSMount |
Information used to connect to a CIFS file system. |
Cloud |
An Azure Batch Job. |
Cloud |
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform. |
Compute |
How Tasks are distributed across Compute Nodes in a Pool. |
Compute |
The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
Container |
The configuration for container-enabled Pools. |
Container |
A private container registry. |
Container |
The container technology to be used. |
Container |
The location of the container Task working directory. |
Data |
Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them. |
Diff |
Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool. |
Diff |
Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). |
Disk |
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute Gallery Image. |
Disk |
The list of disk targets Batch Service will encrypt on the compute node. |
Dynamic |
The scope of dynamic vnet assignment. |
Elevation |
The elevation level of the user. |
Environment |
An environment variable to be set on a Task process. |
Error |
The category of the error. |
Error |
An error message received in an Azure Batch error response. |
Http |
An HTTP header name-value pair |
Image |
A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation. |
Inbound |
The protocol of the endpoint. |
Inbound |
A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally. |
IPAddress |
The provisioning type for Public IP Addresses for the Pool. |
Job |
The execution constraints for a Job. |
Job |
Contains information about the execution of a Job in the Azure Batch service. |
Job |
Specifies details of a Job Manager Task. |
Job |
The network configuration for the Job. |
Job |
A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. |
Job |
A Job Release Task to run on Job completion on any Compute Node where the Job has run. |
Job |
An error encountered by the Batch service when scheduling a Job. |
Job |
The state of the Job. |
Job |
Resource usage statistics for a Job. |
Linux |
Properties used to create a user Account on a Linux Compute Node. |
Login |
The login mode for the user |
Managed |
|
Metadata |
A name-value pair associated with a Batch service resource. |
Mount |
The file system to mount on each node. |
Name |
Represents a name-value pair. |
Network |
The network configuration for a Pool. |
Network |
A network security group rule to apply to an inbound endpoint. |
Network |
The action that should be taken for a specified IP address, subnet range or tag. |
NFSMount |
Information used to connect to an NFS file system. |
Node |
Determines how a pool communicates with the Batch service. |
Node |
Node placement configuration for a pool. |
Node |
The placement policy for allocating nodes in the pool. |
On |
The action the Batch service should take when all Tasks in the Job are in the completed state. |
On |
The action the Batch service should take when any Task in the Job fails. |
OSDisk |
Settings for the operating system disk of the compute node (VM). |
Output |
A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process. |
Output |
Specifies a file upload destination within an Azure blob storage container. |
Output |
The destination to which a file should be uploaded. |
Output |
The conditions under which a Task output file or set of files should be uploaded. |
Output |
Details about an output file upload operation, including under what conditions to perform the upload. |
Pool |
The endpoint configuration for a Pool. |
Pool |
Specifies how a Job should be assigned to a Pool. |
Pool |
The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. |
Pool |
Specification for creating a new Pool. |
Public |
The public IP Address configuration of the networking configuration of a Pool. |
Resource |
A single file or multiple files to be downloaded to a Compute Node. |
Security |
Specifies the security profile settings for the virtual machine or virtual machine scale set. |
Security |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. |
Service |
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. |
Start |
A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged. |
Storage |
The storage Account type for use in creating data disks or OS disk. |
Task |
Execution constraints to apply to a Task. |
Task |
The container settings for a Task. |
Task |
Specifies how Tasks should be distributed across Compute Nodes. |
Uefi |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
User |
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node. |
User |
The definition of the user identity under which the Task is run. |
Virtual |
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure. |
VMExtension |
The configuration for virtual machine extensions. |
Windows |
Windows operating system settings to apply to the virtual machine. |
Windows |
Properties used to create a user Account on a Windows Compute Node. |
AccessScope
The Batch resources to which the token grants access.
Name | Type | Description |
---|---|---|
job |
string |
Grants access to perform all operations on the Job containing the Task. |
ApplicationPackageReference
A reference to an Package to be deployed to Compute Nodes.
Name | Type | Description |
---|---|---|
applicationId |
string |
The ID of the application to deploy. |
version |
string |
The version of the application to deploy. If omitted, the default version is deployed. |
AuthenticationTokenSettings
The settings for an authentication token that the Task can use to perform Batch service operations.
Name | Type | Description |
---|---|---|
access |
The Batch resources to which the token grants access. |
AutoPoolSpecification
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.
Name | Type | Description |
---|---|---|
autoPoolIdPrefix |
string |
A prefix to be added to the unique identifier when a Pool is automatically created. |
keepAlive |
boolean |
Whether to keep an auto Pool alive after its lifetime expires. |
pool |
The Pool specification for the auto Pool. |
|
poolLifetimeOption |
The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. |
AutoUserScope
The scope for the auto user
Name | Type | Description |
---|---|---|
pool |
string |
Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. |
task |
string |
Specifies that the service should create a new user for the Task. |
AutoUserSpecification
Specifies the parameters for the auto user that runs a Task on the Batch service.
Name | Type | Description |
---|---|---|
elevationLevel |
The elevation level of the auto user. |
|
scope |
The scope for the auto user |
AzureBlobFileSystemConfiguration
Information used to connect to an Azure Storage Container using Blobfuse.
Name | Type | Description |
---|---|---|
accountKey |
string |
The Azure Storage Account key. |
accountName |
string |
The Azure Storage Account name. |
blobfuseOptions |
string |
Additional command line options to pass to the mount command. |
containerName |
string |
The Azure Blob Storage Container name. |
identityReference |
The reference to the user assigned identity to use to access containerName |
|
relativeMountPath |
string |
The relative path on the compute node where the file system will be mounted |
sasKey |
string |
The Azure Storage SAS token. |
AzureFileShareConfiguration
Information used to connect to an Azure Fileshare.
Name | Type | Description |
---|---|---|
accountKey |
string |
The Azure Storage account key. |
accountName |
string |
The Azure Storage account name. |
azureFileUrl |
string |
The Azure Files URL. |
mountOptions |
string |
Additional command line options to pass to the mount command. |
relativeMountPath |
string |
The relative path on the compute node where the file system will be mounted |
BatchError
An error response received from the Azure Batch service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
message |
A message describing the error, intended to be suitable for display in a user interface. |
|
values |
A collection of key-value pairs containing additional details about the error. |
BatchErrorDetail
An item of additional information included in an Azure Batch error response.
Name | Type | Description |
---|---|---|
key |
string |
An identifier specifying the meaning of the Value property. |
value |
string |
The additional information included with the error response. |
CachingType
The type of caching to enable for the disk.
Name | Type | Description |
---|---|---|
none |
string |
The caching mode for the disk is not enabled. |
readonly |
string |
The caching mode for the disk is read only. |
readwrite |
string |
The caching mode for the disk is read and write. |
CertificateReference
A reference to a Certificate to be installed on Compute Nodes in a Pool.
Name | Type | Description |
---|---|---|
storeLocation |
The location of the Certificate store on the Compute Node into which to install the Certificate. |
|
storeName |
string |
The name of the Certificate store on the Compute Node into which to install the Certificate. |
thumbprint |
string |
The thumbprint of the Certificate. |
thumbprintAlgorithm |
string |
The algorithm with which the thumbprint is associated. This must be sha1. |
visibility |
Which user Accounts on the Compute Node should have access to the private data of the Certificate. |
CertificateStoreLocation
The location of the Certificate store on the Compute Node into which to install the Certificate.
Name | Type | Description |
---|---|---|
currentuser |
string |
Certificates should be installed to the CurrentUser Certificate store. |
localmachine |
string |
Certificates should be installed to the LocalMachine Certificate store. |
CertificateVisibility
Which user Accounts on the Compute Node should have access to the private data of the Certificate.
Name | Type | Description |
---|---|---|
remoteuser |
string |
The Certificate should be visible to the user accounts under which users remotely access the Compute Node. |
starttask |
string |
The Certificate should be visible to the user account under which the StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well. |
task |
string |
The Certificate should be visible to the user accounts under which Job Tasks are run. |
CIFSMountConfiguration
Information used to connect to a CIFS file system.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Additional command line options to pass to the mount command. |
password |
string |
The password to use for authentication against the CIFS file system. |
relativeMountPath |
string |
The relative path on the compute node where the file system will be mounted |
source |
string |
The URI of the file system to mount. |
username |
string |
The user to use for authentication against the CIFS file system. |
CloudJob
An Azure Batch Job.
Name | Type | Default value | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Whether Tasks in this job can be preempted by other high priority jobs |
|
commonEnvironmentSettings |
The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). |
||
constraints |
The execution constraints for the Job. |
||
creationTime |
string |
The creation time of the Job. |
|
displayName |
string |
The display name for the Job. |
|
eTag |
string |
The ETag of the Job. |
|
executionInfo |
The execution information for the Job. |
||
id |
string |
A string that uniquely identifies the Job within the Account. |
|
jobManagerTask |
Details of a Job Manager Task to be launched when the Job is started. |
||
jobPreparationTask |
The Job Preparation Task. |
||
jobReleaseTask |
The Job Release Task. |
||
lastModified |
string |
The last modified time of the Job. |
|
maxParallelTasks |
integer |
-1 |
The maximum number of tasks that can be executed in parallel for the job. |
metadata |
A list of name-value pairs associated with the Job as metadata. |
||
networkConfiguration |
The network configuration for the Job. |
||
onAllTasksComplete |
The action the Batch service should take when all Tasks in the Job are in the completed state. |
||
onTaskFailure |
The action the Batch service should take when any Task in the Job fails. |
||
poolInfo |
The Pool settings associated with the Job. |
||
previousState |
The previous state of the Job. |
||
previousStateTransitionTime |
string |
The time at which the Job entered its previous state. |
|
priority |
integer |
The priority of the Job. |
|
state |
The current state of the Job. |
||
stateTransitionTime |
string |
The time at which the Job entered its current state. |
|
stats |
Resource usage statistics for the entire lifetime of the Job. |
||
url |
string |
The URL of the Job. |
|
usesTaskDependencies |
boolean |
Whether Tasks in the Job can define dependencies on each other. The default is false. |
CloudServiceConfiguration
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.
Name | Type | Description |
---|---|---|
osFamily |
string |
The Azure Guest OS family to be installed on the virtual machines in the Pool. |
osVersion |
string |
The Azure Guest OS version to be installed on the virtual machines in the Pool. |
ComputeNodeFillType
How Tasks are distributed across Compute Nodes in a Pool.
Name | Type | Description |
---|---|---|
pack |
string |
As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. |
spread |
string |
Tasks should be assigned evenly across all Compute Nodes in the Pool. |
ComputeNodeIdentityReference
The reference to a user assigned identity associated with the Batch pool which a compute node will use.
Name | Type | Description |
---|---|---|
resourceId |
string |
The ARM resource id of the user assigned identity. |
ContainerConfiguration
The configuration for container-enabled Pools.
Name | Type | Description |
---|---|---|
containerImageNames |
string[] |
The collection of container Image names. |
containerRegistries |
Additional private registries from which containers can be pulled. |
|
type |
The container technology to be used. |
ContainerRegistry
A private container registry.
Name | Type | Description |
---|---|---|
identityReference |
The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. |
|
password |
string |
The password to log into the registry server. |
registryServer |
string |
The registry URL. |
username |
string |
The user name to log into the registry server. |
ContainerType
The container technology to be used.
Name | Type | Description |
---|---|---|
criCompatible |
string |
A CRI based technology will be used to launch the containers. |
dockerCompatible |
string |
A Docker compatible container technology will be used to launch the containers. |
ContainerWorkingDirectory
The location of the container Task working directory.
Name | Type | Description |
---|---|---|
containerImageDefault |
string |
Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. |
taskWorkingDirectory |
string |
Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. |
DataDisk
Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.
Name | Type | Description |
---|---|---|
caching |
The type of caching to be enabled for the data disks. |
|
diskSizeGB |
integer |
The initial disk size in gigabytes. |
lun |
integer |
The logical unit number. |
storageAccountType |
The storage Account type to be used for the data disk. |
DiffDiskPlacement
Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool.
Name | Type | Description |
---|---|---|
CacheDisk |
string |
The Ephemeral OS Disk is stored on the VM cache. |
DiffDiskSettings
Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).
Name | Type | Description |
---|---|---|
placement |
Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. |
DiskEncryptionConfiguration
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute Gallery Image.
Name | Type | Description |
---|---|---|
targets |
The list of disk targets Batch Service will encrypt on the compute node. |
DiskEncryptionTarget
The list of disk targets Batch Service will encrypt on the compute node.
Name | Type | Description |
---|---|---|
osdisk |
string |
The OS Disk on the compute node is encrypted. |
temporarydisk |
string |
The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time. |
DynamicVNetAssignmentScope
The scope of dynamic vnet assignment.
Name | Type | Description |
---|---|---|
job |
string |
Dynamic VNet assignment is done per-job. |
none |
string |
No dynamic VNet assignment is enabled. |
ElevationLevel
The elevation level of the user.
Name | Type | Description |
---|---|---|
admin |
string |
The user is a user with elevated access and operates with full Administrator permissions. |
nonadmin |
string |
The user is a standard user without elevated access. |
EnvironmentSetting
An environment variable to be set on a Task process.
Name | Type | Description |
---|---|---|
name |
string |
The name of the environment variable. |
value |
string |
The value of the environment variable. |
ErrorCategory
The category of the error.
Name | Type | Description |
---|---|---|
servererror |
string |
The error is due to an internal server issue. |
usererror |
string |
The error is due to a user issue, such as misconfiguration. |
ErrorMessage
An error message received in an Azure Batch error response.
Name | Type | Description |
---|---|---|
lang |
string |
The language code of the error message |
value |
string |
The text of the message. |
HttpHeader
An HTTP header name-value pair
Name | Type | Description |
---|---|---|
name |
string |
The case-insensitive name of the header to be used while uploading output files |
value |
string |
The value of the header to be used while uploading output files |
ImageReference
A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation.
Name | Type | Description |
---|---|---|
exactVersion |
string |
The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. |
offer |
string |
The offer type of the Azure Virtual Machines Marketplace Image. |
publisher |
string |
The publisher of the Azure Virtual Machines Marketplace Image. |
sku |
string |
The SKU of the Azure Virtual Machines Marketplace Image. |
version |
string |
The version of the Azure Virtual Machines Marketplace Image. |
virtualMachineImageId |
string |
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. |
InboundEndpointProtocol
The protocol of the endpoint.
Name | Type | Description |
---|---|---|
tcp |
string |
Use TCP for the endpoint. |
udp |
string |
Use UDP for the endpoint. |
InboundNATPool
A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.
Name | Type | Description |
---|---|---|
backendPort |
integer |
The port number on the Compute Node. |
frontendPortRangeEnd |
integer |
The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. |
frontendPortRangeStart |
integer |
The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. |
name |
string |
The name of the endpoint. |
networkSecurityGroupRules |
A list of network security group rules that will be applied to the endpoint. |
|
protocol |
The protocol of the endpoint. |
IPAddressProvisioningType
The provisioning type for Public IP Addresses for the Pool.
Name | Type | Description |
---|---|---|
batchmanaged |
string |
A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. |
nopublicipaddresses |
string |
No public IP Address will be created. |
usermanaged |
string |
Public IPs are provided by the user and will be used to provision the Compute Nodes. |
JobConstraints
The execution constraints for a Job.
Name | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. |
maxWallClockTime |
string |
The maximum elapsed time that the Job may run, measured from the time the Job is created. |
JobExecutionInformation
Contains information about the execution of a Job in the Azure Batch service.
Name | Type | Description |
---|---|---|
endTime |
string |
The completion time of the Job. |
poolId |
string |
The ID of the Pool to which this Job is assigned. |
schedulingError |
Details of any error encountered by the service in starting the Job. |
|
startTime |
string |
The start time of the Job. |
terminateReason |
string |
A string describing the reason the Job ended. |
JobManagerTask
Specifies details of a Job Manager Task.
Name | Type | Description |
---|---|---|
allowLowPriorityNode |
boolean |
Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. |
applicationPackageReferences |
A list of Application Packages that the Batch service will deploy to the Compute Node before running the command line. |
|
authenticationTokenSettings |
The settings for an authentication token that the Task can use to perform Batch service operations. |
|
commandLine |
string |
The command line of the Job Manager Task. |
constraints |
Constraints that apply to the Job Manager Task. |
|
containerSettings |
The settings for the container under which the Job Manager Task runs. |
|
displayName |
string |
The display name of the Job Manager Task. |
environmentSettings |
A list of environment variable settings for the Job Manager Task. |
|
id |
string |
A string that uniquely identifies the Job Manager Task within the Job. |
killJobOnCompletion |
boolean |
Whether completion of the Job Manager Task signifies completion of the entire Job. |
outputFiles |
A list of files that the Batch service will upload from the Compute Node after running the command line. |
|
requiredSlots |
integer |
The number of scheduling slots that the Task requires to run. |
resourceFiles |
A list of files that the Batch service will download to the Compute Node before running the command line. |
|
runExclusive |
boolean |
Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. |
userIdentity |
The user identity under which the Job Manager Task runs. |
JobNetworkConfiguration
The network configuration for the Job.
Name | Type | Description |
---|---|---|
subnetId |
string |
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. This will only work with a VirtualMachineConfiguration Pool. |
JobPreparationTask
A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.
Name | Type | Description |
---|---|---|
commandLine |
string |
The command line of the Job Preparation Task. |
constraints |
Constraints that apply to the Job Preparation Task. |
|
containerSettings |
The settings for the container under which the Job Preparation Task runs. |
|
environmentSettings |
A list of environment variable settings for the Job Preparation Task. |
|
id |
string |
A string that uniquely identifies the Job Preparation Task within the Job. |
rerunOnNodeRebootAfterSuccess |
boolean |
Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. |
resourceFiles |
A list of files that the Batch service will download to the Compute Node before running the command line. |
|
userIdentity |
The user identity under which the Job Preparation Task runs. |
|
waitForSuccess |
boolean |
Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. |
JobReleaseTask
A Job Release Task to run on Job completion on any Compute Node where the Job has run.
Name | Type | Description |
---|---|---|
commandLine |
string |
The command line of the Job Release Task. |
containerSettings |
The settings for the container under which the Job Release Task runs. |
|
environmentSettings |
A list of environment variable settings for the Job Release Task. |
|
id |
string |
A string that uniquely identifies the Job Release Task within the Job. |
maxWallClockTime |
string |
The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). |
resourceFiles |
A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. |
|
retentionTime |
string |
The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents. |
userIdentity |
The user identity under which the Job Release Task runs. |
JobSchedulingError
An error encountered by the Batch service when scheduling a Job.
Name | Type | Description |
---|---|---|
category |
The category of the Job scheduling error. |
|
code |
string |
An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional error details related to the scheduling error. |
|
message |
string |
A message describing the Job scheduling error, intended to be suitable for display in a user interface. |
JobState
The state of the Job.
Name | Type | Description |
---|---|---|
active |
string |
The Job is available to have Tasks scheduled. |
completed |
string |
All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. |
deleting |
string |
A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). |
disabled |
string |
A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. |
disabling |
string |
A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). |
enabling |
string |
A user has requested that the Job be enabled, but the enable operation is still in progress. |
terminating |
string |
The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). |
JobStatistics
Resource usage statistics for a Job.
Name | Type | Description |
---|---|---|
kernelCPUTime |
string |
The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. |
lastUpdateTime |
string |
The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. |
numFailedTasks |
integer |
The total number of Tasks in the Job that failed during the given time range. |
numSucceededTasks |
integer |
The total number of Tasks successfully completed in the Job during the given time range. |
numTaskRetries |
integer |
The total number of retries on all the Tasks in the Job during the given time range. |
readIOGiB |
number |
The total amount of data in GiB read from disk by all Tasks in the Job. |
readIOps |
integer |
The total number of disk read operations made by all Tasks in the Job. |
startTime |
string |
The start time of the time range covered by the statistics. |
url |
string |
The URL of the statistics. |
userCPUTime |
string |
The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. |
waitTime |
string |
The total wait time of all Tasks in the Job. |
wallClockTime |
string |
The total wall clock time of all Tasks in the Job. |
writeIOGiB |
number |
The total amount of data in GiB written to disk by all Tasks in the Job. |
writeIOps |
integer |
The total number of disk write operations made by all Tasks in the Job. |
LinuxUserConfiguration
Properties used to create a user Account on a Linux Compute Node.
Name | Type | Description |
---|---|---|
gid |
integer |
The group ID for the user Account. |
sshPrivateKey |
string |
The SSH private key for the user Account. |
uid |
integer |
The user ID of the user Account. |
LoginMode
The login mode for the user
Name | Type | Description |
---|---|---|
batch |
string |
The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. |
interactive |
string |
The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. |
ManagedDisk
Name | Type | Description |
---|---|---|
storageAccountType |
The storage account type for managed disk. |
MetadataItem
A name-value pair associated with a Batch service resource.
Name | Type | Description |
---|---|---|
name |
string |
The name of the metadata item. |
value |
string |
The value of the metadata item. |
MountConfiguration
The file system to mount on each node.
Name | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
The Azure Storage Container to mount using blob FUSE on each node. |
|
azureFileShareConfiguration |
The Azure File Share to mount on each node. |
|
cifsMountConfiguration |
The CIFS/SMB file system to mount on each node. |
|
nfsMountConfiguration |
The NFS file system to mount on each node. |
NameValuePair
Represents a name-value pair.
Name | Type | Description |
---|---|---|
name |
string |
The name in the name-value pair. |
value |
string |
The value in the name-value pair. |
NetworkConfiguration
The network configuration for a Pool.
Name | Type | Description |
---|---|---|
dynamicVNetAssignmentScope |
The scope of dynamic vnet assignment. |
|
enableAcceleratedNetworking |
boolean |
Whether this pool should enable accelerated networking. |
endpointConfiguration |
The configuration for endpoints on Compute Nodes in the Batch Pool. |
|
publicIPAddressConfiguration |
The Public IPAddress configuration for Compute Nodes in the Batch Pool. |
|
subnetId |
string |
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}. |
NetworkSecurityGroupRule
A network security group rule to apply to an inbound endpoint.
Name | Type | Description |
---|---|---|
access |
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. |
sourcePortRanges |
string[] |
The source port ranges to match for the rule. |
NetworkSecurityGroupRuleAccess
The action that should be taken for a specified IP address, subnet range or tag.
Name | Type | Description |
---|---|---|
allow |
string |
Allow access. |
deny |
string |
Deny access. |
NFSMountConfiguration
Information used to connect to an NFS file system.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Additional command line options to pass to the mount command. |
relativeMountPath |
string |
The relative path on the compute node where the file system will be mounted |
source |
string |
The URI of the file system to mount. |
NodeCommunicationMode
Determines how a pool communicates with the Batch service.
Name | Type | Description |
---|---|---|
classic |
string |
Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. |
default |
string |
The node communication mode is automatically set by the Batch service. |
simplified |
string |
Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. |
NodePlacementConfiguration
Node placement configuration for a pool.
Name | Type | Description |
---|---|---|
policy |
Node placement Policy type on Batch Pools. |
NodePlacementPolicyType
The placement policy for allocating nodes in the pool.
Name | Type | Description |
---|---|---|
regional |
string |
All nodes in the pool will be allocated in the same region. |
zonal |
string |
Nodes in the pool will be spread across different availability zones with best effort balancing. |
OnAllTasksComplete
The action the Batch service should take when all Tasks in the Job are in the completed state.
Name | Type | Description |
---|---|---|
noaction |
string |
Do nothing. The Job remains active unless terminated or disabled by some other means. |
terminatejob |
string |
Terminate the Job. The Job's terminateReason is set to 'AllTasksComplete'. |
OnTaskFailure
The action the Batch service should take when any Task in the Job fails.
Name | Type | Description |
---|---|---|
noaction |
string |
Do nothing. The Job remains active unless terminated or disabled by some other means. |
performexitoptionsjobaction |
string |
Take the action associated with the Task exit condition in the Task's exitConditions collection. (This may still result in no action being taken, if that is what the Task specifies.) |
OSDisk
Settings for the operating system disk of the compute node (VM).
Name | Type | Description |
---|---|---|
caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
|
diskSizeGB |
integer |
The initial disk size in GB when creating new OS disk. |
ephemeralOSDiskSettings |
Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). |
|
managedDisk |
The managed disk parameters. |
|
writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
OutputFile
A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.
Name | Type | Description |
---|---|---|
destination |
The destination for the output file(s). |
|
filePattern |
string |
A pattern indicating which file(s) to upload. |
uploadOptions |
Additional options for the upload operation, including under what conditions to perform the upload. |
OutputFileBlobContainerDestination
Specifies a file upload destination within an Azure blob storage container.
Name | Type | Description |
---|---|---|
containerUrl |
string |
The URL of the container within Azure Blob Storage to which to upload the file(s). |
identityReference |
The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl |
|
path |
string |
The destination blob or virtual directory within the Azure Storage container. |
uploadHeaders |
A list of name-value pairs for headers to be used in uploading output files |
OutputFileDestination
The destination to which a file should be uploaded.
Name | Type | Description |
---|---|---|
container |
A location in Azure blob storage to which files are uploaded. |
OutputFileUploadCondition
The conditions under which a Task output file or set of files should be uploaded.
Name | Type | Description |
---|---|---|
taskcompletion |
string |
Upload the file(s) after the Task process exits, no matter what the exit code was. |
taskfailure |
string |
Upload the file(s) only after the Task process exits with a nonzero exit code. |
tasksuccess |
string |
Upload the file(s) only after the Task process exits with an exit code of 0. |
OutputFileUploadOptions
Details about an output file upload operation, including under what conditions to perform the upload.
Name | Type | Description |
---|---|---|
uploadCondition |
The conditions under which the Task output file or set of files should be uploaded. |
PoolEndpointConfiguration
The endpoint configuration for a Pool.
Name | Type | Description |
---|---|---|
inboundNATPools |
A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. |
PoolInformation
Specifies how a Job should be assigned to a Pool.
Name | Type | Description |
---|---|---|
autoPoolSpecification |
Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. |
|
poolId |
string |
The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. |
PoolLifetimeOption
The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.
Name | Type | Description |
---|---|---|
job |
string |
The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. |
jobschedule |
string |
The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. |
PoolSpecification
Specification for creating a new Pool.
Name | Type | Description |
---|---|---|
applicationLicenses |
string[] |
The list of application licenses the Batch service will make available on each Compute Node in the Pool. |
applicationPackageReferences |
The list of Packages to be installed on each Compute Node in the Pool. |
|
autoScaleEvaluationInterval |
string |
The time interval at which to automatically adjust the Pool size according to the autoscale formula. |
autoScaleFormula |
string |
The formula for the desired number of Compute Nodes in the Pool. |
certificateReferences |
A list of Certificates to be installed on each Compute Node in the Pool. Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
|
cloudServiceConfiguration |
The cloud service configuration for the Pool. |
|
displayName |
string |
The display name for the Pool. |
enableAutoScale |
boolean |
Whether the Pool size should automatically adjust over time. |
enableInterNodeCommunication |
boolean |
Whether the Pool permits direct communication between Compute Nodes. |
metadata |
A list of name-value pairs associated with the Pool as metadata. |
|
mountConfiguration |
A list of file systems to mount on each node in the pool. |
|
networkConfiguration |
The network configuration for the Pool. |
|
resizeTimeout |
string |
The timeout for allocation of Compute Nodes to the Pool. |
resourceTags |
object |
The user-specified tags associated with the pool. |
startTask |
A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. |
|
targetDedicatedNodes |
integer |
The desired number of dedicated Compute Nodes in the Pool. |
targetLowPriorityNodes |
integer |
The desired number of Spot/Low-priority Compute Nodes in the Pool. |
targetNodeCommunicationMode |
The desired node communication mode for the pool. |
|
taskSchedulingPolicy |
How Tasks are distributed across Compute Nodes in a Pool. |
|
taskSlotsPerNode |
integer |
The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. |
userAccounts |
The list of user Accounts to be created on each Compute Node in the Pool. |
|
virtualMachineConfiguration |
The virtual machine configuration for the Pool. |
|
vmSize |
string |
The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. |
PublicIPAddressConfiguration
The public IP Address configuration of the networking configuration of a Pool.
Name | Type | Description |
---|---|---|
ipAddressIds |
string[] |
The list of public IPs which the Batch service will use when provisioning Compute Nodes. |
provision |
The provisioning type for Public IP Addresses for the Pool. |
ResourceFile
A single file or multiple files to be downloaded to a Compute Node.
Name | Type | Description |
---|---|---|
autoStorageContainerName |
string |
The storage container name in the auto storage Account. |
blobPrefix |
string |
The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. |
fileMode |
string |
The file permission mode attribute in octal format. |
filePath |
string |
The location on the Compute Node to which to download the file(s), relative to the Task's working directory. |
httpUrl |
string |
The URL of the file to download. |
identityReference |
The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl |
|
storageContainerUrl |
string |
The URL of the blob container within Azure Blob Storage. |
SecurityProfile
Specifies the security profile settings for the virtual machine or virtual machine scale set.
Name | Type | Description |
---|---|---|
encryptionAtHost |
boolean |
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. |
securityType |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. |
|
uefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
SecurityTypes
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
Name | Type | Description |
---|---|---|
trustedLaunch |
string |
Trusted launch protects against advanced and persistent attack techniques. |
ServiceArtifactReference
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.
Name | Type | Description |
---|---|---|
id |
string |
The service artifact reference id of ServiceArtifactReference |
StartTask
A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged.
Name | Type | Description |
---|---|---|
commandLine |
string |
The command line of the StartTask. |
containerSettings |
The settings for the container under which the StartTask runs. |
|
environmentSettings |
A list of environment variable settings for the StartTask. |
|
maxTaskRetryCount |
integer |
The maximum number of times the Task may be retried. |
resourceFiles |
A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. |
|
userIdentity |
The user identity under which the StartTask runs. |
|
waitForSuccess |
boolean |
Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. |
StorageAccountType
The storage Account type for use in creating data disks or OS disk.
Name | Type | Description |
---|---|---|
premium_lrs |
string |
The data disk / OS disk should use premium locally redundant storage. |
standard_lrs |
string |
The data disk / OS disk should use standard locally redundant storage. |
standardssd_lrs |
string |
The data disk / OS disk should use standard SSD locally redundant storage. |
TaskConstraints
Execution constraints to apply to a Task.
Name | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. |
maxWallClockTime |
string |
The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. |
retentionTime |
string |
The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. |
TaskContainerSettings
The container settings for a Task.
Name | Type | Description |
---|---|---|
containerRunOptions |
string |
Additional options to the container create command. |
imageName |
string |
The Image to use to create the container in which the Task will run. |
registry |
The private registry which contains the container Image. |
|
workingDirectory |
The location of the container Task working directory. |
TaskSchedulingPolicy
Specifies how Tasks should be distributed across Compute Nodes.
Name | Type | Description |
---|---|---|
nodeFillType |
How Tasks are distributed across Compute Nodes in a Pool. |
UefiSettings
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
Name | Type | Description |
---|---|---|
secureBootEnabled |
boolean |
Specifies whether secure boot should be enabled on the virtual machine. |
vTpmEnabled |
boolean |
Specifies whether vTPM should be enabled on the virtual machine. |
UserAccount
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.
Name | Type | Description |
---|---|---|
elevationLevel |
The elevation level of the user Account. |
|
linuxUserConfiguration |
The Linux-specific user configuration for the user Account. |
|
name |
string |
The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. |
password |
string |
The password for the user Account. |
windowsUserConfiguration |
The Windows-specific user configuration for the user Account. |
UserIdentity
The definition of the user identity under which the Task is run.
Name | Type | Description |
---|---|---|
autoUser |
The auto user under which the Task is run. |
|
username |
string |
The name of the user identity under which the Task is run. |
VirtualMachineConfiguration
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
Name | Type | Description |
---|---|---|
containerConfiguration |
The container configuration for the Pool. |
|
dataDisks |
Data |
The configuration for data disks attached to the Compute Nodes in the Pool. |
diskEncryptionConfiguration |
The disk encryption configuration for the pool. |
|
extensions |
The virtual machine extension for the pool. |
|
imageReference |
A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. |
|
licenseType |
string |
The type of on-premises license to be used when deploying the operating system. Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. |
nodeAgentSKUId |
string |
The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. |
nodePlacementConfiguration |
The node placement configuration for the pool. |
|
osDisk |
Settings for the operating system disk of the Virtual Machine. |
|
securityProfile |
Specifies the security profile settings for the virtual machine or virtual machine scale set. |
|
serviceArtifactReference |
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. |
|
windowsConfiguration |
Windows operating system settings on the virtual machine. |
VMExtension
The configuration for virtual machine extensions.
Name | Type | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
enableAutomaticUpgrade |
boolean |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
name |
string |
The name of the virtual machine extension. |
protectedSettings |
object |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
provisionAfterExtensions |
string[] |
The collection of extension names. |
publisher |
string |
The name of the extension handler publisher. |
settings |
object |
JSON formatted public settings for the extension. |
type |
string |
The type of the extension. |
typeHandlerVersion |
string |
The version of script handler. |
WindowsConfiguration
Windows operating system settings to apply to the virtual machine.
Name | Type | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Whether automatic updates are enabled on the virtual machine. |
WindowsUserConfiguration
Properties used to create a user Account on a Windows Compute Node.
Name | Type | Description |
---|---|---|
loginMode |
The login mode for the user |