batch.azure.com/v1api20210101

Package v1api20210101 contains API Schema definitions for the batch v1api20210101 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-01-01"

AutoStorageBaseProperties

(Appears on:BatchAccount_Spec)

The properties related to the auto-storage account.

Field	Description
`storageAccountReference` genruntime.ResourceReference	StorageAccountReference: The resource ID of the storage account to be used for auto-storage account.

AutoStorageProperties_STATUS

(Appears on:BatchAccount_STATUS)

Contains information about the auto-storage account associated with a Batch account.

Field	Description
`lastKeySync` string	LastKeySync: The UTC time at which storage keys were last synchronized with the Batch account.
`storageAccountId` string	StorageAccountId: The resource ID of the storage account to be used for auto-storage account.

BatchAccount

Generator information: - Generated from: /batch/resource-manager/Microsoft.Batch/stable/2021-01-01/BatchManagement.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
BatchAccount_Spec

`autoStorage` AutoStorageBaseProperties	AutoStorage: The properties related to the auto-storage account.
`azureName` string	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.
`encryption` EncryptionProperties	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.
`identity` BatchAccountIdentity	Identity: The identity of the Batch account.
`keyVaultReference` KeyVaultReference	KeyVaultReference: A reference to the Azure key vault associated with the Batch account.
`location` string	Location: The region in which to create the account.
`operatorSpec` BatchAccountOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`poolAllocationMode` PoolAllocationMode	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 Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.
`publicNetworkAccess` PublicNetworkAccessType	PublicNetworkAccess: If not specified, the default value is ‘enabled’.
`tags` map[string]string	Tags: The user-specified tags associated with the account.

status
BatchAccount_STATUS

BatchAccountIdentity

(Appears on:BatchAccount_Spec)

The identity of the Batch account, if configured. This is only used when the user specifies ‘Microsoft.KeyVault’ as their Batch account encryption configuration.

Field	Description
`type` BatchAccountIdentity_Type	Type: The type of identity used for the Batch account.
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

BatchAccountIdentity_STATUS

(Appears on:BatchAccount_STATUS)

The identity of the Batch account, if configured. This is only used when the user specifies ‘Microsoft.KeyVault’ as their Batch account encryption configuration.

Field	Description
`principalId` string	PrincipalId: The principal id of the Batch account. This property will only be provided for a system assigned identity.
`tenantId` string	TenantId: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
`type` BatchAccountIdentity_Type_STATUS	Type: The type of identity used for the Batch account.
`userAssignedIdentities` map[string]./api/batch/v1api20210101.BatchAccountIdentity_UserAssignedIdentities_STATUS	UserAssignedIdentities: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

BatchAccountIdentity_Type (`string` alias)

(Appears on:BatchAccountIdentity)

Value	Description
"None"
"SystemAssigned"
"UserAssigned"

BatchAccountIdentity_Type_STATUS (`string` alias)

(Appears on:BatchAccountIdentity_STATUS)

Value	Description
"None"
"SystemAssigned"
"UserAssigned"

BatchAccountIdentity_UserAssignedIdentities_STATUS

(Appears on:BatchAccountIdentity_STATUS)

Field	Description
`clientId` string	ClientId: The client id of user assigned identity.
`principalId` string	PrincipalId: The principal id of user assigned identity.

BatchAccountOperatorSpec

