Batch Account - Get Keys

Ruft die Kontoschlüssel für das angegebene Batch-Konto ab.
Dieser Vorgang gilt nur für Batch-Konten mit allowedAuthenticationModes, die "SharedKey" enthalten. Wenn das Batch-Konto "SharedKey" in seiner allowedAuthenticationMode nicht enthält, können Clients keine freigegebenen Schlüssel zum Authentifizieren verwenden und müssen stattdessen einen anderen allowedAuthenticationModes verwenden. In diesem Fall tritt beim Abrufen der Schlüssel ein Fehler auf.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

Der Name des Batch-Kontos.

Regex pattern: ^[a-zA-Z0-9]+$

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die das Batch-Konto enthält.

subscriptionId
path True

string

Die Azure-Abonnement-ID. Dies ist eine GUID-formatierte Zeichenfolge (z. B. 000000000-0000-0000-000000000000000000000)

api-version
query True

string

Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

BatchAccountKeys

Der Vorgang wurde durchgeführt. Die Antwort enthält die Schlüssel des Batch-Kontos.

Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

BatchAccountGetKeys

Sample Request

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

Sample Response

{
  "accountName": "sampleacct",
  "primary": "AAAA==",
  "secondary": "BBBB=="
}

Definitionen

Name Beschreibung
BatchAccountKeys

Eine Gruppe von Azure Batch Kontoschlüsseln.

CloudError

Eine Fehlerantwort des Batch-Diensts.

CloudErrorBody

Eine Fehlerantwort des Batch-Diensts.

BatchAccountKeys

Eine Gruppe von Azure Batch Kontoschlüsseln.

Name Typ Beschreibung
accountName

string

Der Name des Batch-Kontos.

primary

string

Der dem Konto zugeordnete Primärschlüssel.

secondary

string

Der dem Konto zugeordnete sekundäre Schlüssel.

CloudError

Eine Fehlerantwort des Batch-Diensts.

Name Typ Beschreibung
error

CloudErrorBody

Der Text der Fehlerantwort.

CloudErrorBody

Eine Fehlerantwort des Batch-Diensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

target

string

Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.