Keys - List By Automation Account

リファレンス

Service:: Automation

API Version:: 2023-11-01

アカウントのオートメーションキーを取得します。

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

URI パラメーター

名前	/	必須	型	説明
automationAccountName	path	True	string	Automation アカウントの名前。
resourceGroupName	path	True	string	Azure リソースグループの名前。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	KeyListResult	OK
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get lists of an automation account

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

定義

名前	説明
AutomationKeyName	オートメーションキー名。
AutomationKeyPermissions	オートメーションキーのアクセス許可。
ErrorResponse	操作エラーのエラー応答
Key	DSC ノードの登録に使用されるオートメーションキー
KeyListResult

AutomationKeyName

オートメーションキー名。

名前	型	説明
Primary	string
Secondary	string

AutomationKeyPermissions

オートメーションキーのアクセス許可。

名前	型	説明
Full	string
Read	string

ErrorResponse

操作エラーのエラー応答

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

Key

DSC ノードの登録に使用されるオートメーションキー

名前	型	説明
KeyName	AutomationKeyName	オートメーションキー名。
Permissions	AutomationKeyPermissions	オートメーションキーのアクセス許可。
Value	string	登録に使用されるオートメーションキーの値。

KeyListResult

名前	型	説明
keys	Key[]	オートメーションキーを一覧表示します。