(Appears on:BatchAccount_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

BatchAccountProperties_ProvisioningState_STATUS (`string` alias)

(Appears on:BatchAccount_STATUS)

Value	Description
"Cancelled"
"Creating"
"Deleting"
"Failed"
"Invalid"
"Succeeded"

BatchAccount_STATUS

(Appears on:BatchAccount)

Contains information about an Azure Batch account.

Field	Description
`accountEndpoint` string	AccountEndpoint: The account endpoint used to interact with the Batch service.
`activeJobAndJobScheduleQuota` int
`autoStorage` AutoStorageProperties_STATUS	AutoStorage: Contains information about the auto-storage account associated with a Batch account.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`dedicatedCoreQuota` int	DedicatedCoreQuota: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
`dedicatedCoreQuotaPerVMFamily` []VirtualMachineFamilyCoreQuota_STATUS	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.
`dedicatedCoreQuotaPerVMFamilyEnforced` bool	DedicatedCoreQuotaPerVMFamilyEnforced: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
`encryption` EncryptionProperties_STATUS	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.
`id` string	Id: The ID of the resource.
`identity` BatchAccountIdentity_STATUS	Identity: The identity of the Batch account.
`keyVaultReference` KeyVaultReference_STATUS	KeyVaultReference: Identifies the Azure key vault associated with a Batch account.
`location` string	Location: The location of the resource.
`lowPriorityCoreQuota` int	LowPriorityCoreQuota: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
`name` string	Name: The name of the resource.
`poolAllocationMode` PoolAllocationMode_STATUS	PoolAllocationMode: The allocation mode for creating pools in the Batch account.
`poolQuota` int
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: List of private endpoint connections associated with the Batch account
`provisioningState` BatchAccountProperties_ProvisioningState_STATUS	ProvisioningState: The provisioned state of the resource
`publicNetworkAccess` PublicNetworkAccessType_STATUS	PublicNetworkAccess: If not specified, the default value is ‘enabled’.
`tags` map[string]string	Tags: The tags of the resource.
`type` string	Type: The type of the resource.

BatchAccount_Spec

(Appears on:BatchAccount)

Field	Description
`autoStorage` AutoStorageBaseProperties	AutoStorage: The properties related to the auto-storage account.
`azureName` string	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.
`encryption` EncryptionProperties	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.
`identity` BatchAccountIdentity	Identity: The identity of the Batch account.
`keyVaultReference` KeyVaultReference	KeyVaultReference: A reference to the Azure key vault associated with the Batch account.
`location` string	Location: The region in which to create the account.
`operatorSpec` BatchAccountOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`poolAllocationMode` PoolAllocationMode	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 Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.
`publicNetworkAccess` PublicNetworkAccessType	PublicNetworkAccess: If not specified, the default value is ‘enabled’.
`tags` map[string]string	Tags: The user-specified tags associated with the account.

EncryptionProperties

(Appears on:BatchAccount_Spec)

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.

Field	Description
`keySource` EncryptionProperties_KeySource	KeySource: Type of the key source.
`keyVaultProperties` KeyVaultProperties	KeyVaultProperties: Additional details when using Microsoft.KeyVault

EncryptionProperties_KeySource (`string` alias)

(Appears on:EncryptionProperties)

Value	Description
"Microsoft.Batch"
"Microsoft.KeyVault"

EncryptionProperties_KeySource_STATUS (`string` alias)

(Appears on:EncryptionProperties_STATUS)

Value	Description
"Microsoft.Batch"
"Microsoft.KeyVault"

EncryptionProperties_STATUS

(Appears on:BatchAccount_STATUS)

Field	Description
`keySource` EncryptionProperties_KeySource_STATUS	KeySource: Type of the key source.
`keyVaultProperties` KeyVaultProperties_STATUS	KeyVaultProperties: Additional details when using Microsoft.KeyVault

KeyVaultProperties

(Appears on:EncryptionProperties)

KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.

Field	Description
`keyIdentifier` string	KeyIdentifier: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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

KeyVaultProperties_STATUS

(Appears on:EncryptionProperties_STATUS)

KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.

Field	Description
`keyIdentifier` string	KeyIdentifier: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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

KeyVaultReference

(Appears on:BatchAccount_Spec)

Identifies the Azure key vault associated with a Batch account.

Field	Description
`reference` genruntime.ResourceReference	Reference: The resource ID of the Azure key vault associated with the Batch account.
`url` string	Url: The URL of the Azure key vault associated with the Batch account.

KeyVaultReference_STATUS

(Appears on:BatchAccount_STATUS)

Identifies the Azure key vault associated with a Batch account.

Field	Description
`id` string	Id: The resource ID of the Azure key vault associated with the Batch account.
`url` string	Url: The URL of the Azure key vault associated with the Batch account.

PoolAllocationMode (`string` alias)

(Appears on:BatchAccount_Spec)

The allocation mode for creating pools in the Batch account.

Value	Description
"BatchService"
"UserSubscription"

PoolAllocationMode_STATUS (`string` alias)

(Appears on:BatchAccount_STATUS)

The allocation mode for creating pools in the Batch account.

Value	Description
"BatchService"
"UserSubscription"

PrivateEndpointConnection_STATUS

(Appears on:BatchAccount_STATUS)

Contains information about a private link resource.

Field	Description
`id` string	Id: The ID of the resource.

PublicNetworkAccessType (`string` alias)

(Appears on:BatchAccount_Spec)

The network access type for operating on the resources in the Batch account.

Value	Description
"Disabled"
"Enabled"

PublicNetworkAccessType_STATUS (`string` alias)

(Appears on:BatchAccount_STATUS)

The network access type for operating on the resources in the Batch account.

Value	Description
"Disabled"
"Enabled"

UserAssignedIdentityDetails

(Appears on:BatchAccountIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

VirtualMachineFamilyCoreQuota_STATUS

(Appears on:BatchAccount_STATUS)

A VM Family and its associated core quota for the Batch account.

Field	Description
`coreQuota` int	CoreQuota: The core quota for the VM family for the Batch account.
`name` string	Name: The Virtual Machine family name.

batch.azure.com/v1api20210101