Batch Account - Get

Serviço:: Batch Management

Versão API:: 2025-06-01

Obtém informações sobre a conta de lote especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}?api-version=2025-06-01

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	O nome da conta Batch.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém a conta Batch.
subscriptionId	path	True	string	O ID da subscrição do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-00000000000000)
api-version	query	True	string	A versão da API a ser usada com a solicitação HTTP.

Respostas

Nome	Tipo	Descrição
200 OK	BatchAccount	A operação foi bem sucedida. A resposta contém a entidade da conta Batch.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo de código de autenticação do Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Pedido de exemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2025-06-01

Resposta de exemplo

Código de estado:: 200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2025-07-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

PrivateBatchAccountGet

Pedido de exemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2025-06-01

Resposta de exemplo

Código de estado:: 200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2025-07-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Approved by xyz.abc@company.com"
          }
        }
      }
    ]
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definições

Nome	Descrição
AuthenticationMode	O modo de autenticação para a conta Batch.
AutoStorageAuthenticationMode	O modo de autenticação que o serviço Batch usará para gerenciar a conta de armazenamento automático.
AutoStorageProperties	Contém informações sobre a conta de armazenamento automático associada a uma conta de lote.
BatchAccount	Contém informações sobre uma conta do Azure Batch.
BatchAccountIdentity	A identidade da conta Batch, se configurada. Isso é usado quando o usuário especifica 'Microsoft.KeyVault' como sua configuração de criptografia de conta em lote ou quando `ManagedIdentity` é selecionado como o modo de autenticação de armazenamento automático.
CloudError	Uma resposta de erro do serviço em lote.
CloudErrorBody	Uma resposta de erro do serviço em lote.
ComputeNodeIdentityReference	A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
EncryptionProperties	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.
EndpointAccessDefaultAction	A ação padrão quando não há IPRule correspondente.
EndpointAccessProfile	Perfil de acesso à rede para o ponto de extremidade Batch.
IPRule	Regra para filtrar o endereço IP do cliente.
IPRuleAction	Ação quando o endereço IP do cliente é correspondido.
KeySource	Tipo da fonte da chave.
KeyVaultProperties	Configuração do KeyVault ao usar uma criptografia KeySource do Microsoft.KeyVault.
KeyVaultReference	Identifica o cofre de chaves do Azure associado a uma conta de lote.
NetworkProfile	Perfil de rede para conta de lote, que contém configurações de regra de rede para cada ponto de extremidade.
PoolAllocationMode	O modo de alocação para criar pools na conta de lote.
PrivateEndpoint	O ponto de extremidade privado da conexão de ponto de extremidade privado.
PrivateEndpointConnection	Contém informações sobre um recurso de link privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	O estado da conexão do serviço de link privado da conexão de ponto de extremidade privado
PrivateLinkServiceConnectionStatus	O status da conexão de ponto de extremidade privado em lote
ProvisioningState	O estado provisionado do recurso
PublicNetworkAccessType	O tipo de acesso à rede para operar nos recursos na conta Batch.
ResourceIdentityType	O tipo de identidade usado para a conta Batch.
UserAssignedIdentities	A lista de identidades de usuário associadas.
VirtualMachineFamilyCoreQuota	Uma família VM e sua cota principal associada para a conta Batch.

AuthenticationMode

Enumeração

O modo de autenticação para a conta Batch.

Valor	Descrição
SharedKey	O modo de autenticação usando chaves compartilhadas.
AAD	O modo de autenticação usando o Microsoft Entra ID.
TaskAuthenticationToken	O modo de autenticação usando tokens de autenticação de tarefa.

AutoStorageAuthenticationMode

Enumeração

O modo de autenticação que o serviço Batch usará para gerenciar a conta de armazenamento automático.

Valor	Descrição
StorageKeys	O serviço Batch autenticará solicitações para armazenamento automático usando chaves de conta de armazenamento.
BatchAccountManagedIdentity	O serviço Lote autenticará solicitações para armazenamento automático usando a identidade gerenciada atribuída à conta Batch.

AutoStorageProperties

Objetivo

Contém informações sobre a conta de armazenamento automático associada a uma conta de lote.

