az automation configuration

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.55.0 以降) のオートメーション拡張機能の一部です。拡張機能は、az automation configuration コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

Dsc 構成を管理します。

コマンド

名前	説明	型	Status
az automation configuration create	構成名で識別される構成を作成します。	拡張子	GA
az automation configuration delete	構成名で識別される dsc 構成を削除します。	拡張子	GA
az automation configuration list	構成の一覧を一覧表示します。	拡張子	GA
az automation configuration show	構成名で識別される構成を取得します。	拡張子	GA
az automation configuration show-content	構成名で識別される構成スクリプトを取得します。	拡張子	GA
az automation configuration update	構成名で識別される構成を更新します。	拡張子	GA

az automation configuration create

構成名で識別される構成を作成します。

az automation configuration create --account
                                   --configuration-name
                                   --resource-group
                                   [--description]
                                   [--location]
                                   [--log-progress {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--log-verbose {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--parameters]
                                   [--source]
                                   [--source-hash]
                                   [--source-type {embeddedContent, uri}]
                                   [--source-version]
                                   [--tags]

例

サーバーをセットアップする DSC 構成を作成する

az automation configuration create -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {
Node localhost {
WindowsFeature IIS {
Name = "Web-Server";
Ensure = "Present"
}
}
}"

必須のパラメーター

--account --automation-account-name

Automation アカウントの名前。

--configuration-name --name -n

構成の作成または更新パラメーター。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--description

構成の説明を取得します。値の設定も可能です。

--location

リソースの場所を取得または設定します。

--log-progress

進行状況ログオプションを取得または設定します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--log-verbose

詳細ログオプションを取得または設定します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--parameters

構成パラメーターを取得または設定します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--source

コンテンツの値を取得または設定します。これは、コンテンツソースの種類に基づいています。

--source-hash

ハッシュを取得または設定します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--source-type

コンテンツソースの種類を取得または設定します。

承認された値: embeddedContent, uri

--source-version

コンテンツのバージョンを取得または設定します。

--tags

リソースにアタッチされているタグを取得または設定します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az automation configuration delete

構成名で識別される dsc 構成を削除します。

az automation configuration delete [--account]
                                   [--configuration-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

例

DSC 構成を削除する

az automation configuration list -g rg --automation-account-name myAutomationAccount

省略可能のパラメーター

--account --automation-account-name

Automation アカウントの名前。

--configuration-name --name -n

構成の名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az automation configuration list

構成の一覧を一覧表示します。

az automation configuration list --account
                                 --resource-group
                                 [--filter]
                                 [--inlinecount]
                                 [--max-items]
                                 [--next-token]
                                 [--skip]
                                 [--top]

例

すべての DSC 構成を一覧表示する

az automation configuration list -g rg --automation-account-name myAutomationAccount

必須のパラメーター

--account --automation-account-name

Automation アカウントの名前。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--filter

操作に適用するフィルター。

--inlinecount

合計行数を返します。

--max-items

コマンドの出力で返される項目の合計数。使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。これは、以前に切り捨てられた応答からのトークン値です。

--skip

スキップする行の数。

--top

取得する行の数。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az automation configuration show

構成名で識別される構成を取得します。

az automation configuration show [--account]
                                 [--configuration-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

例

構成を名前で取得する

az automation configuration show -g rg --automation-account-name myAutomationAccount -n SetupServer

省略可能のパラメーター

--account --automation-account-name

Automation アカウントの名前。

--configuration-name --name -n

構成の名前。

--ids

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az automation configuration show-content

構成名で識別される構成スクリプトを取得します。

az automation configuration show-content [--account]
                                         [--configuration-name]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

例

DSC 構成のスクリプトコンテンツを表示する

az automation configuration show-content -g rg --automation-account-name myAutomationAccount -n SetupServer

省略可能のパラメーター

--account --automation-account-name

Automation アカウントの名前。

--configuration-name --name -n

構成の名前。

--ids

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az automation configuration update

構成名で識別される構成を更新します。

az automation configuration update [--account]
                                   [--add]
                                   [--configuration-name]
                                   [--description]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--location]
                                   [--log-progress {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--log-verbose {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--parameters]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--source]
                                   [--source-hash]
                                   [--source-type {embeddedContent, uri}]
                                   [--source-version]
                                   [--subscription]
                                   [--tags]

例

DSC 構成でのスクリプトの更新

az automation configuration update -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {
Node localhostServer {
WindowsFeature IIS {
Name = "Web-Server";
Ensure = "Present"
}
}
}"

省略可能のパラメーター

--account --automation-account-name

Automation アカウントの名前。

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value、string、または JSON 文字列>。

--configuration-name --name -n

構成の名前。

--description

構成の説明を取得します。値の設定も可能です。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--ids

--location

リソースの場所を取得または設定します。

--log-progress

進行状況ログオプションを取得または設定します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--log-verbose

詳細ログオプションを取得または設定します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--parameters

構成パラメーターを取得または設定します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=。

--source

コンテンツの値を取得または設定します。これは、コンテンツソースの種類に基づいています。

--source-hash

ハッシュを取得または設定します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--source-type

コンテンツソースの種類を取得または設定します。

承認された値: embeddedContent, uri

--source-version

コンテンツのバージョンを取得または設定します。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az automation configuration

コマンド

az automation configuration create

例

必須のパラメーター

省略可能のパラメーター

az automation configuration delete

例

省略可能のパラメーター

az automation configuration list

例

必須のパラメーター

省略可能のパラメーター

az automation configuration show

例

省略可能のパラメーター

az automation configuration show-content

例

省略可能のパラメーター

az automation configuration update

例

省略可能のパラメーター

その他のリソース