Compartilhar via


Microsoft.Batch batchAccounts 2022-10-01

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@2022-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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

batchAccounts

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 24

Caracteres válidos:
Letras minúsculas e números.
localização A região na qual criar a conta. cadeia de caracteres (obrigatório)
Tags As marcas especificadas pelo usuário associadas à conta. Dicionário de nomes e valores de marca. Consulte Marcas em modelos
identidade A identidade da conta do Lote. BatchAccountIdentity
Propriedades As propriedades da conta do Lote. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

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

BatchAccountIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserAssignedIdentities

UserAssignedIdentities

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

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'
'SharedKey'
'TaskAuthenticationToken'
autoStorage As propriedades relacionadas à conta de armazenamento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptação 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. EncryptionProperties
keyVaultReference Uma referência ao cofre de chaves do Azure associado à conta do Lote. KeyVaultReference
networkProfile 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 o Azure Active Directory. Se o modo for UserSubscription, os clientes deverão usar o Azure Active Directory. O padrão é BatchService. 'BatchService'
'UserSubscription'
publicNetworkAccess Se não for especificado, o valor padrão será 'habilitado'. 'Desabilitado'
'Habilitado'

AutoStorageBasePropertiesOrAutoStorageProperties

Nome Descrição Valor
authenticationMode O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'StorageKeys'
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
storageAccountId A ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. cadeia de caracteres (obrigatório)

ComputeNodeIdentityReference

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

EncryptionProperties

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

KeyVaultProperties

Nome Descrição Valor
keyIdentifier Caminho completo para o segredo com versão. Exemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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
corda

KeyVaultReference

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)

NetworkProfile

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

EndpointAccessProfile

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)

Modelos de início rápido

Os modelos de início rápido a seguir implantam 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 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": "2022-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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

batchAccounts

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.Batch/batchAccounts'
apiVersion A versão da API do recurso '2022-10-01'
nome O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 24

Caracteres válidos:
Letras minúsculas e números.
localização A região na qual criar a conta. cadeia de caracteres (obrigatório)
Tags As marcas especificadas pelo usuário associadas à conta. Dicionário de nomes e valores de marca. Consulte Marcas em modelos
identidade A identidade da conta do Lote. BatchAccountIdentity
Propriedades As propriedades da conta do Lote. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

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

BatchAccountIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserAssignedIdentities

UserAssignedIdentities

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

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'
'SharedKey'
'TaskAuthenticationToken'
autoStorage As propriedades relacionadas à conta de armazenamento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptação 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. EncryptionProperties
keyVaultReference Uma referência ao cofre de chaves do Azure associado à conta do Lote. KeyVaultReference
networkProfile 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 o Azure Active Directory. Se o modo for UserSubscription, os clientes deverão usar o Azure Active Directory. O padrão é BatchService. 'BatchService'
'UserSubscription'
publicNetworkAccess Se não for especificado, o valor padrão será 'habilitado'. 'Desabilitado'
'Habilitado'

AutoStorageBasePropertiesOrAutoStorageProperties

Nome Descrição Valor
authenticationMode O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático. 'BatchAccountManagedIdentity'
'StorageKeys'
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
storageAccountId A ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. cadeia de caracteres (obrigatório)

ComputeNodeIdentityReference

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

EncryptionProperties

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

KeyVaultProperties

Nome Descrição Valor
keyIdentifier Caminho completo para o segredo com versão. Exemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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
corda

KeyVaultReference

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)

NetworkProfile

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

EndpointAccessProfile

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)

Modelos de início rápido

Os modelos de início rápido a seguir implantam 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:

  • grupos de recursos

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@2022-10-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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

batchAccounts

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Batch/batchAccounts@2022-10-01"
nome O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 24

Caracteres válidos:
Letras minúsculas e números.
localização A região na qual criar a conta. cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
Tags As marcas especificadas pelo usuário associadas à conta. Dicionário de nomes e valores de marca.
identidade A identidade da conta do Lote. BatchAccountIdentity
Propriedades As propriedades da conta do Lote. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nome Descrição Valor
tipo O tipo de identidade usado para a conta do Lote. "SystemAssigned"
"UserAssigned" (obrigatório)
identity_ids A lista de identidades de usuário associadas à conta do Lote. Matriz de IDs de identidade do usuário.

BatchAccountIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserAssignedIdentities

UserAssignedIdentities

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

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"
"SharedKey"
"TaskAuthenticationToken"
autoStorage As propriedades relacionadas à conta de armazenamento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptação 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. EncryptionProperties
keyVaultReference Uma referência ao cofre de chaves do Azure associado à conta do Lote. KeyVaultReference
networkProfile 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 o Azure Active Directory. Se o modo for UserSubscription, os clientes deverão usar o Azure Active Directory. O padrão é BatchService. "BatchService"
"UserSubscription"
publicNetworkAccess Se não for especificado, o valor padrão será 'habilitado'. "Desabilitado"
"Habilitado"

AutoStorageBasePropertiesOrAutoStorageProperties

Nome Descrição Valor
authenticationMode O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático. "BatchAccountManagedIdentity"
"StorageKeys"
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
storageAccountId A ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático. cadeia de caracteres (obrigatório)

ComputeNodeIdentityReference

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

EncryptionProperties

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

KeyVaultProperties

Nome Descrição Valor
keyIdentifier Caminho completo para o segredo com versão. Exemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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
corda

KeyVaultReference

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)

NetworkProfile

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

EndpointAccessProfile

Nome Descrição Valor
defaultAction Ação padrão para acesso ao ponto de extremidade. Ela só é aplicável quando publicNetworkAccess está habilitado. "Permitir"
"Negar" (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. "Permitir" (obrigatório)
valor Endereço IPv4 ou intervalo de endereços IPv4 no formato CIDR. cadeia de caracteres (obrigatório)