Compartilhar via

Batch Account - Get Keys

Serviço:
Batch Management
Versão da API:
2025-06-01

Obtém as chaves de conta da conta do Lote especificada.
Essa operação se aplica somente a contas do Lote com allowedAuthenticationModes contendo 'SharedKey'. Se a conta do Lote não contiver 'SharedKey' em seu allowedAuthenticationMode, os clientes não poderão usar chaves compartilhadas para autenticar e devem usar outro allowedAuthenticationModes. Nesse caso, a obtenção das chaves falhará.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
 path True

string

minLength: 3
maxLength: 24
pattern: ^[a-zA-Z0-9]+$

O nome da conta do Lote.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém a conta do Lote.
subscriptionId
 path True

string

A ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000)
api-version
 query True

string

A versão da API a ser usada com a solicitação HTTP.

Respostas

Nome Tipo Description
200 OK

BatchAccountKeys

A operação foi bem-sucedida. A resposta contém as chaves da conta do lote.
Other Status Codes

CloudError

Resposta de erro que descreve 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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

BatchAccountGetKeys

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "accountName": "sampleacct",
  "primary": "AAAA==",
  "secondary": "BBBB=="
}

Definições

Nome Description
BatchAccountKeys

Um conjunto de chaves de conta do Lote do Azure.
CloudError

Uma resposta de erro do serviço do Lote.
CloudErrorBody

Uma resposta de erro do serviço do Lote.

BatchAccountKeys

Objeto

Um conjunto de chaves de conta do Lote do Azure.

Nome Tipo Description
accountName

string

O nome da conta do Lote.
primary

string

A chave primária associada à conta.
secondary

string

A chave secundária associada à conta.

CloudError

Objeto

Uma resposta de erro do serviço do Lote.

Nome Tipo Description
error

CloudErrorBody

O corpo da resposta de erro.

CloudErrorBody

Objeto

Uma resposta de erro do serviço do Lote.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.
message

string

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.