Compartilhar via


Microsoft.Batch batchAccounts

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.Batch/batchAccounts@2024-07-01' = {
  scope: resourceSymbolicName or scope
  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 da propriedade

Microsoft.Batch/batchAccounts

Nome Descrição Valor
identidade A identidade da conta do Lote. Identidade da conta do lote
local A região na qual criar a conta. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 24
Padrão = ^[a-z0-9]+$ (obrigatório)
Propriedades As propriedades da conta do Lote. BatchAccountCreatePropertiesOrBatchAccountProperties
escopo Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

AutoStorageBasePropertiesOrAutoStorageProperties

Nome Descrição Valor
Modo de autenticação O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'Chaves de armazenamento'
nodeIdentityReference A identidade referenciada aqui deve ser atribuída a pools que têm nós de computação que precisam de acesso ao armazenamento automático. ComputeNodeIdentityReference
ID da conta de armazenamento A ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. cadeia de caracteres (obrigatório)

BatchAccountCreateParametersTags

Nome Descrição Valor

BatchAccountCreatePropertiesOrBatchAccountProperties

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

Identidade da conta do lote

Nome Descrição Valor
tipo O tipo de identidade usado para a conta do Lote. 'Nenhum'
'SystemAssigned'
'UserAssigned' (obrigatório)
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas à conta do Lote. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nome Descrição Valor

ComputeNodeIdentityReference

Nome Descrição Valor
ID do recurso A ID de recurso do ARM da identidade atribuída pelo usuário. cadeia

Propriedades de criptografia

Nome Descrição Valor
keySource Tipo da origem da chave. 'Microsoft.Batch'
'Microsoft.KeyVault'
keyVaultProperties Detalhes adicionais ao usar Microsoft.KeyVault KeyVaultProperties

Perfil de acesso de endpoint

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

IPRule

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

Propriedades do KeyVault

Nome 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 serem utilizáveis, os seguintes pré-requisitos devem ser atendidos:

A Conta do Lote tem uma identidade atribuída pelo sistema
A identidade da conta recebeu permissões Key/Get, Key/Unwrap e Key/Wrap
O KeyVault tem a proteção contra exclusão reversível e limpeza habilitada
cadeia

Referência do KeyVault

Nome Descrição Valor
id A ID do recurso do cofre de chaves do Azure associado à conta do Lote. cadeia de caracteres (obrigatório)
URL A URL do cofre de chaves do Azure associada à conta do Lote. cadeia de caracteres (obrigatório)

Perfil de rede

Nome Descrição Valor
accountAccess Perfil de acesso à rede para o ponto de extremidade batchAccount (API do plano de dados da conta do Lote). EndpointAccessProfile
nodeManagementAccess Perfil de acesso à rede para o ponto de extremidade nodeManagement (serviço do Lote que gerencia nós de computação para pools do Lote). EndpointAccessProfile

UserAssignedIdentities

Nome Descrição Valor

Exemplos de uso

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Módulo Descrição
de Conta do Lote Módulo de recurso da AVM para conta em lote

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
pool do Lote 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 Esse modelo cria uma Conta do Lote e uma conta de armazenamento.

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2024-07-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 da propriedade

Microsoft.Batch/batchAccounts

Nome Descrição Valor
apiVersion A versão da API '2024-07-01'
identidade A identidade da conta do Lote. Identidade da conta do lote
local A região na qual criar a conta. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

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

AutoStorageBasePropertiesOrAutoStorageProperties

Nome Descrição Valor
Modo de autenticação O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'Chaves de armazenamento'
nodeIdentityReference A identidade referenciada aqui deve ser atribuída a pools que têm nós de computação que precisam de acesso ao armazenamento automático. ComputeNodeIdentityReference
ID da conta de armazenamento A ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. cadeia de caracteres (obrigatório)

BatchAccountCreateParametersTags

Nome Descrição Valor

BatchAccountCreatePropertiesOrBatchAccountProperties

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

Identidade da conta do lote

Nome Descrição Valor
tipo O tipo de identidade usado para a conta do Lote. 'Nenhum'
'SystemAssigned'
'UserAssigned' (obrigatório)
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas à conta do Lote. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nome Descrição Valor

ComputeNodeIdentityReference

Nome Descrição Valor
ID do recurso A ID de recurso do ARM da identidade atribuída pelo usuário. cadeia

Propriedades de criptografia

Nome Descrição Valor
keySource Tipo da origem da chave. 'Microsoft.Batch'
'Microsoft.KeyVault'
keyVaultProperties Detalhes adicionais ao usar Microsoft.KeyVault KeyVaultProperties

