Microsoft.Batch batchAccounts

Artigo
03/11/2024

Definição de recurso do Bicep

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

Grupos de recursos – veja comandos de implementação de grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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' = {
  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
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-24 Carateres válidos: Letras minúsculas e números.
localização	A região em que pretende criar a conta.	cadeia (obrigatório)
etiquetas	As etiquetas especificadas pelo utilizador associadas à conta.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade	A identidade da conta do Batch.	BatchAccountIdentity
propriedades	As propriedades da conta do Batch.	BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade utilizado para a conta do Batch.	"Nenhum" "SystemAssigned" "UserAssigned" (obrigatório)
userAssignedIdentities	A lista de identidades de utilizador associadas à conta do Batch.	BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		UserAssignedIdentities

UserAssignedIdentities

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nome	Descrição	Valor
allowedAuthenticationModes	Lista de modos de autenticação permitidos para a conta do Batch que podem ser utilizados para autenticar com o plano de dados. Isto não afeta a autenticação com o plano de controlo.	Matriz de cadeias que contém qualquer um dos seguintes: 'AAD' "SharedKey" "TaskAuthenticationToken"
autoStorage	As propriedades relacionadas com a conta de armazenamento automático.	AutoStorageBasePropertiesOrAutoStorageProperties
Encriptação	Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.	EncryptionProperties
keyVaultReference	Uma referência ao cofre de chaves do Azure associado à conta do Batch.	KeyVaultReference
networkProfile	O perfil de rede só entra em vigor quando publicNetworkAccess está ativado.	NetworkProfile
poolAllocationMode	O modo de alocação do conjunto também afeta a forma como os clientes podem autenticar-se na API do Serviço Batch. Se o modo for BatchService, os clientes poderão autenticar-se com chaves de acesso ou Microsoft Entra ID. Se o modo for UserSubscription, os clientes têm de utilizar Microsoft Entra ID. A predefinição é BatchService.	"BatchService" "UserSubscription"
publicNetworkAccess	Se não for especificado, o valor predefinido é "ativado".	"Desativado" "Ativado"

AutoStorageBasePropertiesOrAutoStorageProperties

Nome	Descrição	Valor
authenticationMode	O modo de autenticação que o serviço Batch irá utilizar para gerir a conta de armazenamento automático.	"BatchAccountManagedIdentity" "StorageKeys"
nodeIdentityReference	A identidade aqui referenciada tem de ser atribuída a conjuntos que têm nós de computação que precisam de acesso ao armazenamento automático.	ComputeNodeIdentityReference
storageAccountId	O ID de recurso da conta de armazenamento a utilizar para a conta de armazenamento automático.	cadeia (obrigatório)

ComputeNodeIdentityReference

Nome	Descrição	Valor
resourceId	O ID de recurso do ARM da identidade atribuída pelo utilizador.	string

EncryptionProperties

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

KeyVaultProperties

Nome	Descrição	Valor
keyIdentifier	Caminho completo para o segredo com ou sem versão. Exemplo de `https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053`. ou `https://mykeyvault.vault.azure.net/keys/testkey`. Para ser utilizável, os seguintes pré-requisitos têm de ser cumpridos: A Conta do Batch tem uma identidade Atribuída pelo Sistema Foi concedida à identidade da conta permissões Chave/Obter, Chave/Desembrulhar e Chave/Moldagem O KeyVault tem a proteção de eliminação recuperável e remoção ativada	string

KeyVaultReference

Nome	Descrição	Valor
ID	O ID de recurso do cofre de chaves do Azure associado à conta do Batch.	cadeia (obrigatório)
url	O URL do cofre de chaves do Azure associado à conta do Batch.	cadeia (obrigatório)

NetworkProfile

Nome	Descrição	Valor
accountAccess	Perfil de acesso de rede para o ponto final batchAccount (API do plano de dados da conta do Batch).	EndpointAccessProfile
nodeManagementAccess	Perfil de acesso de rede para o ponto final nodeManagement (serviço batch que gere nós de computação para conjuntos do Batch).	EndpointAccessProfile

EndpointAccessProfile

Nome	Descrição	Valor
defaultAction	Ação predefinida para acesso a pontos finais. Só é aplicável quando publicNetworkAccess está ativado.	"Permitir" "Negar" (obrigatório)
ipRules	Matriz de intervalos de IP para filtrar o endereço IP do cliente.	IPRule[]

IPRule

