Keys - List By Automation Account

Referenz

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 Automation-Kontos.
resourceGroupName	path	True	string	Name einer Azure-Ressourcengruppe. RegEx-Muster: `^[-\w\._]+$`
subscriptionId	path	True	string	Ruft die 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	OK
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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	Automatisierungsschlüsselberechtigungen.
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
Key	Automatisierungsschlüssel, der zum Registrieren eines DSC-Knotens verwendet wird
KeyListResult

AutomationKeyName

Name des Automatisierungsschlüssels.

Name	Typ	Beschreibung
Primary	string
Secondary	string

AutomationKeyPermissions

Automatisierungsschlüsselberechtigungen.

Name	Typ	Beschreibung
Full	string
Read	string

ErrorResponse

Fehlerantwort eines Vorgangsfehlers

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

Key

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

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

KeyListResult

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

Freigeben über