Partilhar via

Microsoft.Batch batchContas 2023-11-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso batchAccounts pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Batch/batchAccounts, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Batch/batchAccounts@2023-11-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allowedAuthenticationModes: [
      'string'
    ]
    autoStorage: {
      authenticationMode: 'string'
      nodeIdentityReference: {
        resourceId: 'string'
      }
      storageAccountId: 'string'
    }
    encryption: {
      keySource: 'string'
      keyVaultProperties: {
        keyIdentifier: 'string'
      }
    }
    keyVaultReference: {
      id: 'string'
      url: 'string'
    }
    networkProfile: {
      accountAccess: {
        defaultAction: 'string'
        ipRules: [
          {
            action: 'Allow'
            value: 'string'
          }
        ]
      }
      nodeManagementAccess: {
        defaultAction: 'string'
        ipRules: [
          {
            action: 'Allow'
            value: 'string'
          }
        ]
      }
    }
    poolAllocationMode: 'string'
    publicNetworkAccess: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AutoStorageBasePropertiesOrAutoStorageProperties

Designação Descrição Valor
authenticationMode O modo de autenticação que o serviço Batch usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'StorageKeys'
nodeIdentityReference A identidade mencionada aqui deve ser atribuída a pools que tenham nós de computação que precisam de acesso ao armazenamento automático. ComputeNodeIdentityReference
storageAccountId O ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. string (obrigatório)

BatchAccountCreateParametersTags

Designação Descrição Valor

BatchAccountCreatePropertiesOrBatchAccountProperties

Designação Descrição Valor
allowedAuthenticationModes Lista de modos de autenticação permitidos para a conta de lote que podem ser usados para autenticar com o plano de dados. Isso não afeta a autenticação com o plano de controle. Matriz de cadeia de caracteres contendo qualquer uma das:
'DAA'
'Chave compartilhada'
'TaskAuthenticationToken'
armazenamento automático As propriedades relacionadas à conta de armazenamento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptação Configura como os dados do cliente são criptografados dentro da conta de lote. Por padrão, as contas são criptografadas usando uma chave gerenciada pela Microsoft. Para controle adicional, uma chave gerenciada pelo cliente pode ser usada. EncryptionProperties
keyVaultReference Uma referência ao cofre de chaves do Azure associado à conta Batch. KeyVaultReference
networkProfile O perfil de rede só entra em vigor quando publicNetworkAccess está habilitado. NetworkProfile
poolAllocationMode O modo de alocação de pool também afeta como os clientes podem se autenticar na API do Serviço de Lote. Se o modo for BatchService, os clientes podem autenticar usando chaves de acesso ou ID do Microsoft Entra. Se o modo for UserSubscription, os clientes deverão usar o Microsoft Entra ID. O padrão é BatchService. 'BatchService'
'UserSubscription'
publicNetworkAccess Se não for especificado, o valor padrão será 'enabled'. 'Desativado'
'Habilitado'

BatchAccountIdentity

Designação Descrição Valor
tipo O tipo de identidade usado para a conta Batch. 'Nenhuma'
'SystemAssigned'
'UserAssigned' (obrigatório)
userAssignedIdentities A lista de identidades de usuário associadas à conta Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Designação Descrição Valor

ComputeNodeIdentityReference

Designação Descrição Valor
resourceId O ID de recurso ARM da identidade atribuída ao usuário. string

EncryptionProperties

Designação Descrição Valor
fonte-chave Tipo da fonte da chave. 'Microsoft.Batch'
'Microsoft.KeyVault'
keyVaultPropriedades Detalhes adicionais ao usar Microsoft.KeyVault KeyVaultProperties

EndpointAccessProfile

Designação Descrição Valor
defaultAction Ação padrão para acesso ao ponto final. Ele só é aplicável quando publicNetworkAccess está habilitado. 'Permitir'
'Negar' (obrigatório)
ipRegras Matriz de intervalos IP para filtrar o endereço IP do cliente. IPRule[]

IPRule

Designação Descrição Valor
ação Ação quando o endereço IP do cliente é correspondido. 'Permitir' (obrigatório)
valor Endereço IPv4 ou intervalo de endereços IPv4 no formato CIDR. string (obrigatório)

KeyVaultProperties

Designação Descrição Valor
keyIdentifier Caminho completo para o segredo com ou sem versão. Exemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. ou https://mykeyvault.vault.azure.net/keys/testkey. Para ser utilizável, os seguintes pré-requisitos devem ser atendidos:

