models Package
Classes
| AccessRule |
Access rule in a network security perimeter configuration profile. |
| AccessRuleProperties |
Properties of Access Rule. |
| AccessRulePropertiesSubscription |
AccessRulePropertiesSubscription. |
| ActivateApplicationPackageParameters |
Parameters for an activating an application package. |
| Application |
Contains information about an application in a Batch account. |
| ApplicationPackage |
An application package which represents a particular version of an application. |
| ApplicationPackageProperties |
Properties of an application package. |
| ApplicationPackageReference |
Link to an application package inside the batch account. |
| ApplicationProperties |
The properties associated with the Application. |
| AutoScaleRun |
The results and errors from an execution of a pool autoscale formula. |
| AutoScaleRunError |
An error that occurred when autoscaling a pool. |
| AutoScaleSettings |
AutoScale settings for the pool. |
| AutoStorageBaseProperties |
The properties related to the auto-storage account. |
| AutoStorageProperties |
Contains information about the auto-storage account associated with a Batch account. |
| 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. |
| AzureFileShareConfiguration |
Information used to connect to an Azure Fileshare. |
| AzureResource |
Tracked Resource. |
| BatchAccount |
Contains information about an Azure Batch account. |
| BatchAccountCreateParameters |
Parameters supplied to the Create operation. |
| BatchAccountCreateProperties |
The properties of a Batch account. |
| 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
|
| BatchAccountKeys |
A set of Azure Batch account keys. |
| BatchAccountProperties |
Account specific properties. |
| BatchAccountRegenerateKeyParameters |
Parameters supplied to the RegenerateKey operation. |
| BatchAccountUpdateParameters |
Parameters for updating an Azure Batch account. |
| BatchAccountUpdateProperties |
The properties of a Batch account. |
| BatchLocationQuota |
Quotas associated with a Batch region for a particular subscription. |
| 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. |
| CIFSMountConfiguration |
Information used to connect to a CIFS file system. |
| CheckNameAvailabilityParameters |
Parameters for a check name availability request. |
| CheckNameAvailabilityResult |
The CheckNameAvailability operation response. |
| CloudError |
An error response from the Batch service. |
| 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. |
| 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. |
| DeploymentConfiguration |
Deployment configuration properties. |
| DetectorResponse |
Contains the information for a detector. |
| DetectorResponseProperties |
Detector response properties. |
| DiffDiskSettings |
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. |
| DiskCustomerManagedKey |
The Customer Managed Key reference to encrypt the Disk. |
| 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. |
| DiskEncryptionSetParameters |
The ARM resource id of the disk encryption set. |
| 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. |
| EndpointDependency |
A domain name and connection details used to access a dependency. |
| EndpointDetail |
Details about the connection between the Batch service and the endpoint. |
| EnvironmentSetting |
An environment variable to be set on a task process. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Error response. |
| FixedScaleSettings |
Fixed scale settings for the pool. |
| HostEndpointSettings |
Specifies particular host endpoint settings. |
| IPRule |
Rule to filter client IP address. |
| IPTag |
Specifies how tasks should be distributed across compute nodes. |
| 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. |
| KeyVaultProperties |
KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. |
| KeyVaultReference |
Identifies the Azure key vault associated with a Batch account. |
| LinuxUserConfiguration |
Properties used to create a user account on a Linux node. |
| ManagedDisk |
The managed disk parameters. |
| MetadataItem |
A name-value pair associated with a Batch service resource. |
| MountConfiguration |
The file system to mount on each node. |
| NFSMountConfiguration |
Information used to connect to an NFS file system. |
| 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. |
| NetworkSecurityPerimeter |
Information about a network security perimeter (NSP). |
| NetworkSecurityPerimeterConfiguration |
Network security perimeter (NSP) configuration resource. |
| NetworkSecurityPerimeterConfigurationProperties |
Network security configuration properties. |
| NetworkSecurityProfile |
Network security perimeter configuration profile. |
| NodePlacementConfiguration |
Node placement configuration for Batch pools. |
| OSDisk |
Settings for the operating system disk of the virtual machine. |
| Operation |
A REST API operation. |
| OperationDisplay |
The object that describes the operation. |
| OutboundEnvironmentEndpoint |
A collection of related endpoints from the same service for which the Batch service requires outbound access. |
| Pool |
Contains information about a pool. |
| PoolEndpointConfiguration |
The endpoint configuration for a pool. |
| PoolProperties |
Pool properties. |
| PrivateEndpoint |
The private endpoint of the private endpoint connection. |
| PrivateEndpointConnection |
Contains information about a private link resource. |
| PrivateEndpointConnectionProperties |
Private endpoint connection properties. |
| PrivateLinkResource |
Contains information about a private link resource. |
| PrivateLinkResourceProperties |
Private link resource properties. |
| PrivateLinkServiceConnectionState |
The private link service connection state of the private endpoint connection. |
| ProvisioningIssue |
Describes a provisioning issue for a network security perimeter configuration. |
| 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. |
| ProxyAgentSettings |
Specifies ProxyAgent settings while creating the virtual machine. |
| ProxyResource |
Proxy Resource. |
| PublicIPAddressConfiguration |
The public IP Address configuration of the networking configuration of a Pool. |
| ResizeError |
An error that occurred when resizing a pool. |
| ResizeOperationStatus |
Details about the current or last completed resize operation. |
| Resource |
Resource. |
| 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 |
Scale settings for the pool. |
| 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. |
| SkuCapability |
A SKU capability, such as the number of cores. |
| StartTask |
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. |
| SupportedSku |
Describes a Batch supported SKU. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TaskContainerSettings |
The container settings for a task. |
| TaskSchedulingPolicy |
Specifies how tasks should be distributed across compute nodes. |
| 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. |
| UserAccount |
Properties used to create a user on an Azure Batch node. |
| UserAssignedIdentities |
The list of associated user identities. |
| UserIdentity |
The definition of the user identity under which the task is run. |
| 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. |
| VirtualMachineConfiguration |
The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. |
| VirtualMachineFamilyCoreQuota |
A VM Family and its associated core quota for the Batch account. |
| 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. |
| CachingType |
The type of caching to enable for the disk. |
| 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 kind of entity that created the resource. |
| DiffDiskPlacement |
The location where the OS disk should be placed. |
| DiskEncryptionTarget |
The disks to encrypt on each compute node. |
| 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. |
| HostEndpointSettingsModeTypes |
Specifies the access control policy execution mode. |
| IPAddressProvisioningType |
The provisioning type for Public IP Addresses for the Batch Pool. |
| IPFamily |
The IP families used to specify IP versions available to the pool. |
| IPRuleAction |
The action when client IP address is matched. |
| 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. |
| JobDefaultOrder |
The order for scheduling tasks from different jobs with the same priority. |
| 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. |
| 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. |
| ResourceType |
The result of the request to list operations. |
| SecurityEncryptionTypes |
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. |
| 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. |