batch.azure.com/v20240701
APIVersion
| Value | Description |
|---|---|
| “2024-07-01” |
BatchAccount
Generator information: - Generated from: /batch/resource-manager/Microsoft.Batch/stable/2024-07-01/BatchManagement.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}
Used by: BatchAccountList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | BatchAccount_Spec Optional |
|
| status | BatchAccount_STATUS Optional |
BatchAccount_Spec
| Property | Description | Type |
|---|---|---|
| allowedAuthenticationModes | List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. | AuthenticationMode[] Optional |
| autoStorage | The properties related to the auto-storage account. | AutoStorageBaseProperties Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| encryption | 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. | EncryptionProperties Optional |
| identity | The identity of the Batch account. | BatchAccountIdentity Optional |
| keyVaultReference | A reference to the Azure key vault associated with the Batch account. | KeyVaultReference Optional |
| location | The region in which to create the account. | string Required |
| networkProfile | The network profile only takes effect when publicNetworkAccess is enabled. | NetworkProfile Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BatchAccountOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| poolAllocationMode | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService. | PoolAllocationMode Optional |
| publicNetworkAccess | If not specified, the default value is enabled. |
PublicNetworkAccessType Optional |
| tags | The user-specified tags associated with the account. | map[string]string Optional |
BatchAccount_STATUS
| Property | Description | Type |
|---|---|---|
| accountEndpoint | The account endpoint used to interact with the Batch service. | string Optional |
| activeJobAndJobScheduleQuota | int Optional |
|
| allowedAuthenticationModes | List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. | AuthenticationMode_STATUS[] Optional |
| autoStorage | Contains information about the auto-storage account associated with a Batch account. | AutoStorageProperties_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dedicatedCoreQuota | For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. | int Optional |
| dedicatedCoreQuotaPerVMFamily | A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. | VirtualMachineFamilyCoreQuota_STATUS[] Optional |
| dedicatedCoreQuotaPerVMFamilyEnforced | If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family. | bool Optional |
| encryption | 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. | EncryptionProperties_STATUS Optional |
| id | The ID of the resource. | string Optional |
| identity | The identity of the Batch account. | BatchAccountIdentity_STATUS Optional |
| keyVaultReference | Identifies the Azure key vault associated with a Batch account. | KeyVaultReference_STATUS Optional |
| location | The location of the resource. | string Optional |
| lowPriorityCoreQuota | For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. | int Optional |
| name | The name of the resource. | string Optional |
| networkProfile | The network profile only takes effect when publicNetworkAccess is enabled. | NetworkProfile_STATUS Optional |
| nodeManagementEndpoint | The endpoint used by compute node to connect to the Batch node management service. | string Optional |
| poolAllocationMode | The allocation mode for creating pools in the Batch account. | PoolAllocationMode_STATUS Optional |
| poolQuota | int Optional |
|
| privateEndpointConnections | List of private endpoint connections associated with the Batch account | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | The provisioned state of the resource | BatchAccountProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | If not specified, the default value is enabled. |
PublicNetworkAccessType_STATUS Optional |
| tags | The tags of the resource. | map[string]string Optional |
| type | The type of the resource. | string Optional |
BatchAccountList
Generator information: - Generated from: /batch/resource-manager/Microsoft.Batch/stable/2024-07-01/BatchManagement.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | BatchAccount[] Optional |
BatchAccount_Spec
Used by: BatchAccount.
| Property | Description | Type |
|---|---|---|
| allowedAuthenticationModes | List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. | AuthenticationMode[] Optional |
| autoStorage | The properties related to the auto-storage account. | AutoStorageBaseProperties Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| encryption | 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. | EncryptionProperties Optional |
| identity | The identity of the Batch account. | BatchAccountIdentity Optional |
| keyVaultReference | A reference to the Azure key vault associated with the Batch account. | KeyVaultReference Optional |
| location | The region in which to create the account. | string Required |
| networkProfile | The network profile only takes effect when publicNetworkAccess is enabled. | NetworkProfile Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BatchAccountOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| poolAllocationMode | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService. | PoolAllocationMode Optional |
| publicNetworkAccess | If not specified, the default value is enabled. |
PublicNetworkAccessType Optional |
| tags | The user-specified tags associated with the account. | map[string]string Optional |
BatchAccount_STATUS
Contains information about an Azure Batch account.
Used by: BatchAccount.
| Property | Description | Type |
|---|---|---|
| accountEndpoint | The account endpoint used to interact with the Batch service. | string Optional |
| activeJobAndJobScheduleQuota | int Optional |
|
| allowedAuthenticationModes | List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. | AuthenticationMode_STATUS[] Optional |
| autoStorage | Contains information about the auto-storage account associated with a Batch account. | AutoStorageProperties_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dedicatedCoreQuota | For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. | int Optional |
| dedicatedCoreQuotaPerVMFamily | A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. | VirtualMachineFamilyCoreQuota_STATUS[] Optional |
| dedicatedCoreQuotaPerVMFamilyEnforced | If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family. | bool Optional |
| encryption | 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. | EncryptionProperties_STATUS Optional |
| id | The ID of the resource. | string Optional |
| identity | The identity of the Batch account. | BatchAccountIdentity_STATUS Optional |
| keyVaultReference | Identifies the Azure key vault associated with a Batch account. | KeyVaultReference_STATUS Optional |
| location | The location of the resource. | string Optional |
| lowPriorityCoreQuota | For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. | int Optional |
| name | The name of the resource. | string Optional |
| networkProfile | The network profile only takes effect when publicNetworkAccess is enabled. | NetworkProfile_STATUS Optional |
| nodeManagementEndpoint | The endpoint used by compute node to connect to the Batch node management service. | string Optional |
| poolAllocationMode | The allocation mode for creating pools in the Batch account. | PoolAllocationMode_STATUS Optional |
| poolQuota | int Optional |
|
| privateEndpointConnections | List of private endpoint connections associated with the Batch account | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | The provisioned state of the resource | BatchAccountProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | If not specified, the default value is enabled. |
PublicNetworkAccessType_STATUS Optional |
| tags | The tags of the resource. | map[string]string Optional |
| type | The type of the resource. | string Optional |
AuthenticationMode
The authentication mode for the Batch account.
Used by: BatchAccount_Spec.
| Value | Description |
|---|---|
| “AAD” | |
| “SharedKey” | |
| “TaskAuthenticationToken” |
AuthenticationMode_STATUS
The authentication mode for the Batch account.
Used by: BatchAccount_STATUS.
| Value | Description |
|---|---|
| “AAD” | |
| “SharedKey” | |
| “TaskAuthenticationToken” |
AutoStorageBaseProperties
The properties related to the auto-storage account.
Used by: BatchAccount_Spec.
| Property | Description | Type |
|---|---|---|
| authenticationMode | The authentication mode which the Batch service will use to manage the auto-storage account. | AutoStorageBaseProperties_AuthenticationMode Optional |
| nodeIdentityReference | The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage. | ComputeNodeIdentityReference Optional |
| storageAccountReference | The resource ID of the storage account to be used for auto-storage account. | genruntime.ResourceReference Required |
AutoStorageProperties_STATUS
Contains information about the auto-storage account associated with a Batch account.
Used by: BatchAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationMode | The authentication mode which the Batch service will use to manage the auto-storage account. | AutoStorageProperties_AuthenticationMode_STATUS Optional |
| lastKeySync | The UTC time at which storage keys were last synchronized with the Batch account. | string Optional |
| nodeIdentityReference | The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage. | ComputeNodeIdentityReference_STATUS Optional |
| storageAccountId | The resource ID of the storage account to be used for auto-storage account. | string Optional |
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.
Used by: BatchAccount_Spec.
| Property | Description | Type |
|---|---|---|
| type | The type of identity used for the Batch account. | BatchAccountIdentity_Type Required |
| userAssignedIdentities | The list of user identities associated with the Batch account. | UserAssignedIdentityDetails[] Optional |
BatchAccountIdentity_STATUS
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.
Used by: BatchAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal id of the Batch account. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. | string Optional |
| type | The type of identity used for the Batch account. | BatchAccountIdentity_Type_STATUS Optional |
| userAssignedIdentities | The list of user identities associated with the Batch account. | map[string]UserAssignedIdentities_STATUS Optional |
BatchAccountOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: BatchAccount_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
BatchAccountProperties_ProvisioningState_STATUS
Used by: BatchAccount_STATUS.
| Value | Description |
|---|---|
| “Cancelled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Invalid” | |
| “Succeeded” |
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.
Used by: BatchAccount_Spec.
| Property | Description | Type |
|---|---|---|
| keySource | Type of the key source. | EncryptionProperties_KeySource Optional |
| keyVaultProperties | Additional details when using Microsoft.KeyVault | KeyVaultProperties Optional |
EncryptionProperties_STATUS
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.
Used by: BatchAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| keySource | Type of the key source. | EncryptionProperties_KeySource_STATUS Optional |
| keyVaultProperties | Additional details when using Microsoft.KeyVault | KeyVaultProperties_STATUS Optional |
KeyVaultReference
Identifies the Azure key vault associated with a Batch account.
Used by: BatchAccount_Spec.
| Property | Description | Type |
|---|---|---|
| reference | The resource ID of the Azure key vault associated with the Batch account. | genruntime.ResourceReference Required |
| url | The URL of the Azure key vault associated with the Batch account. | string Required |
KeyVaultReference_STATUS
Identifies the Azure key vault associated with a Batch account.
Used by: BatchAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The resource ID of the Azure key vault associated with the Batch account. | string Optional |
| url | The URL of the Azure key vault associated with the Batch account. | string Optional |
NetworkProfile
Network profile for Batch account, which contains network rule settings for each endpoint.
Used by: BatchAccount_Spec.
| Property | Description | Type |
|---|---|---|
| accountAccess | Network access profile for batchAccount endpoint (Batch account data plane API). | EndpointAccessProfile Optional |
| nodeManagementAccess | Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). | EndpointAccessProfile Optional |
NetworkProfile_STATUS
Network profile for Batch account, which contains network rule settings for each endpoint.
Used by: BatchAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| accountAccess | Network access profile for batchAccount endpoint (Batch account data plane API). | EndpointAccessProfile_STATUS Optional |
| nodeManagementAccess | Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). | EndpointAccessProfile_STATUS Optional |
PoolAllocationMode
The allocation mode for creating pools in the Batch account.
Used by: BatchAccount_Spec.
| Value | Description |
|---|---|
| “BatchService” | |
| “UserSubscription” |
PoolAllocationMode_STATUS
The allocation mode for creating pools in the Batch account.
Used by: BatchAccount_STATUS.
| Value | Description |
|---|---|
| “BatchService” | |
| “UserSubscription” |
PrivateEndpointConnection_STATUS
Contains information about a private link resource.
Used by: BatchAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The ID of the resource. | string Optional |
PublicNetworkAccessType
The network access type for operating on the resources in the Batch account.
Used by: BatchAccount_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
PublicNetworkAccessType_STATUS
The network access type for operating on the resources in the Batch account.
Used by: BatchAccount_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
VirtualMachineFamilyCoreQuota_STATUS
A VM Family and its associated core quota for the Batch account.
Used by: BatchAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| coreQuota | The core quota for the VM family for the Batch account. | int Optional |
| name | The Virtual Machine family name. | string Optional |
AutoStorageBaseProperties_AuthenticationMode
Used by: AutoStorageBaseProperties.
| Value | Description |
|---|---|
| “BatchAccountManagedIdentity” | |
| “StorageKeys” |
AutoStorageProperties_AuthenticationMode_STATUS
Used by: AutoStorageProperties_STATUS.
| Value | Description |
|---|---|
| “BatchAccountManagedIdentity” | |
| “StorageKeys” |
BatchAccountIdentity_Type
Used by: BatchAccountIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “UserAssigned” |
BatchAccountIdentity_Type_STATUS
Used by: BatchAccountIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “UserAssigned” |
ComputeNodeIdentityReference
The reference to a user assigned identity associated with the Batch pool which a compute node will use.
Used by: AutoStorageBaseProperties.
| Property | Description | Type |
|---|---|---|
| resourceReference | The ARM resource id of the user assigned identity. | genruntime.ResourceReference Optional |
ComputeNodeIdentityReference_STATUS
The reference to a user assigned identity associated with the Batch pool which a compute node will use.
Used by: AutoStorageProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| resourceId | The ARM resource id of the user assigned identity. | string Optional |
EncryptionProperties_KeySource
Used by: EncryptionProperties.
| Value | Description |
|---|---|
| “Microsoft.Batch” | |
| “Microsoft.KeyVault” |
EncryptionProperties_KeySource_STATUS
Used by: EncryptionProperties_STATUS.
| Value | Description |
|---|---|
| “Microsoft.Batch” | |
| “Microsoft.KeyVault” |
EndpointAccessProfile
Network access profile for Batch endpoint.
Used by: NetworkProfile, and NetworkProfile.
| Property | Description | Type |
|---|---|---|
| defaultAction | Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. | EndpointAccessProfile_DefaultAction Required |
| ipRules | Array of IP ranges to filter client IP address. | IPRule[] Optional |
EndpointAccessProfile_STATUS
Network access profile for Batch endpoint.
Used by: NetworkProfile_STATUS, and NetworkProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| defaultAction | Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. | EndpointAccessProfile_DefaultAction_STATUS Optional |
| ipRules | Array of IP ranges to filter client IP address. | IPRule_STATUS[] Optional |
KeyVaultProperties
KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
Used by: EncryptionProperties.
| Property | Description | Type |
|---|---|---|
| keyIdentifier | Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met: The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled | string Optional |
KeyVaultProperties_STATUS
KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
Used by: EncryptionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| keyIdentifier | Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met: The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled | string Optional |
UserAssignedIdentities_STATUS
The list of associated user identities.
Used by: BatchAccountIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client id of user assigned identity. | string Optional |
| principalId | The principal id of user assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: BatchAccountIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
EndpointAccessProfile_DefaultAction
Used by: EndpointAccessProfile.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
EndpointAccessProfile_DefaultAction_STATUS
Used by: EndpointAccessProfile_STATUS.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
IPRule
Rule to filter client IP address.
Used by: EndpointAccessProfile.
| Property | Description | Type |
|---|---|---|
| action | Action when client IP address is matched. | IPRule_Action Required |
| value | IPv4 address, or IPv4 address range in CIDR format. | string Required |
IPRule_STATUS
Rule to filter client IP address.
Used by: EndpointAccessProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| action | Action when client IP address is matched. | IPRule_Action_STATUS Optional |
| value | IPv4 address, or IPv4 address range in CIDR format. | string Optional |
IPRule_Action
Used by: IPRule.
| Value | Description |
|---|---|
| “Allow” |
IPRule_Action_STATUS
Used by: IPRule_STATUS.
| Value | Description |
|---|---|
| “Allow” |