models Package

Classes

AccessRule	Access rule in a network security perimeter configuration profile.
AccessRuleProperties	Properties of Access Rule.
AccessRulePropertiesSubscriptionsItem	Subscription identifiers.
ActivateApplicationPackageParameters	Parameters for an activating an application package. All required parameters must be populated in order to send to server.
Application	Contains information about an application in a Batch account. Variables are only populated by the server, and will be ignored when sending a request.
ApplicationPackage	An application package which represents a particular version of an application. Variables are only populated by the server, and will be ignored when sending a request.
ApplicationPackageReference	Link to an application package inside the batch account. All required parameters must be populated in order to send to server.
AutoScaleRun	The results and errors from an execution of a pool autoscale formula. All required parameters must be populated in order to send to server.
AutoScaleRunError	An error that occurred when autoscaling a pool. All required parameters must be populated in order to send to server.
AutoScaleSettings	AutoScale settings for the pool. All required parameters must be populated in order to send to server.
AutoStorageBaseProperties	The properties related to the auto-storage account. All required parameters must be populated in order to send to server.
AutoStorageProperties	Contains information about the auto-storage account associated with a Batch account. All required parameters must be populated in order to send to server.
AutoUserSpecification	Specifies the parameters for the auto user that runs a task on the Batch service.
AutomaticOSUpgradePolicy	The configuration parameters used for performing automatic OS upgrade.
AzureBlobFileSystemConfiguration	Information used to connect to an Azure Storage Container using Blobfuse. All required parameters must be populated in order to send to server.
AzureFileShareConfiguration	Information used to connect to an Azure Fileshare. All required parameters must be populated in order to send to server.
AzureProxyResource	A definition of an Azure resource. Variables are only populated by the server, and will be ignored when sending a request.
AzureResource	A definition of an Azure resource. Variables are only populated by the server, and will be ignored when sending a request.
BatchAccount	Contains information about an Azure Batch account. Variables are only populated by the server, and will be ignored when sending a request.
BatchAccountCreateParameters	Parameters supplied to the Create operation. All required parameters must be populated in order to send to server.
BatchAccountIdentity	The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
BatchAccountKeys	A set of Azure Batch account keys. Variables are only populated by the server, and will be ignored when sending a request.
BatchAccountListResult	Values returned by the List operation.
BatchAccountRegenerateKeyParameters	Parameters supplied to the RegenerateKey operation. All required parameters must be populated in order to send to server.
BatchAccountUpdateParameters	Parameters for updating an Azure Batch account.
BatchLocationQuota	Quotas associated with a Batch region for a particular subscription. Variables are only populated by the server, and will be ignored when sending a request.
BatchPoolIdentity	The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities. All required parameters must be populated in order to send to server.
CIFSMountConfiguration	Information used to connect to a CIFS file system. All required parameters must be populated in order to send to server.
Certificate	Contains information about a certificate. Variables are only populated by the server, and will be ignored when sending a request.
CertificateBaseProperties	Base certificate properties.
CertificateCreateOrUpdateParameters	Contains information about a certificate. Variables are only populated by the server, and will be ignored when sending a request.
CertificateCreateOrUpdateProperties	Certificate properties for create operations. All required parameters must be populated in order to send to server.
CertificateProperties	Certificate properties. Variables are only populated by the server, and will be ignored when sending a request.
CertificateReference	Warning: This object is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. All required parameters must be populated in order to send to server.
CheckNameAvailabilityParameters	Parameters for a check name availability request. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
CheckNameAvailabilityResult	The CheckNameAvailability operation response. Variables are only populated by the server, and will be ignored when sending a request.
CloudErrorBody	An error response from the Batch service.
ComputeNodeIdentityReference	The reference to a user assigned identity associated with the Batch pool which a compute node will use.
ContainerConfiguration	The configuration for container-enabled pools. All required parameters must be populated in order to send to server.
ContainerHostBatchBindMountEntry	The entry of path and mount mode you want to mount into task container.
ContainerRegistry	A private container registry.
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. All required parameters must be populated in order to send to server.
DeleteCertificateError	An error response from the Batch service. All required parameters must be populated in order to send to server.
DeploymentConfiguration	Deployment configuration properties.
DetectorListResult	Values returned by the List operation.
DetectorResponse	Contains the information for a detector. Variables are only populated by the server, and will be ignored when sending a request.
DiffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
DiskEncryptionConfiguration	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.
EncryptionProperties	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.
EndpointAccessProfile	Network access profile for Batch endpoint. All required parameters must be populated in order to send to server.
EndpointDependency	A domain name and connection details used to access a dependency. Variables are only populated by the server, and will be ignored when sending a request.
EndpointDetail	Details about the connection between the Batch service and the endpoint. Variables are only populated by the server, and will be ignored when sending a request.
EnvironmentSetting	An environment variable to be set on a task process. All required parameters must be populated in order to send to server.
ErrorAdditionalInfo	The resource management error additional info. Variables are only populated by the server, and will be ignored when sending a request.
ErrorDetail	The error detail. Variables are only populated by the server, and will be ignored when sending a request.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
FixedScaleSettings	Fixed scale settings for the pool.
IPRule	Rule to filter client IP address. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
ImageReference	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.
InboundNatPool	A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally. All required parameters must be populated in order to send to server.
KeyVaultProperties	KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
KeyVaultReference	Identifies the Azure key vault associated with a Batch account. All required parameters must be populated in order to send to server.
LinuxUserConfiguration	Properties used to create a user account on a Linux node.
ListApplicationPackagesResult	The result of performing list application packages.
ListApplicationsResult	The result of performing list applications.
ListCertificatesResult	Values returned by the List operation.
ListPoolsResult	Values returned by the List operation.
ListPrivateEndpointConnectionsResult	Values returned by the List operation.
ListPrivateLinkResourcesResult	Values returned by the List operation.
ManagedDisk	ManagedDisk.
MetadataItem	The Batch service does not assign any meaning to this metadata; it is solely for the use of user code. All required parameters must be populated in order to send to server.
MountConfiguration	The file system to mount on each node.
NFSMountConfiguration	Information used to connect to an NFS file system. All required parameters must be populated in order to send to server.
NetworkConfiguration	The network configuration for a pool.
NetworkProfile	Network profile for Batch account, which contains network rule settings for each endpoint.
NetworkSecurityGroupRule	A network security group rule to apply to an inbound endpoint. All required parameters must be populated in order to send to server.
NetworkSecurityPerimeter	Information about a network security perimeter (NSP).
NetworkSecurityPerimeterConfiguration	Network security perimeter (NSP) configuration resource. Variables are only populated by the server, and will be ignored when sending a request.
NetworkSecurityPerimeterConfigurationListResult	Result of a list NSP (network security perimeter) configurations request.
NetworkSecurityPerimeterConfigurationProperties	Network security configuration properties. Variables are only populated by the server, and will be ignored when sending a request.
NetworkSecurityProfile	Network security perimeter configuration profile.
NodePlacementConfiguration	Allocation configuration used by Batch Service to provision the nodes.
OSDisk	Settings for the operating system disk of the virtual machine.
Operation	A REST API operation.
OperationDisplay	The object that describes the operation.
OperationListResult	Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.
OutboundEnvironmentEndpoint	A collection of related endpoints from the same service for which the Batch service requires outbound access. Variables are only populated by the server, and will be ignored when sending a request.
OutboundEnvironmentEndpointCollection	Values returned by the List operation. Variables are only populated by the server, and will be ignored when sending a request.
Pool	Contains information about a pool. Variables are only populated by the server, and will be ignored when sending a request.
PoolEndpointConfiguration	The endpoint configuration for a pool. All required parameters must be populated in order to send to server.
PrivateEndpoint	The private endpoint of the private endpoint connection. Variables are only populated by the server, and will be ignored when sending a request.
PrivateEndpointConnection	Contains information about a private link resource. Variables are only populated by the server, and will be ignored when sending a request.
PrivateLinkResource	Contains information about a private link resource. Variables are only populated by the server, and will be ignored when sending a request.
PrivateLinkServiceConnectionState	The private link service connection state of the private endpoint connection. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
ProvisioningIssue	Describes a provisioning issue for a network security perimeter configuration. Variables are only populated by the server, and will be ignored when sending a request.
ProvisioningIssueProperties	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. Variables are only populated by the server, and will be ignored when sending a request.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location. Variables are only populated by the server, and will be ignored when sending a request.
PublicIPAddressConfiguration	The public IP Address configuration of the networking configuration of a Pool.
ResizeError	An error that occurred when resizing a pool. All required parameters must be populated in order to send to server.
ResizeOperationStatus	Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
Resource	Common fields that are returned in the response for all Azure Resource Manager resources. Variables are only populated by the server, and will be ignored when sending a request.
ResourceAssociation	Information about resource association.
ResourceFile	A single file or multiple files to be downloaded to a compute node.
RollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.
ScaleSettings	Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.
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. All required parameters must be populated in order to send to server.
SkuCapability	A SKU capability, such as the number of cores. Variables are only populated by the server, and will be ignored when sending a request.
StartTask	In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.
SupportedSku	Describes a Batch supported SKU. Variables are only populated by the server, and will be ignored when sending a request.
SupportedSkusResult	The Batch List supported SKUs operation response. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
SystemData	Metadata pertaining to creation and last modification of the resource.
TaskContainerSettings	The container settings for a task. All required parameters must be populated in order to send to server.
TaskSchedulingPolicy	Specifies how tasks should be distributed across compute nodes. All required parameters must be populated in order to send to server.
UefiSettings	Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
UpgradePolicy	Describes an upgrade policy - automatic, manual, or rolling. All required parameters must be populated in order to send to server.
UserAccount	Properties used to create a user on an Azure Batch node. All required parameters must be populated in order to send to server.
UserAssignedIdentities	The list of associated user identities. Variables are only populated by the server, and will be ignored when sending a request.
UserIdentity	Specify either the userName or autoUser property, but not both.
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.
VMExtension	The configuration for virtual machine extensions. All required parameters must be populated in order to send to server.
VirtualMachineConfiguration	The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. All required parameters must be populated in order to send to server.
VirtualMachineFamilyCoreQuota	A VM Family and its associated core quota for the Batch account. Variables are only populated by the server, and will be ignored when sending a request.
WindowsConfiguration	Windows operating system settings to apply to the virtual machine.
WindowsUserConfiguration	Properties used to create a user account on a Windows node.