Nome	Tipo	Valor padrão	Descrição
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	O modo de autenticação que o serviço Batch usará para gerenciar a conta de armazenamento automático.
lastKeySync	string (date-time)		A hora UTC em que as chaves de armazenamento foram sincronizadas pela última vez com a conta Batch.
nodeIdentityReference	ComputeNodeIdentityReference		A referência à identidade atribuída ao usuário que os nós de computação usarão para acessar o armazenamento automático. 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.
storageAccountId	string (arm-id)		O ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático.

BatchAccount

Objetivo

Contém informações sobre uma conta do Azure Batch.

Nome	Tipo	Valor padrão	Descrição
id	string		A ID do recurso.
identity	BatchAccountIdentity		A identidade da conta Batch.
location	string		A localização do recurso.
name	string		O nome do recurso.
properties.accountEndpoint	string		O ponto de extremidade da conta usado para interagir com o serviço Batch.
properties.activeJobAndJobScheduleQuota	integer (int32)		A cota ativa de trabalho e agenda de trabalho para a conta Batch.
properties.allowedAuthenticationModes	AuthenticationMode[]		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.
properties.autoStorage	AutoStorageProperties		As propriedades e o status de qualquer conta de armazenamento automático associada à conta de lote. Contém informações sobre a conta de armazenamento automático associada a uma conta de lote.
properties.dedicatedCoreQuota	integer (int32)		A cota principal dedicada para a conta Batch. Para contas com PoolAllocationMode definido como UserSubscription, a cota é gerenciada na assinatura para que esse valor não seja retornado.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Uma lista da cota principal dedicada por família de Máquina Virtual para a conta de lote. Para contas com PoolAllocationMode definido como UserSubscription, a cota é gerenciada na assinatura para que esse valor não seja retornado.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Um valor que indica se as cotas principais por família de máquinas virtuais são impostas para essa conta Se esse sinalizador for true, a cota principal dedicada será imposta por meio das propriedades dedicatedCoreQuotaPerVMFamily e dedicatedCoreQuota na conta. Se esse sinalizador for falso, a cota principal dedicada será imposta somente por meio da propriedade dedicatedCoreQuota na conta e não considerará a família de máquinas virtuais.
properties.encryption	EncryptionProperties		A configuração de criptografia para a conta Batch. 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.
properties.keyVaultReference	KeyVaultReference		Uma referência ao cofre de chaves do Azure associado à conta Batch. Identifica o cofre de chaves do Azure associado a uma conta de lote.
properties.lowPriorityCoreQuota	integer (int32)		A cota principal spot/de baixa prioridade para a conta Batch. Para contas com PoolAllocationMode definido como UserSubscription, a cota é gerenciada na assinatura para que esse valor não seja retornado.
properties.networkProfile	NetworkProfile		Perfil de rede para conta de lote, que contém configurações de regra de rede para cada ponto de extremidade. O perfil de rede só entra em vigor quando publicNetworkAccess está habilitado.
properties.nodeManagementEndpoint	string		O ponto de extremidade usado pelo nó de computação para se conectar ao serviço de gerenciamento do nó em lote.
properties.poolAllocationMode	PoolAllocationMode		O modo de alocação a ser usado para criar pools na conta de lote. O modo de alocação para criar pools na conta de lote.
properties.poolQuota	integer (int32)		A cota de pool para a conta de lote.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privadas associadas à conta Batch
properties.provisioningState	ProvisioningState		O estado provisionado do recurso
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	O tipo de interface de rede para acessar o serviço Batch do Azure e as operações da conta Batch. Se não for especificado, o valor padrão será 'enabled'.
tags	object		As tags do recurso.
type	string		O tipo do recurso.

BatchAccountIdentity

Objetivo

A identidade da conta Batch, se configurada. Isso é usado quando o usuário especifica 'Microsoft.KeyVault' como sua configuração de criptografia de conta em lote ou quando ManagedIdentity é selecionado como o modo de autenticação de armazenamento automático.

Nome	Tipo	Descrição
principalId	string	O ID principal da conta Batch. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string	A ID do locatário associada à conta do lote. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ResourceIdentityType	O tipo de identidade usado para a conta Batch.
userAssignedIdentities	<string, UserAssignedIdentities>	A lista de identidades de usuário associadas à conta Batch.

CloudError

Objetivo

Uma resposta de erro do serviço em lote.

