Keys - List By Automation Account

Dienst:

Automation

API-Version:

2023-11-01

Rufen Sie die Automatisierungsschlüssel für ein Konto ab.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listKeys?api-version=2023-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automatisierungskontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Name einer Azure-Ressourcengruppe.
subscriptionId	path	True	string	Ruft Abonnementanmeldeinformationen ab, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	KeyListResult	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

Get lists of an automation account

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyAutomationAccount/listKeys?api-version=2023-11-01

Beispiel für eine Antwort

Statuscode:

200

{
  "keys": [
    {
      "KeyName": "Primary",
      "Permissions": "Full",
      "Value": "**************************************************************"
    },
    {
      "KeyName": "Secondary",
      "Permissions": "Full",
      "Value": "**************************************************************"
    }
  ]
}

Definitionen

Name	Beschreibung
AutomationKeyName	Name des Automatisierungsschlüssels.
AutomationKeyPermissions	Berechtigungen für Automatisierungsschlüssel.
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
Key	Automatisierungsschlüssel, der zum Registrieren eines DSC-Knotens verwendet wird
KeyListResult

AutomationKeyName

Enumeration

Name des Automatisierungsschlüssels.

Wert	Beschreibung
Primary
Secondary

AutomationKeyPermissions

Enumeration

Berechtigungen für Automatisierungsschlüssel.

Wert	Beschreibung
Full
Read

ErrorResponse

Objekt

Fehlerantwort eines Vorgangsfehlers

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Key

Objekt

Automatisierungsschlüssel, der zum Registrieren eines DSC-Knotens verwendet wird

Name	Typ	Beschreibung
KeyName	AutomationKeyName	Name des Automatisierungsschlüssels.
Permissions	AutomationKeyPermissions	Berechtigungen für Automatisierungsschlüssel.
Value	string	Wert des für die Registrierung verwendeten Automatisierungsschlüssels.

KeyListResult

Objekt

Name	Typ	Beschreibung
keys	Key[]	Listet die Automatisierungsschlüssel auf.