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 パラメーター

名前	/	必須	型	説明
automationAccountName	path	True	string	Automation アカウントの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Azure リソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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": "**************************************************************"
    }
  ]
}

定義

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

AutomationKeyName

列挙

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

値	説明
Primary
Secondary

AutomationKeyPermissions

列挙

Automation キーのアクセス許可。

値	説明
Full
Read

ErrorResponse

Object

操作エラーのエラー応答

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

Key

Object

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

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

KeyListResult

Object

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