Perfil de acesso de endpoint

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

IPRule

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

Propriedades do KeyVault

Nome 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 serem utilizáveis, os seguintes pré-requisitos devem ser atendidos:

A Conta do Lote tem uma identidade atribuída pelo sistema
A identidade da conta recebeu permissões Key/Get, Key/Unwrap e Key/Wrap
O KeyVault tem a proteção contra exclusão reversível e limpeza habilitada
cadeia

Referência do KeyVault

Nome Descrição Valor
id A ID do recurso do cofre de chaves do Azure associado à conta do Lote. cadeia de caracteres (obrigatório)
URL A URL do cofre de chaves do Azure associada à conta do Lote. cadeia de caracteres (obrigatório)

Perfil de rede

Nome Descrição Valor
accountAccess Perfil de acesso à rede para o ponto de extremidade batchAccount (API do plano de dados da conta do Lote). EndpointAccessProfile
nodeManagementAccess Perfil de acesso à rede para o ponto de extremidade nodeManagement (serviço do Lote que gerencia nós de computação para pools do Lote). EndpointAccessProfile

UserAssignedIdentities

Nome Descrição Valor

Exemplos de uso

Modelos de início rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
pool do Lote 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
Esse modelo cria uma Conta do Lote e uma conta de armazenamento.

Definição de recurso do Terraform (provedor de AzAPI)

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

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2024-07-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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 da propriedade

Microsoft.Batch/batchAccounts

Nome Descrição Valor
identidade A identidade da conta do Lote. Identidade da conta do lote
local A região na qual criar a conta. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 24
Padrão = ^[a-z0-9]+$ (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades As propriedades da conta do Lote. BatchAccountCreatePropertiesOrBatchAccountProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.Batch/batchAccounts@2024-07-01"

AutoStorageBasePropertiesOrAutoStorageProperties

Nome Descrição Valor
Modo de autenticação O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'Chaves de armazenamento'
nodeIdentityReference A identidade referenciada aqui deve ser atribuída a pools que têm nós de computação que precisam de acesso ao armazenamento automático. ComputeNodeIdentityReference
ID da conta de armazenamento A ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. cadeia de caracteres (obrigatório)

BatchAccountCreateParametersTags

Nome Descrição Valor

BatchAccountCreatePropertiesOrBatchAccountProperties

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

Identidade da conta do lote

Nome Descrição Valor
tipo O tipo de identidade usado para a conta do Lote. 'Nenhum'
'SystemAssigned'
'UserAssigned' (obrigatório)
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas à conta do Lote. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nome Descrição Valor

ComputeNodeIdentityReference

Nome Descrição Valor
ID do recurso A ID de recurso do ARM da identidade atribuída pelo usuário. cadeia

Propriedades de criptografia

Nome Descrição Valor
keySource Tipo da origem da chave. 'Microsoft.Batch'
'Microsoft.KeyVault'
keyVaultProperties Detalhes adicionais ao usar Microsoft.KeyVault KeyVaultProperties

Perfil de acesso de endpoint

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

IPRule

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

Propriedades do KeyVault

Nome 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 serem utilizáveis, os seguintes pré-requisitos devem ser atendidos:

A Conta do Lote tem uma identidade atribuída pelo sistema
A identidade da conta recebeu permissões Key/Get, Key/Unwrap e Key/Wrap
O KeyVault tem a proteção contra exclusão reversível e limpeza habilitada
cadeia

Referência do KeyVault

Nome Descrição Valor
id A ID do recurso do cofre de chaves do Azure associado à conta do Lote. cadeia de caracteres (obrigatório)
URL A URL do cofre de chaves do Azure associada à conta do Lote. cadeia de caracteres (obrigatório)

Perfil de rede

Nome Descrição Valor
accountAccess Perfil de acesso à rede para o ponto de extremidade batchAccount (API do plano de dados da conta do Lote). EndpointAccessProfile
nodeManagementAccess Perfil de acesso à rede para o ponto de extremidade nodeManagement (serviço do Lote que gerencia nós de computação para pools do Lote). EndpointAccessProfile

UserAssignedIdentities

Nome Descrição Valor

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação da conta do Lote do Azure.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "batchAccount" {
  type      = "Microsoft.Batch/batchAccounts@2022-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      encryption = {
        keySource = "Microsoft.Batch"
      }
      poolAllocationMode  = "BatchService"
      publicNetworkAccess = "Enabled"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Módulo Descrição
de Conta do Lote Módulo de recurso da AVM para conta em lote