Nome	Tipo	Descrição
error	CloudErrorBody	O corpo da resposta de erro.

CloudErrorBody

Objetivo

Uma resposta de erro do serviço em lote.

Nome	Tipo	Descrição
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

ComputeNodeIdentityReference

Objetivo

A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.

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

EncryptionProperties

Objetivo

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.

Nome	Tipo	Descrição
keySource	KeySource	Tipo da fonte da chave.
keyVaultProperties	KeyVaultProperties	Detalhes adicionais ao usar Microsoft.KeyVault

EndpointAccessDefaultAction

Enumeração

A ação padrão quando não há IPRule correspondente.

Valor	Descrição
Allow	Permitir acesso de cliente.
Deny	Negar acesso de cliente.

EndpointAccessProfile

Objetivo

Perfil de acesso à rede para o ponto de extremidade Batch.

Nome	Tipo	Descrição
defaultAction	EndpointAccessDefaultAction	A ação padrão quando não há IPRule correspondente. Ação padrão para acesso ao ponto final. Ele só é aplicável quando publicNetworkAccess está habilitado.
ipRules	IPRule[]	Matriz de intervalos IP para filtrar o endereço IP do cliente.

IPRule

Objetivo

Regra para filtrar o endereço IP do cliente.

Nome	Tipo	Descrição
action	IPRuleAction	Ação quando o endereço IP do cliente é correspondido.
value	string	O endereço IP ou intervalo de endereços IP a filtrar Endereço IPv4 ou intervalo de endereços IPv4 no formato CIDR.

IPRuleAction

Enumeração

Ação quando o endereço IP do cliente é correspondido.

Valor	Descrição
Allow	Permita o acesso para o endereço IP do cliente correspondente.

KeySource

Enumeração

Tipo da fonte da chave.

Valor	Descrição
Microsoft.Batch	O Batch cria e gerencia as chaves de criptografia usadas para proteger os dados da conta.
Microsoft.KeyVault	As chaves de criptografia usadas para proteger os dados da conta são armazenadas em um cofre de chaves externo. Se isso for definido, a identidade da conta em lote deve ser definida como `SystemAssigned` e um identificador de chave válido também deve ser fornecido sob keyVaultProperties.

KeyVaultProperties

Objetivo

Configuração do KeyVault ao usar uma criptografia KeySource do Microsoft.KeyVault.

Nome Tipo Descrição

keyIdentifier

Nome	Tipo	Descrição
keyIdentifier	string	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 pelo 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 habilitada

string

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 pelo 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 habilitada

KeyVaultReference

Objetivo

Identifica o cofre de chaves do Azure associado a uma conta de lote.

Nome	Tipo	Descrição
id	string (arm-id)	A ID do recurso do cofre de chaves do Azure associado à conta Batch.
url	string	A URL do cofre de chaves do Azure associado à conta de lote.

NetworkProfile

Objetivo

Perfil de rede para conta de lote, que contém configurações de regra de rede para cada ponto de extremidade.

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

PoolAllocationMode

Enumeração

O modo de alocação para criar pools na conta de lote.

Valor	Descrição
BatchService	Os pools serão alocados em assinaturas de propriedade do serviço Batch.
UserSubscription	Os pools serão alocados em uma assinatura de propriedade do usuário.

PrivateEndpoint

Objetivo

O ponto de extremidade privado da conexão de ponto de extremidade privado.

Nome	Tipo	Descrição
id	string	O identificador de recurso ARM do ponto de extremidade privado. Este é o formato /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Objetivo

Contém informações sobre um recurso de link privado.

Nome	Tipo	Descrição
etag	string	O ETag do recurso, usado para instruções de simultaneidade.
id	string	A ID do recurso.
name	string	O nome do recurso.
properties.groupIds	string[]	A ID de grupo da conexão de ponto de extremidade privada. O valor tem um e apenas um ID de grupo.
properties.privateEndpoint	PrivateEndpoint	O identificador de recurso ARM do ponto de extremidade privado. O ponto de extremidade privado da conexão de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	O estado da conexão do serviço de link privado da conexão de ponto de extremidade privado. O estado da conexão do serviço de link privado da conexão de ponto de extremidade privado
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento da conexão de ponto de extremidade privado.
tags	object	As tags do recurso.
type	string	O tipo do recurso.