A conta em lote tem uma identidade atribuída ao sistema
A identidade da conta recebeu as permissões Key/Get, Key/Unwrap e Key/Wrap
O KeyVault tem a proteção soft-delete e purge ativada		 string

KeyVaultReference

Designação Descrição Valor
ID A ID do recurso do cofre de chaves do Azure associado à conta Batch. string (obrigatório)
URL A URL do cofre de chaves do Azure associado à conta de lote. string (obrigatório)

Microsoft.Batch/batchAccounts

Designação Descrição Valor
identidade A identidade da conta Batch. BatchAccountIdentity
Localização A região na qual criar a conta. string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 3
Padrão = ^[a-z0-9]+$ (obrigatório)
propriedades As propriedades da conta Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Perfil de rede

Designação Descrição Valor
accountAccess Perfil de acesso à rede para o ponto de extremidade batchAccount (API do plano de dados da conta em lote). EndpointAccessProfile
nodeManagementAccess Perfil de acesso à rede para nodeManagement endpoint (serviço de lote gerenciando nós de computação para pools de lotes). EndpointAccessProfile

UserAssignedIdentities

Designação Descrição Valor

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
pool de lotes do Azure sem endereços IP públicos Este modelo cria o pool de comunicação de nó simplificado do Lote do Azure sem endereços IP públicos.
Criar uma conta em lote usando um modelo Este modelo cria uma conta em lote e uma conta de armazenamento.

Definição de recurso de modelo ARM

O tipo de recurso batchAccounts pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Batch/batchAccounts, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2023-11-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allowedAuthenticationModes": [ "string" ],
    "autoStorage": {
      "authenticationMode": "string",
      "nodeIdentityReference": {
        "resourceId": "string"
      },
      "storageAccountId": "string"
    },
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": {
        "keyIdentifier": "string"
      }
    },
    "keyVaultReference": {
      "id": "string",
      "url": "string"
    },
    "networkProfile": {
      "accountAccess": {
        "defaultAction": "string",
        "ipRules": [
          {
            "action": "Allow",
            "value": "string"
          }
        ]
      },
      "nodeManagementAccess": {
        "defaultAction": "string",
        "ipRules": [
          {
            "action": "Allow",
            "value": "string"
          }
        ]
      }
    },
    "poolAllocationMode": "string",
    "publicNetworkAccess": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AutoStorageBasePropertiesOrAutoStorageProperties

Designação Descrição Valor
authenticationMode O modo de autenticação que o serviço Batch usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'StorageKeys'
nodeIdentityReference A identidade mencionada aqui deve ser atribuída a pools que tenham nós de computação que precisam de acesso ao armazenamento automático. ComputeNodeIdentityReference
storageAccountId O ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. string (obrigatório)

BatchAccountCreateParametersTags

Designação Descrição Valor

BatchAccountCreatePropertiesOrBatchAccountProperties

Designação Descrição Valor
allowedAuthenticationModes Lista de modos de autenticação permitidos para a conta de lote que podem ser usados para autenticar com o plano de dados. Isso não afeta a autenticação com o plano de controle. Matriz de cadeia de caracteres contendo qualquer uma das:
'DAA'
'Chave compartilhada'
'TaskAuthenticationToken'
armazenamento automático As propriedades relacionadas à conta de armazenamento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptação Configura como os dados do cliente são criptografados dentro da conta de lote. Por padrão, as contas são criptografadas usando uma chave gerenciada pela Microsoft. Para controle adicional, uma chave gerenciada pelo cliente pode ser usada. EncryptionProperties
keyVaultReference Uma referência ao cofre de chaves do Azure associado à conta Batch. KeyVaultReference
networkProfile O perfil de rede só entra em vigor quando publicNetworkAccess está habilitado. NetworkProfile
poolAllocationMode O modo de alocação de pool também afeta como os clientes podem se autenticar na API do Serviço de Lote. Se o modo for BatchService, os clientes podem autenticar usando chaves de acesso ou ID do Microsoft Entra. Se o modo for UserSubscription, os clientes deverão usar o Microsoft Entra ID. O padrão é BatchService. 'BatchService'
'UserSubscription'
publicNetworkAccess Se não for especificado, o valor padrão será 'enabled'. 'Desativado'
'Habilitado'