Nome	Descrição	Valor
action	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 (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Azure Batch conjunto sem endereços IP públicos	Este modelo cria Azure Batch conjunto de comunicação de nós simplificado sem endereços IP públicos.
Criar uma Conta do Batch com um modelo	Este modelo cria uma Conta do Batch e uma conta de armazenamento.

Definição de recurso de modelo do ARM

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

Grupos de recursos – veja comandos de implementação de grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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",
  "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 de recursos	'2023-11-01'
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-24 Carateres válidos: Letras minúsculas e números.
localização	A região em que pretende criar a conta.	cadeia (obrigatório)
etiquetas	As etiquetas especificadas pelo utilizador associadas à conta.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade	A identidade da conta do Batch.	BatchAccountIdentity
propriedades	As propriedades da conta do Batch.	BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade utilizado para a conta do Batch.	"Nenhum" "SystemAssigned" "UserAssigned" (obrigatório)
userAssignedIdentities	A lista de identidades de utilizador associadas à conta do Batch.	BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		UserAssignedIdentities

UserAssignedIdentities

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nome	Descrição	Valor
allowedAuthenticationModes	Lista de modos de autenticação permitidos para a conta do Batch que podem ser utilizados para autenticar com o plano de dados. Isto não afeta a autenticação com o plano de controlo.	Matriz de cadeias que contém qualquer um dos seguintes: 'AAD' "SharedKey" "TaskAuthenticationToken"
autoStorage	As propriedades relacionadas com a conta de armazenamento automático.	AutoStorageBasePropertiesOrAutoStorageProperties
Encriptação	Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.	EncryptionProperties
keyVaultReference	Uma referência ao cofre de chaves do Azure associado à conta do Batch.	KeyVaultReference
networkProfile	O perfil de rede só entra em vigor quando publicNetworkAccess está ativado.	NetworkProfile
poolAllocationMode	O modo de alocação do conjunto também afeta a forma como os clientes podem autenticar-se na API do Serviço Batch. Se o modo for BatchService, os clientes poderão autenticar-se com chaves de acesso ou Microsoft Entra ID. Se o modo for UserSubscription, os clientes têm de utilizar Microsoft Entra ID. A predefinição é BatchService.	"BatchService" "UserSubscription"
publicNetworkAccess	Se não for especificado, o valor predefinido é "ativado".	"Desativado" "Ativado"

AutoStorageBasePropertiesOrAutoStorageProperties

Nome	Descrição	Valor
authenticationMode	O modo de autenticação que o serviço Batch irá utilizar para gerir a conta de armazenamento automático.	"BatchAccountManagedIdentity" "StorageKeys"
nodeIdentityReference	A identidade aqui referenciada tem de ser atribuída a conjuntos que têm nós de computação que precisam de acesso ao armazenamento automático.	ComputeNodeIdentityReference
storageAccountId	O ID de recurso da conta de armazenamento a utilizar para a conta de armazenamento automático.	cadeia (obrigatório)

ComputeNodeIdentityReference

Nome	Descrição	Valor
resourceId	O ID de recurso do ARM da identidade atribuída pelo utilizador.	string

EncryptionProperties

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

KeyVaultProperties

Nome	Descrição	Valor
keyIdentifier	Caminho completo para o segredo com ou sem versão. Exemplo de `https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053`. ou `https://mykeyvault.vault.azure.net/keys/testkey`. Para ser utilizável, têm de ser cumpridos os seguintes pré-requisitos: A Conta do Batch tem uma identidade Atribuída pelo Sistema A identidade da conta recebeu as permissões Key/Get, Key/Unwrap e Key/Wrap O KeyVault tem a proteção contra eliminação recuperável e remoção ativada	string

KeyVaultReference

Nome	Descrição	Valor
ID	O ID de recurso do cofre de chaves do Azure associado à conta do Batch.	cadeia (obrigatório)
url	O URL do cofre de chaves do Azure associado à conta do Batch.	cadeia (obrigatório)

NetworkProfile

Nome	Descrição	Valor
accountAccess	Perfil de acesso de rede para o ponto final batchAccount (API do plano de dados da conta do Batch).	EndpointAccessProfile
nodeManagementAccess	Perfil de acesso de rede para o ponto final nodeManagement (serviço batch que gere nós de computação para conjuntos do Batch).	EndpointAccessProfile

EndpointAccessProfile

Nome	Descrição	Valor
defaultAction	Ação predefinida para acesso a pontos finais. Só é aplicável quando publicNetworkAccess está ativado.	"Permitir" "Negar" (obrigatório)
ipRules	Matriz de intervalos de IP para filtrar o endereço IP do cliente.	IPRule[]

IPRule

Nome	Descrição	Valor
action	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 (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Azure Batch conjunto sem endereços IP públicos	Este modelo cria Azure Batch conjunto de comunicação de nós simplificado sem endereços IP públicos.
Criar uma Conta do Batch com um modelo	Este modelo cria uma Conta do Batch e uma conta de armazenamento.

Definição de recurso terraform (fornecedor AzAPI)

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

Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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"
  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@2023-11-01"
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-24 Carateres válidos: Letras minúsculas e números.
localização	A região em que pretende criar a conta.	cadeia (obrigatório)
parent_id	Para implementar num grupo de recursos, utilize o ID desse grupo de recursos.	cadeia (obrigatório)
etiquetas	As etiquetas especificadas pelo utilizador associadas à conta.	Dicionário de nomes e valores de etiquetas.
identidade	A identidade da conta do Batch.	BatchAccountIdentity
propriedades	As propriedades da conta do Batch.	BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

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

BatchAccountIdentityUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		UserAssignedIdentities

UserAssignedIdentities

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nome	Descrição	Valor
allowedAuthenticationModes	Lista de modos de autenticação permitidos para a conta do Batch que podem ser utilizados para autenticar com o plano de dados. Isto não afeta a autenticação com o plano de controlo.	Matriz de cadeias que contém qualquer um dos seguintes: "AAD" "SharedKey" "TaskAuthenticationToken"
autoStorage	As propriedades relacionadas com a conta de armazenamento automático.	AutoStorageBasePropertiesOrAutoStorageProperties
Encriptação	Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.	EncryptionProperties
keyVaultReference	Uma referência ao cofre de chaves do Azure associado à conta do Batch.	KeyVaultReference
networkProfile	O perfil de rede só entra em vigor quando publicNetworkAccess está ativado.	NetworkProfile
poolAllocationMode	O modo de alocação do conjunto também afeta a forma como os clientes podem autenticar-se na API do Serviço Batch. Se o modo for BatchService, os clientes poderão autenticar-se com chaves de acesso ou Microsoft Entra ID. Se o modo for UserSubscription, os clientes têm de utilizar Microsoft Entra ID. A predefinição é BatchService.	"BatchService" "UserSubscription"
publicNetworkAccess	Se não for especificado, o valor predefinido é "ativado".	"Desativado" "Ativado"

AutoStorageBasePropertiesOrAutoStorageProperties

Nome	Descrição	Valor
authenticationMode	O modo de autenticação que o serviço Batch irá utilizar para gerir a conta de armazenamento automático.	"BatchAccountManagedIdentity" "StorageKeys"
nodeIdentityReference	A identidade aqui referenciada tem de ser atribuída a conjuntos que têm nós de computação que precisam de acesso ao armazenamento automático.	ComputeNodeIdentityReference
storageAccountId	O ID de recurso da conta de armazenamento a utilizar para a conta de armazenamento automático.	cadeia (obrigatório)

ComputeNodeIdentityReference

Nome	Descrição	Valor
resourceId	O ID de recurso do ARM da identidade atribuída pelo utilizador.	string

EncryptionProperties

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

KeyVaultProperties

Nome	Descrição	Valor
keyIdentifier	Caminho completo para o segredo com ou sem versão. Exemplo de `https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053`. ou `https://mykeyvault.vault.azure.net/keys/testkey`. Para ser utilizável, os seguintes pré-requisitos têm de ser cumpridos: A Conta do Batch tem uma identidade Atribuída pelo Sistema Foi concedida à identidade da conta permissões Chave/Obter, Chave/Desembrulhar e Chave/Moldagem O KeyVault tem a proteção de eliminação recuperável e remoção ativada	string

KeyVaultReference

Nome	Descrição	Valor
ID	O ID de recurso do cofre de chaves do Azure associado à conta do Batch.	cadeia (obrigatório)
url	O URL do cofre de chaves do Azure associado à conta do Batch.	cadeia (obrigatório)

NetworkProfile

Nome	Descrição	Valor
accountAccess	Perfil de acesso de rede para o ponto final batchAccount (API do plano de dados da conta do Batch).	EndpointAccessProfile
nodeManagementAccess	Perfil de acesso de rede para o ponto final nodeManagement (serviço batch que gere nós de computação para conjuntos do Batch).	EndpointAccessProfile

EndpointAccessProfile

Nome	Descrição	Valor
defaultAction	Ação predefinida para acesso a pontos finais. Só é aplicável quando publicNetworkAccess está ativado.	"Permitir" "Negar" (obrigatório)
ipRules	Matriz de intervalos de IP para filtrar o endereço IP do cliente.	IPRule[]

IPRule

Nome	Descrição	Valor
action	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 (obrigatório)

Microsoft.Batch batchAccounts

Definição de recurso do Bicep

Formato do recurso

Valores de propriedade

batchAccounts

BatchAccountIdentity

BatchAccountIdentityUserAssignedIdentities

UserAssignedIdentities

BatchAccountCreatePropertiesOrBatchAccountProperties

AutoStorageBasePropertiesOrAutoStorageProperties

ComputeNodeIdentityReference

EncryptionProperties

KeyVaultProperties

KeyVaultReference

NetworkProfile

EndpointAccessProfile

IPRule

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato do recurso

Valores de propriedade

batchAccounts

BatchAccountIdentity

BatchAccountIdentityUserAssignedIdentities

UserAssignedIdentities

BatchAccountCreatePropertiesOrBatchAccountProperties

AutoStorageBasePropertiesOrAutoStorageProperties

ComputeNodeIdentityReference

EncryptionProperties

KeyVaultProperties

KeyVaultReference

NetworkProfile

EndpointAccessProfile

IPRule

Modelos de início rápido

Definição de recurso terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

batchAccounts

BatchAccountIdentity

BatchAccountIdentityUserAssignedIdentities

UserAssignedIdentities

BatchAccountCreatePropertiesOrBatchAccountProperties

AutoStorageBasePropertiesOrAutoStorageProperties

ComputeNodeIdentityReference

EncryptionProperties

KeyVaultProperties

KeyVaultReference

NetworkProfile

EndpointAccessProfile

IPRule

Comentários

Comentários

Recursos adicionais