PrivateEndpointConnectionProvisioningState

Enumeração

O estado de provisionamento da conexão de ponto de extremidade privado.

Valor	Descrição
Creating	A conexão está criando.
Updating	O usuário solicitou que o status da conexão fosse atualizado, mas a operação de atualização ainda não foi concluída. Você não pode fazer referência à conexão ao conectar a conta Batch.
Deleting	A conexão está sendo excluída.
Succeeded	O status da conexão é final e está pronto para uso se Status for Aprovado.
Failed	O usuário solicitou que a conexão fosse atualizada e falhou. Você pode tentar novamente a operação de atualização.
Cancelled	O usuário cancelou a criação da conexão.

PrivateLinkServiceConnectionState

Objetivo

O estado da conexão do serviço de link privado da conexão de ponto de extremidade privado

Nome	Tipo	Descrição
actionsRequired	string	Ação necessária no estado da conexão privada
description	string	Descrição do estado de conexão privada
status	PrivateLinkServiceConnectionStatus	O estado da ligação ao endpoint privado da conta Batch

PrivateLinkServiceConnectionStatus

Enumeração

O status da conexão de ponto de extremidade privado em lote

Valor	Descrição
Approved	A conexão de ponto de extremidade privada é aprovada e pode ser usada para acessar a conta Batch
Pending	A conexão de ponto de extremidade privado está pendente e não pode ser usada para acessar a conta de lote
Rejected	A conexão de ponto de extremidade privado é rejeitada e não pode ser usada para acessar a conta de lote
Disconnected	A conexão de ponto de extremidade privada está desconectada e não pode ser usada para acessar a conta de lote

ProvisioningState

Enumeração

O estado provisionado do recurso

Valor	Descrição
Invalid	A conta está em um estado inválido.
Creating	A conta está a ser criada.
Deleting	A conta está a ser eliminada.
Succeeded	A conta foi criada e está pronta para uso.
Failed	A última operação para a conta falhou.
Cancelled	A última operação para a conta é cancelada.

PublicNetworkAccessType

Enumeração

O tipo de acesso à rede para operar nos recursos na conta Batch.

Valor	Descrição
Enabled	Habilita a conectividade com o Azure Batch por meio de DNS público.
Disabled	Desabilita a conectividade pública e habilita a conectividade privada com o Serviço de Lote do Azure por meio do recurso de ponto de extremidade privado.
SecuredByPerimeter	Protege a conectividade com o Azure Batch por meio da configuração NSP.

ResourceIdentityType

Enumeração

O tipo de identidade usado para a conta Batch.

Valor	Descrição
SystemAssigned	A conta de lote tem uma identidade atribuída ao sistema.
UserAssigned	A conta em lote tem identidades atribuídas ao usuário.
None	A conta de lote não tem nenhuma identidade associada a ela. Definir `None` na conta de atualização removerá as identidades existentes.

UserAssignedIdentities

Objetivo

A lista de identidades de usuário associadas.

Nome	Tipo	Descrição
clientId	string	O ID do cliente da identidade atribuída ao usuário.
principalId	string	O id principal da identidade atribuída ao usuário.

VirtualMachineFamilyCoreQuota

Objetivo

Uma família VM e sua cota principal associada para a conta Batch.

Nome	Tipo	Descrição
coreQuota	integer (int32)	A cota principal para a família VM para a conta Batch.
name	string	O nome da família da Máquina Virtual.

Partilhar via

Batch Account - Get

Parâmetros URI

Respostas

Segurança

azure_auth

Alcances

Exemplos

BatchAccountGet

Pedido de exemplo

Resposta de exemplo

PrivateBatchAccountGet

Pedido de exemplo

Resposta de exemplo

Definições

AuthenticationMode

AutoStorageAuthenticationMode

AutoStorageProperties

BatchAccount

BatchAccountIdentity

CloudError

CloudErrorBody

ComputeNodeIdentityReference

EncryptionProperties

EndpointAccessDefaultAction

EndpointAccessProfile

IPRule

IPRuleAction

KeySource

KeyVaultProperties

KeyVaultReference

NetworkProfile

PoolAllocationMode

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccessType

ResourceIdentityType

UserAssignedIdentities

VirtualMachineFamilyCoreQuota