Freigeben über


Batch Account - Get Keys

Ruft die Kontoschlüssel für das angegebene Batchkonto ab.
Dieser Vorgang gilt nur für Batchkonten mit allowedAuthenticationModes, die "SharedKey" enthalten. Wenn das Batchkonto "SharedKey" nicht in seinem allowedAuthenticationMode enthält, können Clients keine gemeinsamen Schlüssel für die Authentifizierung verwenden und müssen stattdessen eine andere allowedAuthenticationModes verwenden. In diesem Fall schlägt das Abrufen der Schlüssel fehl.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

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

Ein Name für das Batch-Konto, das innerhalb der Region einzigartig sein muss. Batch-Kontonamen müssen zwischen 3 und 24 Zeichen lang sein und dürfen nur Zahlen und Kleinbuchstaben verwenden. Dieser Name wird als Teil des DNS-Namens verwendet, der verwendet wird, um auf den Batch-Service in der Region zuzugreifen, in der das Konto erstellt wurde. Beispiel: http://accountname.region.batch.azure.com/.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string (uuid)

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

minLength: 1

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

BatchAccountKeys

Der Azure-Vorgang wurde erfolgreich abgeschlossen.

Other Status Codes

CloudError

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

BatchAccountGetKeys

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
BatchAccountKeys

Eine Reihe von Azure Batch-Kontoschlüsseln.

CloudError

Eine Fehlerantwort des Batchdiensts.

CloudErrorBody

Eine Fehlerantwort des Batchdiensts.

BatchAccountKeys

Eine Reihe von Azure Batch-Kontoschlüsseln.

Name Typ Beschreibung
accountName

string

Der Name des Batchkontos.

primary

string

Der Primärschlüssel, der dem Konto zugeordnet ist.

secondary

string

Der dem Konto zugeordnete sekundäre Schlüssel.

CloudError

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
error

CloudErrorBody

Der Textkörper der Fehlerantwort.

CloudErrorBody

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt 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 ist.

target

string

Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.