Enums

AccessRuleDirection	Direction of Access Rule.
AccountKeyType	The type of account key to regenerate.
AllocationState	Whether the pool is resizing.
AuthenticationMode	The authentication mode for the Batch account.
AutoStorageAuthenticationMode	The authentication mode which the Batch service will use to manage the auto-storage account.
AutoUserScope	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, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.
CachingType	The type of caching to enable for the disk.
CertificateFormat	The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.
CertificateProvisioningState	CertificateProvisioningState.
CertificateStoreLocation	The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
CertificateVisibility	CertificateVisibility.
ComputeNodeDeallocationOption	Determines what to do with a node and its running task(s) after it has been selected for deallocation.
ComputeNodeFillType	How tasks should be distributed across compute nodes.
ContainerHostDataPath	The paths which will be mounted to container task's container.
ContainerType	The container technology to be used.
ContainerWorkingDirectory	A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.
CreatedByType	The type of identity that created the resource.
DiskEncryptionTarget	If omitted, no disks on the compute nodes in the pool will be encrypted.
DynamicVNetAssignmentScope	The scope of dynamic vnet assignment.
ElevationLevel	The elevation level of the user.
EndpointAccessDefaultAction	Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
IPAddressProvisioningType	The provisioning type for Public IP Addresses for the Batch Pool.
InboundEndpointProtocol	The protocol of the endpoint.
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'.
IssueType	Type of issue.
KeySource	Type of the key source.
LoginMode	Specifies login mode for the user. The default value is Interactive.
NameAvailabilityReason	Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.
NetworkSecurityGroupRuleAccess	The action that should be taken for a specified IP address, subnet range or tag.
NetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of a network security perimeter configuration that is being created or updated.
NodeCommunicationMode	Determines how a pool communicates with the Batch service.
NodePlacementPolicyType	The default value is regional.
PackageState	The current state of the application package.
PoolAllocationMode	The allocation mode for creating pools in the Batch account.
PoolIdentityType	The type of identity used for the Batch Pool.
PoolProvisioningState	The current state of the pool.
PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection.
PrivateLinkServiceConnectionStatus	The status of the Batch private endpoint connection.
ProvisioningState	The provisioned state of the resource.
PublicNetworkAccessType	The network access type for operating on the resources in the Batch account.
ResourceAssociationAccessMode	Access mode of the resource association.
ResourceIdentityType	The type of identity used for the Batch account.
SecurityEncryptionTypes	Specifies the EncryptionType of the managed disk. It is set to 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.
SecurityTypes	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
Severity	Severity of the issue.
StorageAccountType	The storage account type for use in creating data disks or OS disk.
UpgradeMode	Specifies the mode of an upgrade to virtual machines in the scale set.:code: <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.:code: <br /> Automatic - All virtual machines in the scale set are automatically updated at the same time.:code: <br /> Rolling - Scale set performs updates in batches with an optional pause time in between.