BatchAccountIdentity

Designação Descrição Valor
tipo O tipo de identidade usado para a conta Batch. 'Nenhuma'
'SystemAssigned'
'UserAssigned' (obrigatório)
userAssignedIdentities A lista de identidades de usuário associadas à conta Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Designação Descrição Valor

ComputeNodeIdentityReference

Designação Descrição Valor
resourceId O ID de recurso ARM da identidade atribuída ao usuário. string

EncryptionProperties

Designação Descrição Valor
fonte-chave Tipo da fonte da chave. 'Microsoft.Batch'
'Microsoft.KeyVault'
keyVaultPropriedades Detalhes adicionais ao usar Microsoft.KeyVault KeyVaultProperties

EndpointAccessProfile

Designação Descrição Valor
defaultAction Ação padrão para acesso ao ponto final. Ele só é aplicável quando publicNetworkAccess está habilitado. 'Permitir'
'Negar' (obrigatório)
ipRegras Matriz de intervalos IP para filtrar o endereço IP do cliente. IPRule[]

IPRule

Designação Descrição Valor
ação Ação quando o endereço IP do cliente é correspondido. 'Permitir' (obrigatório)
valor Endereço IPv4 ou intervalo de endereços IPv4 no formato CIDR. string (obrigatório)

KeyVaultProperties

Designação Descrição Valor
keyIdentifier Caminho completo para o segredo com ou sem versão. Exemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. ou https://mykeyvault.vault.azure.net/keys/testkey. Para ser utilizável, os seguintes pré-requisitos devem ser atendidos:

A conta em lote tem uma identidade atribuída ao sistema
A identidade da conta recebeu as permissões Key/Get, Key/Unwrap e Key/Wrap
O KeyVault tem a proteção soft-delete e purge ativada		 string

KeyVaultReference

Designação Descrição Valor
ID A ID do recurso do cofre de chaves do Azure associado à conta Batch. string (obrigatório)
URL A URL do cofre de chaves do Azure associado à conta de lote. string (obrigatório)

Microsoft.Batch/batchAccounts

Designação Descrição Valor
apiVersion A versão api '2023-11-01'
identidade A identidade da conta Batch. BatchAccountIdentity
Localização A região na qual criar a conta. string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 3
Padrão = ^[a-z0-9]+$ (obrigatório)
propriedades As propriedades da conta Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Batch/batchAccounts'

Perfil de rede

Designação Descrição Valor
accountAccess Perfil de acesso à rede para o ponto de extremidade batchAccount (API do plano de dados da conta em lote). EndpointAccessProfile
nodeManagementAccess Perfil de acesso à rede para nodeManagement endpoint (serviço de lote gerenciando nós de computação para pools de lotes). EndpointAccessProfile

UserAssignedIdentities

Designação Descrição Valor

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
pool de lotes do Azure sem endereços IP públicos

Implantar no Azure 		Este modelo cria o pool de comunicação de nó simplificado do Lote do Azure sem endereços IP públicos.
Criar uma conta em lote usando um modelo

Implantar no Azure 		Este modelo cria uma conta em lote e uma conta de armazenamento.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso batchAccounts pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Batch/batchAccounts, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2023-11-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowedAuthenticationModes = [
        "string"
      ]
      autoStorage = {
        authenticationMode = "string"
        nodeIdentityReference = {
          resourceId = "string"
        }
        storageAccountId = "string"
      }
      encryption = {
        keySource = "string"
        keyVaultProperties = {
          keyIdentifier = "string"
        }
      }
      keyVaultReference = {
        id = "string"
        url = "string"
      }
      networkProfile = {
        accountAccess = {
          defaultAction = "string"
          ipRules = [
            {
              action = "Allow"
              value = "string"
            }
          ]
        }
        nodeManagementAccess = {
          defaultAction = "string"
          ipRules = [
            {
              action = "Allow"
              value = "string"
            }
          ]
        }
      }
      poolAllocationMode = "string"
      publicNetworkAccess = "string"
    }
  })
}

Valores de propriedade

AutoStorageBasePropertiesOrAutoStorageProperties

Designação Descrição Valor
authenticationMode O modo de autenticação que o serviço Batch usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'StorageKeys'
nodeIdentityReference A identidade mencionada aqui deve ser atribuída a pools que tenham nós de computação que precisam de acesso ao armazenamento automático. ComputeNodeIdentityReference
storageAccountId O ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. string (obrigatório)

