batch.azure.com/v1beta20210101

batch.azure.com/v1beta20210101

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

Resource Types:

    APIVersion (string alias)

    Value Description

    "2021-01-01"

    AutoStorageBaseProperties

    (Appears on:BatchAccounts_Spec)

    Field Description
    storageAccountReference
    genruntime.ResourceReference

    StorageAccountReference: The resource ID of the storage account to be used for auto-storage account.

    AutoStorageBasePropertiesARM

    (Appears on:BatchAccountCreatePropertiesARM)

    Field Description
    storageAccountId
    string

    AutoStorageProperties_Status

    (Appears on:BatchAccount_Status)

    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.

    AutoStorageProperties_StatusARM

    (Appears on:BatchAccountProperties_StatusARM)

    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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    BatchAccounts_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, if configured. This is only used when the user specifies ‘Microsoft.KeyVault’ as their Batch account encryption configuration.

    keyVaultReference
    KeyVaultReference

    KeyVaultReference: Identifies the Azure key vault associated with a Batch account.

    location
    string

    Location: The region in which to create the account.

    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
    BatchAccountCreatePropertiesPoolAllocationMode

    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
    BatchAccountCreatePropertiesPublicNetworkAccess

    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

    BatchAccountCreatePropertiesARM

    (Appears on:BatchAccounts_SpecARM)

    Field Description
    autoStorage
    AutoStorageBasePropertiesARM

    AutoStorage: The properties related to the auto-storage account.

    encryption
    EncryptionPropertiesARM

    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.

    keyVaultReference
    KeyVaultReferenceARM

    KeyVaultReference: Identifies the Azure key vault associated with a Batch account.

    poolAllocationMode
    BatchAccountCreatePropertiesPoolAllocationMode

    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
    BatchAccountCreatePropertiesPublicNetworkAccess

    PublicNetworkAccess: If not specified, the default value is ‘enabled’.

    BatchAccountCreatePropertiesPoolAllocationMode (string alias)

    (Appears on:BatchAccountCreatePropertiesARM, BatchAccounts_Spec)

    Value Description

    "BatchService"

    "UserSubscription"

    BatchAccountCreatePropertiesPublicNetworkAccess (string alias)

    (Appears on:BatchAccountCreatePropertiesARM, BatchAccounts_Spec)

    Value Description

    "Disabled"

    "Enabled"

    BatchAccountIdentity

    (Appears on:BatchAccounts_Spec)

    Field Description
    type
    BatchAccountIdentityType

    Type: The type of identity used for the Batch account.

    BatchAccountIdentityARM

    (Appears on:BatchAccounts_SpecARM)

    Field Description
    type
    BatchAccountIdentityType

    Type: The type of identity used for the Batch account.

    BatchAccountIdentityStatusType (string alias)

    (Appears on:BatchAccountIdentity_Status, BatchAccountIdentity_StatusARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    BatchAccountIdentityType (string alias)

    (Appears on:BatchAccountIdentity, BatchAccountIdentityARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    BatchAccountIdentity_Status

    (Appears on:BatchAccount_Status)

    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
    BatchAccountIdentityStatusType

    Type: The type of identity used for the Batch account.

    userAssignedIdentities
    map[string]./api/batch/v1beta20210101.BatchAccountIdentity_Status_UserAssignedIdentities

    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_StatusARM

    (Appears on:BatchAccount_StatusARM)

    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
    BatchAccountIdentityStatusType

    Type: The type of identity used for the Batch account.

    userAssignedIdentities
    map[string]./api/batch/v1beta20210101.BatchAccountIdentity_Status_UserAssignedIdentitiesARM

    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_UserAssignedIdentities

    (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.

    BatchAccountIdentity_Status_UserAssignedIdentitiesARM

    (Appears on:BatchAccountIdentity_StatusARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    BatchAccountPropertiesStatusProvisioningState (string alias)

    (Appears on:BatchAccountProperties_StatusARM, BatchAccount_Status)

    Value Description

    "Cancelled"

    "Creating"

    "Deleting"

    "Failed"

    "Invalid"

    "Succeeded"

    BatchAccountProperties_StatusARM

    (Appears on:BatchAccount_StatusARM)

    Field Description
    accountEndpoint
    string

    AccountEndpoint: The account endpoint used to interact with the Batch service.

    activeJobAndJobScheduleQuota
    int
    autoStorage
    AutoStorageProperties_StatusARM
    dedicatedCoreQuota
    int

    DedicatedCoreQuota: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

    dedicatedCoreQuotaPerVMFamily
    []VirtualMachineFamilyCoreQuota_StatusARM

    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_StatusARM

    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.

    keyVaultReference
    KeyVaultReference_StatusARM
    lowPriorityCoreQuota
    int

    LowPriorityCoreQuota: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

    poolAllocationMode
    PoolAllocationMode_Status
    poolQuota
    int
    privateEndpointConnections
    []PrivateEndpointConnection_StatusARM

    PrivateEndpointConnections: List of private endpoint connections associated with the Batch account

    provisioningState
    BatchAccountPropertiesStatusProvisioningState

    ProvisioningState: The provisioned state of the resource

    publicNetworkAccess
    PublicNetworkAccessType_Status

    PublicNetworkAccess: If not specified, the default value is ‘enabled’.

    BatchAccount_Status

    (Appears on:BatchAccount)

    Field Description
    accountEndpoint
    string

    AccountEndpoint: The account endpoint used to interact with the Batch service.

    activeJobAndJobScheduleQuota
    int
    autoStorage
    AutoStorageProperties_Status
    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
    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
    poolQuota
    int
    privateEndpointConnections
    []PrivateEndpointConnection_Status

    PrivateEndpointConnections: List of private endpoint connections associated with the Batch account

    provisioningState
    BatchAccountPropertiesStatusProvisioningState

    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_StatusARM

    Field Description
    id
    string

    Id: The ID of the resource.

    identity
    BatchAccountIdentity_StatusARM

    Identity: The identity of the Batch account.

    location
    string

    Location: The location of the resource.

    name
    string

    Name: The name of the resource.

    properties
    BatchAccountProperties_StatusARM

    Properties: The properties associated with the account.

    tags
    map[string]string

    Tags: The tags of the resource.

    type
    string

    Type: The type of the resource.

    BatchAccounts_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, if configured. This is only used when the user specifies ‘Microsoft.KeyVault’ as their Batch account encryption configuration.

    keyVaultReference
    KeyVaultReference

    KeyVaultReference: Identifies the Azure key vault associated with a Batch account.

    location
    string

    Location: The region in which to create the account.

    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
    BatchAccountCreatePropertiesPoolAllocationMode

    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
    BatchAccountCreatePropertiesPublicNetworkAccess

    PublicNetworkAccess: If not specified, the default value is ‘enabled’.

    tags
    map[string]string

    Tags: The user-specified tags associated with the account.

    BatchAccounts_SpecARM

    Field Description
    identity
    BatchAccountIdentityARM

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

    location
    string

    Location: The region in which to create the account.

    name
    string

    Name: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.

    properties
    BatchAccountCreatePropertiesARM

    Properties: The properties of a Batch account.

    tags
    map[string]string

    Tags: The user-specified tags associated with the account.

    EncryptionProperties

    (Appears on:BatchAccounts_Spec)

    Field Description
    keySource
    EncryptionPropertiesKeySource

    KeySource: Type of the key source.

    keyVaultProperties
    KeyVaultProperties

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

    EncryptionPropertiesARM

    (Appears on:BatchAccountCreatePropertiesARM)

    Field Description
    keySource
    EncryptionPropertiesKeySource

    KeySource: Type of the key source.

    keyVaultProperties
    KeyVaultPropertiesARM

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

    EncryptionPropertiesKeySource (string alias)

    (Appears on:EncryptionProperties, EncryptionPropertiesARM)

    Value Description

    "Microsoft.Batch"

    "Microsoft.KeyVault"

    EncryptionPropertiesStatusKeySource (string alias)

    (Appears on:EncryptionProperties_Status, EncryptionProperties_StatusARM)

    Value Description

    "Microsoft.Batch"

    "Microsoft.KeyVault"

    EncryptionProperties_Status

    (Appears on:BatchAccount_Status)

    Field Description
    keySource
    EncryptionPropertiesStatusKeySource

    KeySource: Type of the key source.

    keyVaultProperties
    KeyVaultProperties_Status

    KeyVaultProperties: Additional details when using Microsoft.KeyVault

    EncryptionProperties_StatusARM

    (Appears on:BatchAccountProperties_StatusARM)

    Field Description
    keySource
    EncryptionPropertiesStatusKeySource

    KeySource: Type of the key source.

    keyVaultProperties
    KeyVaultProperties_StatusARM

    KeyVaultProperties: Additional details when using Microsoft.KeyVault

    KeyVaultProperties

    (Appears on:EncryptionProperties)

    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

    KeyVaultPropertiesARM

    (Appears on:EncryptionPropertiesARM)

    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)

    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_StatusARM

    (Appears on:EncryptionProperties_StatusARM)

    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:BatchAccounts_Spec)

    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.

    KeyVaultReferenceARM

    (Appears on:BatchAccountCreatePropertiesARM)

    Field Description
    id
    string
    url
    string

    Url: The URL of the Azure key vault associated with the Batch account.

    KeyVaultReference_Status

    (Appears on:BatchAccount_Status)

    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.

    KeyVaultReference_StatusARM

    (Appears on:BatchAccountProperties_StatusARM)

    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_Status (string alias)

    (Appears on:BatchAccountProperties_StatusARM, BatchAccount_Status)

    Value Description

    "BatchService"

    "UserSubscription"

    PrivateEndpointConnectionPropertiesStatusProvisioningState (string alias)

    (Appears on:PrivateEndpointConnectionProperties_StatusARM, PrivateEndpointConnection_Status)

    Value Description

    "Failed"

    "Succeeded"

    "Updating"

    PrivateEndpointConnectionProperties_StatusARM

    (Appears on:PrivateEndpointConnection_StatusARM)

    Field Description
    privateEndpoint
    PrivateEndpoint_StatusARM
    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionState_StatusARM
    provisioningState
    PrivateEndpointConnectionPropertiesStatusProvisioningState

    PrivateEndpointConnection_Status

    (Appears on:BatchAccount_Status)

    Field Description
    etag
    string

    Etag: The ETag of the resource, used for concurrency statements.

    id
    string

    Id: The ID of the resource.

    name
    string

    Name: The name of the resource.

    privateEndpoint
    PrivateEndpoint_Status
    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionState_Status
    provisioningState
    PrivateEndpointConnectionPropertiesStatusProvisioningState
    type
    string

    Type: The type of the resource.

    PrivateEndpointConnection_StatusARM

    (Appears on:BatchAccountProperties_StatusARM)

    Field Description
    etag
    string

    Etag: The ETag of the resource, used for concurrency statements.

    id
    string

    Id: The ID of the resource.

    name
    string

    Name: The name of the resource.

    properties
    PrivateEndpointConnectionProperties_StatusARM

    Properties: The properties associated with the private endpoint connection.

    type
    string

    Type: The type of the resource.

    PrivateEndpoint_Status

    (Appears on:PrivateEndpointConnection_Status)

    Field Description
    id
    string

    PrivateEndpoint_StatusARM

    (Appears on:PrivateEndpointConnectionProperties_StatusARM)

    Field Description
    id
    string

    PrivateLinkServiceConnectionState_Status

    (Appears on:PrivateEndpointConnection_Status)

    Field Description
    actionRequired
    string
    description
    string
    status
    PrivateLinkServiceConnectionStatus_Status

    PrivateLinkServiceConnectionState_StatusARM

    (Appears on:PrivateEndpointConnectionProperties_StatusARM)

    Field Description
    actionRequired
    string
    description
    string
    status
    PrivateLinkServiceConnectionStatus_Status

    PrivateLinkServiceConnectionStatus_Status (string alias)

    (Appears on:PrivateLinkServiceConnectionState_Status, PrivateLinkServiceConnectionState_StatusARM)

    Value Description

    "Approved"

    "Disconnected"

    "Pending"

    "Rejected"

    PublicNetworkAccessType_Status (string alias)

    (Appears on:BatchAccountProperties_StatusARM, BatchAccount_Status)

    Value Description

    "Disabled"

    "Enabled"

    VirtualMachineFamilyCoreQuota_Status

    (Appears on:BatchAccount_Status)

    Field Description
    coreQuota
    int

    CoreQuota: The core quota for the VM family for the Batch account.

    name
    string

    Name: The Virtual Machine family name.

    VirtualMachineFamilyCoreQuota_StatusARM

    (Appears on:BatchAccountProperties_StatusARM)

    Field Description
    coreQuota
    int

    CoreQuota: The core quota for the VM family for the Batch account.

    name
    string

    Name: The Virtual Machine family name.