Keys - List By Automation Account

服務:

Automation

API 版本:

2023-11-01

擷取帳戶的自動化金鑰。

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

URI 參數

名稱	位於	必要	類型	Description
automationAccountName	path	True	string	自動化帳戶的名稱。
resourceGroupName	path	True	string	Azure 資源群組的名稱。 Regex 模式: ^[-\w\._]+$
subscriptionId	path	True	string	取得用來唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	KeyListResult	確定
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get lists of an automation account

範例要求

HTTP

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

範例回覆

狀態碼:

200

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

定義

名稱	Description
AutomationKeyName	自動化金鑰名稱。
AutomationKeyPermissions	自動化金鑰許可權。
ErrorResponse	作業失敗的錯誤回應
Key	用來註冊 DSC 節點的自動化金鑰
KeyListResult

AutomationKeyName

自動化金鑰名稱。

名稱	類型	Description
Primary	string
Secondary	string

AutomationKeyPermissions

自動化金鑰許可權。

名稱	類型	Description
Full	string
Read	string

ErrorResponse

作業失敗的錯誤回應

名稱	類型	Description
code	string	錯誤碼
message	string	錯誤訊息，指出作業失敗的原因。

Key

用來註冊 DSC 節點的自動化金鑰

名稱	類型	Description
KeyName	AutomationKeyName	自動化金鑰名稱。
Permissions	AutomationKeyPermissions	自動化金鑰許可權。
Value	string	用於註冊的自動化金鑰值。

KeyListResult

名稱	類型	Description
keys	Key[]	列出自動化金鑰。