BatchAccountCreateParametersTags

Designação Descrição Valor

BatchAccountCreatePropertiesOrBatchAccountProperties

Designação Descrição Valor
allowedAuthenticationModes Lista de modos de autenticação permitidos para a conta de lote que podem ser usados para autenticar com o plano de dados. Isso não afeta a autenticação com o plano de controle. Matriz de cadeia de caracteres contendo qualquer uma das:
'DAA'
'Chave compartilhada'
'TaskAuthenticationToken'
armazenamento automático As propriedades relacionadas à conta de armazenamento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptação Configura como os dados do cliente são criptografados dentro da conta de lote. Por padrão, as contas são criptografadas usando uma chave gerenciada pela Microsoft. Para controle adicional, uma chave gerenciada pelo cliente pode ser usada. EncryptionProperties
keyVaultReference Uma referência ao cofre de chaves do Azure associado à conta Batch. KeyVaultReference
networkProfile O perfil de rede só entra em vigor quando publicNetworkAccess está habilitado. NetworkProfile
poolAllocationMode O modo de alocação de pool também afeta como os clientes podem se autenticar na API do Serviço de Lote. Se o modo for BatchService, os clientes podem autenticar usando chaves de acesso ou ID do Microsoft Entra. Se o modo for UserSubscription, os clientes deverão usar o Microsoft Entra ID. O padrão é BatchService. 'BatchService'
'UserSubscription'
publicNetworkAccess Se não for especificado, o valor padrão será 'enabled'. 'Desativado'
'Habilitado'

BatchAccountIdentity

Designação Descrição Valor
tipo O tipo de identidade usado para a conta Batch. 'Nenhuma'
'SystemAssigned'
'UserAssigned' (obrigatório)
userAssignedIdentities A lista de identidades de usuário associadas à conta Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Designação Descrição Valor

ComputeNodeIdentityReference

Designação Descrição Valor
resourceId O ID de recurso ARM da identidade atribuída ao usuário. string

EncryptionProperties

Designação Descrição Valor
fonte-chave Tipo da fonte da chave. 'Microsoft.Batch'
'Microsoft.KeyVault'
keyVaultPropriedades Detalhes adicionais ao usar Microsoft.KeyVault KeyVaultProperties

EndpointAccessProfile

Designação Descrição Valor
defaultAction Ação padrão para acesso ao ponto final. Ele só é aplicável quando publicNetworkAccess está habilitado. 'Permitir'
'Negar' (obrigatório)
ipRegras Matriz de intervalos IP para filtrar o endereço IP do cliente. IPRule[]

IPRule

Designação Descrição Valor
ação Ação quando o endereço IP do cliente é correspondido. 'Permitir' (obrigatório)
valor Endereço IPv4 ou intervalo de endereços IPv4 no formato CIDR. string (obrigatório)

KeyVaultProperties

Designação Descrição Valor
keyIdentifier Caminho completo para o segredo com ou sem versão. Exemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. ou https://mykeyvault.vault.azure.net/keys/testkey. Para ser utilizável, os seguintes pré-requisitos devem ser atendidos:

A conta em lote tem uma identidade atribuída ao sistema
A identidade da conta recebeu as permissões Key/Get, Key/Unwrap e Key/Wrap
O KeyVault tem a proteção soft-delete e purge ativada		 string

KeyVaultReference

Designação Descrição Valor
ID A ID do recurso do cofre de chaves do Azure associado à conta Batch. string (obrigatório)
URL A URL do cofre de chaves do Azure associado à conta de lote. string (obrigatório)

Microsoft.Batch/batchAccounts

Designação Descrição Valor
identidade A identidade da conta Batch. BatchAccountIdentity
Localização A região na qual criar a conta. string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 3
Padrão = ^[a-z0-9]+$ (obrigatório)
propriedades As propriedades da conta Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Batch/batchAccounts@2023-11-01"

Perfil de rede

Designação Descrição Valor
accountAccess Perfil de acesso à rede para o ponto de extremidade batchAccount (API do plano de dados da conta em lote). EndpointAccessProfile
nodeManagementAccess Perfil de acesso à rede para nodeManagement endpoint (serviço de lote gerenciando nós de computação para pools de lotes). EndpointAccessProfile

UserAssignedIdentities

Designação Descrição Valor