Azure.Provisioning.Batch Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AutomaticOSUpgradePolicy |
The configuration parameters used for performing automatic OS upgrade. |
| BatchAccessRule |
Access rule in a network security perimeter configuration profile. |
| BatchAccessRuleProperties |
Properties of Access Rule. |
| BatchAccount |
Contains information about an Azure Batch account. |
| BatchAccount.ResourceVersions | |
| BatchAccountAutoScaleSettings |
AutoScale settings for the pool. |
| BatchAccountAutoStorageConfiguration |
Contains information about the auto-storage account associated with a Batch account. |
| BatchAccountDetector |
Contains the information for a detector. |
| BatchAccountDetector.ResourceVersions | |
| BatchAccountEncryptionConfiguration |
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. |
| BatchAccountFixedScaleSettings |
Fixed scale settings for the pool. |
| BatchAccountPool |
Contains information about a pool. |
| BatchAccountPool.ResourceVersions | |
| BatchAccountPoolAutoScaleRun |
The results and errors from an execution of a pool autoscale formula. |
| BatchAccountPoolMetadataItem |
A name-value pair associated with a Batch service resource. |
| BatchAccountPoolScaleSettings |
Scale settings for the pool. |
| BatchAccountPoolStartTask |
A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. |
| BatchApplication |
Contains information about an application in a Batch account. |
| BatchApplication.ResourceVersions | |
| BatchApplicationPackage |
An application package which represents a particular version of an application. |
| BatchApplicationPackage.ResourceVersions | |
| BatchApplicationPackageReference |
Link to an application package inside the batch account. |
| BatchAutoUserSpecification |
Specifies the parameters for the auto user that runs a task on the Batch service. |
| BatchBlobFileSystemConfiguration |
Information used to connect to an Azure Storage Container using Blobfuse. |
| BatchCifsMountConfiguration |
Information used to connect to a CIFS file system. |
| BatchDiskCustomerManagedKey |
The Customer Managed Key reference to encrypt the Disk. |
| BatchDiskEncryptionConfiguration |
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image. |
| BatchEndpointAccessProfile |
Network access profile for Batch endpoint. |
| BatchEnvironmentSetting |
An environment variable to be set on a task process. |
| BatchFileShareConfiguration |
Information used to connect to an Azure Fileshare. |
| BatchHostEndpointSettings |
Specifies particular host endpoint settings. |
| BatchImageReference |
A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. |
| BatchInboundNatPool |
A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally. |
| BatchIPRule |
Rule to filter client IP address. |
| BatchIPTag |
Specifies how tasks should be distributed across compute nodes. |
| BatchKeyVaultReference |
Identifies the Azure key vault associated with a Batch account. |
| BatchLinuxUserConfiguration |
Properties used to create a user account on a Linux node. |
| BatchMountConfiguration |
The file system to mount on each node. |
| BatchNetworkConfiguration |
The network configuration for a pool. |
| BatchNetworkProfile |
Network profile for Batch account, which contains network rule settings for each endpoint. |
| BatchNetworkSecurityGroupRule |
A network security group rule to apply to an inbound endpoint. |
| BatchNfsMountConfiguration |
Information used to connect to an NFS file system. |
| BatchOSDisk |
Settings for the operating system disk of the virtual machine. |
| BatchPrivateEndpointConnection |
Contains information about a private link resource. |
| BatchPrivateEndpointConnection.ResourceVersions | |
| BatchPrivateLinkResource |
Contains information about a private link resource. |
| BatchPrivateLinkResource.ResourceVersions | |
| BatchPrivateLinkServiceConnectionState |
The private link service connection state of the private endpoint connection. |
| BatchProvisioningIssue |
Describes a provisioning issue for a network security perimeter configuration. |
| BatchProvisioningIssueProperties |
Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules. |
| BatchProxyAgentSettings |
Specifies ProxyAgent settings while creating the virtual machine. |
| BatchPublicIPAddressConfiguration |
The public IP Address configuration of the networking configuration of a Pool. |
| BatchResizeError |
An error that occurred when resizing a pool. |
| BatchResizeOperationStatus |
Details about the current or last completed resize operation. |
| BatchResourceAssociation |
Information about resource association. |
| BatchResourceFile |
A single file or multiple files to be downloaded to a compute node. |
| BatchSecurityProfile |
Specifies the security profile settings for the virtual machine or virtual machine scale set. |
| BatchTaskContainerSettings |
The container settings for a task. |
| BatchTaskSchedulingPolicy |
Specifies how tasks should be distributed across compute nodes. |
| BatchUefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
| BatchUserAccount |
Properties used to create a user on an Azure Batch node. |
| BatchUserIdentity |
The definition of the user identity under which the task is run. |
| BatchVmConfiguration |
The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. |
| BatchVmContainerConfiguration |
The configuration for container-enabled pools. |
| BatchVmContainerRegistry |
A private container registry. |
| BatchVmDataDisk |
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. |
| BatchVmExtension |
The configuration for virtual machine extensions. |
| BatchVmFamilyCoreQuota |
A VM Family and its associated core quota for the Batch account. |
| ContainerHostBatchBindMountEntry |
The entry of path and mount mode you want to mount into task container. |
| ManagedDisk |
The managed disk parameters. |
| NetworkSecurityPerimeter |
Information about a network security perimeter (NSP). |
| NetworkSecurityPerimeterConfiguration |
Network security perimeter (NSP) configuration resource. |
| NetworkSecurityPerimeterConfiguration.ResourceVersions | |
| NetworkSecurityPerimeterConfigurationProperties |
Network security configuration properties. |
| NetworkSecurityProfile |
Network security perimeter configuration profile. |
| RollingUpgradePolicy |
The configuration parameters used while performing a rolling upgrade. |
| UpgradePolicy |
Describes an upgrade policy - automatic, manual, or rolling. |
| VmDiskSecurityProfile |
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs. |
Enums
| Name | Description |
|---|---|
| BatchAccessRuleDirection |
Direction of Access Rule. |
| BatchAccountKeySource |
Type of the key source. |
| BatchAccountPoolAllocationMode |
The allocation mode for creating pools in the Batch account. |
| BatchAccountPoolAllocationState |
Whether the pool is resizing. |
| BatchAccountPoolProvisioningState |
The current state of the pool. |
| BatchApplicationPackageState |
The current state of the application package. |
| BatchAuthenticationMode |
The authentication mode for the Batch account. |
| BatchAutoStorageAuthenticationMode |
The authentication mode which the Batch service will use to manage the auto-storage account. |
| BatchAutoUserScope |
The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. |
| BatchContainerWorkingDirectory |
A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. |
| BatchDiffDiskPlacement |
The location where the OS disk should be placed. |
| BatchDiskCachingType |
The type of caching to enable for the disk. |
| BatchDiskEncryptionTarget |
If omitted, no disks on the compute nodes in the pool will be encrypted. |
| BatchEndpointAccessDefaultAction |
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. |
| BatchHostEndpointSettingsModeType |
Specifies the access control policy execution mode. |
| BatchInboundEndpointProtocol |
The protocol of the endpoint. |
| BatchIPAddressProvisioningType |
The provisioning type for Public IP Addresses for the Batch Pool. |
| BatchIPFamily |
The IP families used to specify IP versions available to the pool. |
| BatchIPRuleAction |
The action when client IP address is matched. |
| BatchIssueType |
Type of issue. |
| BatchJobDefaultOrder |
The order for scheduling tasks from different jobs with the same priority. |
| BatchNetworkSecurityGroupRuleAccess |
The action that should be taken for a specified IP address, subnet range or tag. |
| BatchNodeDeallocationOption |
Determines what to do with a node and its running task(s) after it has been selected for deallocation. |
| BatchNodeFillType |
How tasks should be distributed across compute nodes. |
| BatchNodePlacementPolicyType |
The default value is regional. |
| BatchPrivateEndpointConnectionProvisioningState |
The provisioning state of the private endpoint connection. |
| BatchPrivateLinkServiceConnectionStatus |
The status of the Batch private endpoint connection. |
| BatchProvisioningState |
The provisioned state of the resource. |
| BatchPublicNetworkAccess |
The network access type for operating on the resources in the Batch account. |
| BatchSecurityEncryptionType |
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs. |
| BatchSecurityType |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. |
| BatchSeverity |
Severity of the issue. |
| BatchStorageAccountType |
The storage account type for use in creating data disks or OS disk. |
| BatchUserAccountElevationLevel |
The elevation level of the user. |
| BatchVmContainerType |
The container technology to be used. |
| BatchWindowsLoginMode |
Specifies login mode for the user. The default value is Interactive. |
| ContainerHostDataPath |
The paths which will be mounted to container task's container. |
| DynamicVNetAssignmentScope |
The scope of dynamic vnet assignment. |
| InterNodeCommunicationState |
This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Provisioning state of a network security perimeter configuration that is being created or updated. |
| ResourceAssociationAccessMode |
Access mode of the resource association. |
| UpgradeMode |
Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> Automatic - All virtual machines in the scale set are automatically updated at the same time.<br /><br /> Rolling - Scale set performs updates in batches with an optional pause time in between. |