az resource

Azure のリソースを管理します。

コマンド

名前	説明	型	状態
az resource create	リソースを作成する。	コア	GA
az resource delete	リソースを削除します。	コア	GA
az resource invoke-action	リソースに対してアクションを呼び出します。	コア	GA
az resource link	リソース間のリンクを管理します。	コア	GA
az resource link create	リソース間に新しいリンクを作成します。	コア	GA
az resource link delete	リソース間のリンクを削除します。	コア	GA
az resource link list	リソース リンクを一覧表示します。	コア	GA
az resource link show	指定した ID を持つリソース リンクを取得します。	コア	GA
az resource link update	リソース間のリンクを更新します。	コア	GA
az resource list	リソースの一覧を表示します。	コア	GA
az resource lock	Azure リソース レベルのロックを管理します。	コア	GA
az resource lock create	リソース レベルのロックを作成します。	コア	GA
az resource lock delete	リソース レベルのロックを削除します。	コア	GA
az resource lock list	リソース レベルでロック情報を一覧表示します。	コア	GA
az resource lock show	リソース レベルのロックの詳細を表示します。	コア	GA
az resource lock update	リソース レベルのロックを更新します。	コア	GA
az resource move	あるリソース グループから別のリソース グループにリソースを移動します (異なるサブスクリプションの下に配置できます)。	コア	GA
az resource patch	PATCH 要求によってリソースを更新します。	コア	GA
az resource show	リソースの詳細を取得します。	コア	GA
az resource tag	リソースにタグを付け。	コア	GA
az resource update	PUT 要求によってリソースを更新します。	コア	GA
az resource wait	リソースの条件が満たされるまで、CLI を待機状態にします。	コア	GA

az resource create

リソースを作成する。

az resource create --properties
                   [--api-version]
                   [--id]
                   [--is-full-object]
                   [--latest-include-preview]
                   [--location]
                   [--name]
                   [--namespace]
                   [--parent]
                   [--resource-group]
                   [--resource-type]

例

完全な JSON 構成を提供して API アプリを作成します。

az resource create -g myRG -n myApiApp --resource-type Microsoft.web/sites \
    --is-full-object --properties "{ \"kind\": \"api\", \"location\": \
        \"West US\", \"properties\": { \"serverFarmId\": \
            \"/subscriptions/{SubID}/resourcegroups/{ResourceGroup} \
                /providers/Microsoft.Web/serverfarms/{ServicePlan}\" } }"

ファイルから JSON 構成を読み込んでリソースを作成します。

az resource create -g myRG -n myApiApp --resource-type Microsoft.web/sites --is-full-object --properties @jsonConfigFile

最低限必要な構成情報を含む Web アプリを作成します。

az resource create -g myRG -n myWeb --resource-type Microsoft.web/sites \
    --properties "{ \"serverFarmId\":\"/subscriptions/{SubID}/resourcegroups/ \
        {ResourceGroup}/providers/Microsoft.Web/serverfarms/{ServicePlan}\" }"

このバージョンがプレビュー バージョンであるかどうかに関係なく、最新の API バージョンを使用してリソースを作成します。

az resource create -g myRG -n myApiApp --resource-type Microsoft.web/sites --is-full-object --properties @jsonConfigFile --latest-include-preview

Web アプリへのサイト拡張機能を作成する

az resource create -g myRG --api-version "2018-02-01" \
    --name "{sitename+slot}/siteextensions/Contrast.NetCore.Azure.SiteExtension"  \
        --resource-type Microsoft.Web/sites/siteextensions --is-full-object \
            --properties "{ \"id\": \"Contrast.NetCore.Azure.SiteExtension\", \
                \"location\": \"West US\", \"version\": \"1.9.0\" }"

必須のパラメーター

--properties -p

リソース プロパティを含む JSON 形式の文字列。

省略可能のパラメーター

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--id

リソースの ID

--is-full-object

プロパティ オブジェクトに、場所、タグ、SKU、プランなどの他のオプションが含まれていることを示します。

規定値: False

--latest-include-preview -v

プレビュー

プレビュー バージョン (2020-01-01-preview など) であるかどうかに関係なく、最新の API バージョンが使用されることを示します。 たとえば、サポートされている API バージョンのリソース プロバイダーが 2020-01-01-preview および 2019-01-01 の場合:このパラメーターを渡すと、最新バージョン 2020-01-01-preview が適用されます。それ以外の場合、このパラメーターを渡さずに最新の安定バージョン 2019-01-01 が使用されます。

規定値: False

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--parent

親パス (例: 'resA/myA/resB/myB')。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

グローバル パラメーター

--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 resource delete

リソースを削除します。

az resource delete [--api-version]
                   [--ids]
                   [--latest-include-preview]
                   [--name]
                   [--namespace]
                   [--no-wait]
                   [--parent]
                   [--resource-group]
                   [--resource-type]

例

"MyVm" という名前の仮想マシンを削除します。

az resource delete -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines"

リソース識別子を使用して Web アプリを削除します。

az resource delete --ids /subscriptions/0b1f6471-1bf0-4dda-aec3-111111111111/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/MyWebapp

リソース識別子を使用してサブネットを削除します。

az resource delete --ids /subscriptions/0b1f6471-1bf0-4dda-aec3-111111111111/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MySubnet

"MyVm" という名前の仮想マシンを削除します。このバージョンがプレビュー バージョンであるかどうかは、最新の API バージョンを使用します。

az resource delete -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines" --latest-include-preview

省略可能のパラメーター

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 指定した場合は、他の "リソース ID" 引数を指定しないでください。

--latest-include-preview -v

プレビュー

プレビュー バージョン (2020-01-01-preview など) であるかどうかに関係なく、最新の API バージョンが使用されることを示します。 たとえば、サポートされている API バージョンのリソース プロバイダーが 2020-01-01-preview および 2019-01-01 の場合:このパラメーターを渡すと、最新バージョン 2020-01-01-preview が適用されます。それ以外の場合、このパラメーターを渡さずに最新の安定バージョン 2019-01-01 が使用されます。

規定値: False

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--parent

親パス (例: 'resA/myA/resB/myB')。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

グローバル パラメーター

--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 resource invoke-action

リソースに対してアクションを呼び出します。

リソースに対応する可能なアクションの一覧は https://docs.microsoft.com/rest/api/、 すべての POST 要求は、呼び出すことができるアクションであり、URI パスの末尾に指定されます。 たとえば、VM を停止するには、要求 URI が https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroup}/providers/Microsoft.Compute/virtualMachines/{VM}/powerOff?api-version={APIVersion} 指定され、対応するアクションは powerOff. これはで見つけることができます https://docs.microsoft.com/rest/api/compute/virtualmachines/virtualmachines-stop.

az resource invoke-action --action
                          [--api-version]
                          [--ids]
                          [--latest-include-preview]
                          [--name]
                          [--namespace]
                          [--no-wait]
                          [--parent]
                          [--request-body]
                          [--resource-group]
                          [--resource-type]

例

ID で指定された VM の電源をオフにします。

az resource invoke-action --action powerOff \
  --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Compute/virtualMachines/{VMName}

停止した VM の情報をキャプチャします。

az resource invoke-action --action capture \
  --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/ \
    Microsoft.Compute/virtualMachines/{VMName} \
  --request-body "{ \"vhdPrefix\": \"myPrefix\", \"destinationContainerName\": \
    \"myContainer\", \"overwriteVhds\": true }"

リソースに対してアクションを呼び出します。 (自動生成)

az resource invoke-action --action capture --name MyResource --resource-group MyResourceGroup --resource-type Microsoft.web/sites

必須のパラメーター

--action

指定したリソースで呼び出されるアクション。

省略可能のパラメーター

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 指定した場合は、他の "リソース ID" 引数を指定しないでください。

--latest-include-preview -v

プレビュー

プレビュー バージョン (2020-01-01-preview など) であるかどうかに関係なく、最新の API バージョンが使用されることを示します。 たとえば、サポートされている API バージョンのリソース プロバイダーが 2020-01-01-preview および 2019-01-01 の場合:このパラメーターを渡すと、最新バージョン 2020-01-01-preview が適用されます。それ以外の場合、このパラメーターを渡さずに最新の安定バージョン 2019-01-01 が使用されます。

規定値: False

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--parent

親パス (例: 'resA/myA/resB/myB')。

--request-body

要求後の本文で渡されるアクションの JSON でエンコードされたパラメーター引数。 @{file} を使用してファイルから読み込みます。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

グローバル パラメーター

--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 resource list

リソースの一覧を表示します。

az resource list [--location]
                 [--name]
                 [--namespace]
                 [--resource-group]
                 [--resource-type]
                 [--tag]

例

米国西部リージョンのすべてのリソースを一覧表示します。

az resource list --location westus

"resourceName" という名前のすべてのリソースを一覧表示します。

az resource list --name 'resourceName'

タグ 'test' を持つすべてのリソースを一覧表示します。

az resource list --tag test

'test' で始まるタグを持つすべてのリソースを一覧表示します。

az resource list --tag 'test*'

値 'example' を持つタグ 'test' を持つすべてのリソースを一覧表示します。

az resource list --tag test=example

省略可能のパラメーター

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

--tag

'key[=value]' 形式の 1 つのタグ。 既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--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 resource move

あるリソース グループから別のリソース グループにリソースを移動します (異なるサブスクリプションの下に配置できます)。

az resource move --destination-group
                 --ids
                 [--destination-subscription-id]

例

複数のリソースを移行先サブスクリプションの下のターゲット リソース グループに移動する

az resource move --destination-group ResourceGroup --destination-subscription-id SubscriptionId --ids "ResourceId1" "ResourceId2" "ResourceId3"

必須のパラメーター

--destination-group

宛先リソース グループ名。

--ids

移動するスペース区切りのリソース ID。

省略可能のパラメーター

--destination-subscription-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 resource patch

PATCH 要求によってリソースを更新します。

JSON 形式の文字列を使用したリソースの更新がサポートされています。 修正プログラムの操作が失敗した場合は、代わりに 'az resource update' を実行してみてください。

az resource patch --properties
                  [--api-version]
                  [--ids]
                  [--is-full-object]
                  [--latest-include-preview]
                  [--name]
                  [--namespace]
                  [--parent]
                  [--resource-group]
                  [--resource-type]

例

このバージョンがプレビュー バージョンであるかどうかに関係なく、最新の API バージョンを使用して Web アプリを更新します。

az resource patch --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} \
  --latest-include-preview --is-full-object --properties "{ \"tags\": { \"key\": \"value\" } }"

ファイルの JSON 構成を使用してリソースを更新します。

az resource patch --name MyResource --resource-group MyResourceGroup --resource-type Microsoft.web/sites \
  --is-full-object --properties @jsonConfigFile

JSON 構成を指定して API アプリを更新します。

az resource patch --name MyApiApp --resource-group MyResourceGroup --resource-type Microsoft.web/sites \
    --is-full-object --properties "{ \"kind\": \"api\", \"properties\": { \"serverFarmId\": \
            \"/subscriptions/{SubID}/resourcegroups/{ResourceGroup} \
                /providers/Microsoft.Web/serverfarms/{ServicePlan}\" } }"

必須のパラメーター

--properties -p

リソース プロパティを含む JSON 形式の文字列。

省略可能のパラメーター

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 指定した場合は、他の "リソース ID" 引数を指定しないでください。

--is-full-object

プロパティ オブジェクトに、場所、タグ、SKU、プランなどの他のオプションが含まれていることを示します。

規定値: False

--latest-include-preview -v

プレビュー

プレビュー バージョン (2020-01-01-preview など) であるかどうかに関係なく、最新の API バージョンが使用されることを示します。 たとえば、サポートされている API バージョンのリソース プロバイダーが 2020-01-01-preview および 2019-01-01 の場合:このパラメーターを渡すと、最新バージョン 2020-01-01-preview が適用されます。それ以外の場合、このパラメーターを渡さずに最新の安定バージョン 2019-01-01 が使用されます。

規定値: False

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--parent

親パス (例: 'resA/myA/resB/myB')。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

グローバル パラメーター

--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 resource show

リソースの詳細を取得します。

az resource show [--api-version]
                 [--ids]
                 [--include-response-body {false, true}]
                 [--latest-include-preview]
                 [--name]
                 [--namespace]
                 [--parent]
                 [--resource-group]
                 [--resource-type]

例

"MyVm" という名前の仮想マシン リソースを表示します。

az resource show -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines"

リソース識別子を使用して Web アプリを表示します。

az resource show --ids /subscriptions/0b1f6471-1bf0-4dda-aec3-111111111111/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/MyWebapp

サブネットを表示します。

az resource show -g MyResourceGroup -n MySubnet --namespace Microsoft.Network --parent virtualnetworks/MyVnet --resource-type subnets

リソース識別子を使用してサブネットを表示します。

az resource show --ids /subscriptions/0b1f6471-1bf0-4dda-aec3-111111111111/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MySubnet

アプリケーション ゲートウェイのパス規則を表示します。

az resource show -g MyResourceGroup --namespace Microsoft.Network --parent applicationGateways/ag1/urlPathMaps/map1 --resource-type pathRules -n rule1

このバージョンがプレビュー バージョンであるかどうかを示す最新の API バージョンを使用して、"MyVm" という名前の仮想マシン リソースを表示します。

az resource show -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines" --latest-include-preview

省略可能のパラメーター

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 指定した場合は、他の "リソース ID" 引数を指定しないでください。

--include-response-body

既定のコマンド出力ですべてのプロパティ データがキャプチャされない場合に使用します。

指定可能な値: false, true

規定値: False

--latest-include-preview -v

プレビュー

プレビュー バージョン (2020-01-01-preview など) であるかどうかに関係なく、最新の API バージョンが使用されることを示します。 たとえば、サポートされている API バージョンのリソース プロバイダーが 2020-01-01-preview および 2019-01-01 の場合:このパラメーターを渡すと、最新バージョン 2020-01-01-preview が適用されます。それ以外の場合、このパラメーターを渡さずに最新の安定バージョン 2019-01-01 が使用されます。

規定値: False

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--parent

親パス (例: 'resA/myA/resB/myB')。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

グローバル パラメーター

--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 resource tag

リソースにタグを付け。

az resource tag --tags
                [--api-version]
                [--ids]
                [--is-incremental]
                [--latest-include-preview]
                [--name]
                [--namespace]
                [--parent]
                [--resource-group]
                [--resource-type]

例

キー 'vmlist' と値 'vm1' を使用して、仮想マシン 'MyVm' にタグを付けます。

az resource tag --tags vmlist=vm1 -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines"

リソース識別子を使用して、キー 'vmlist' と値 'vm1' を使用して Web アプリにタグ付けします。

az resource tag --tags vmlist=vm1 --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp}

仮想マシン 'MyVm' にキー 'vmlist' と値 'vm1' を段階的にタグ付けします。 既存のタグは空になりません。

az resource tag --tags vmlist=vm1 -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines" -i

このバージョンがプレビュー バージョンであるかどうかを示す最新の API バージョンを使用して、仮想マシン 'MyVm' にキー 'vmlist' と値 'vm1' をタグ付けします。

az resource tag --tags vmlist=vm1 -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines" --latest-include-preview

必須のパラメーター

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

省略可能のパラメーター

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 指定した場合は、他の "リソース ID" 引数を指定しないでください。

--is-incremental -i

元のタグを削除せずにタグを段階的に追加するオプション。 新しいタグと元のタグのキーが重複している場合は、元の値が上書きされます。

--latest-include-preview -v

プレビュー

プレビュー バージョン (2020-01-01-preview など) であるかどうかに関係なく、最新の API バージョンが使用されることを示します。 たとえば、サポートされている API バージョンのリソース プロバイダーが 2020-01-01-preview および 2019-01-01 の場合:このパラメーターを渡すと、最新バージョン 2020-01-01-preview が適用されます。それ以外の場合、このパラメーターを渡さずに最新の安定バージョン 2019-01-01 が使用されます。

規定値: False

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--parent

親パス (例: 'resA/myA/resB/myB')。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

グローバル パラメーター

--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 resource update

PUT 要求によってリソースを更新します。

リソースを更新するための汎用更新 (プロパティ パスを使用) がサポートされています。 更新操作が失敗した場合は、代わりに 'az resource patch' を実行してみてください。

az resource update [--add]
                   [--api-version]
                   [--force-string]
                   [--ids]
                   [--include-response-body {false, true}]
                   [--latest-include-preview]
                   [--name]
                   [--namespace]
                   [--parent]
                   [--remove]
                   [--resource-group]
                   [--resource-type]
                   [--set]

例

このバージョンがプレビュー バージョンであるかどうかに関係なく、最新の API バージョンを使用して Web アプリを更新します。

az resource update --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --set tags.key=value --latest-include-preview

リソースを更新します。 (自動生成)

az resource update --ids $id --set properties.connectionType=Proxy

リソースを更新します。 (自動生成)

az resource update --name MyResource --resource-group MyResourceGroup --resource-type subnets --set tags.key=value

省略可能のパラメーター

--add

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

規定値: []

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--force-string

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

規定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 指定した場合は、他の "リソース ID" 引数を指定しないでください。

--include-response-body

既定のコマンド出力ですべてのプロパティ データがキャプチャされない場合に使用します。

指定可能な値: false, true

規定値: False

--latest-include-preview -v

プレビュー

プレビュー バージョン (2020-01-01-preview など) であるかどうかに関係なく、最新の API バージョンが使用されることを示します。 たとえば、サポートされている API バージョンのリソース プロバイダーが 2020-01-01-preview および 2019-01-01 の場合:このパラメーターを渡すと、最新バージョン 2020-01-01-preview が適用されます。それ以外の場合、このパラメーターを渡さずに最新の安定バージョン 2019-01-01 が使用されます。

規定値: False

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--parent

親パス (例: 'resA/myA/resB/myB')。

--remove

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

規定値: []

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

--set

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

規定値: []

グローバル パラメーター

--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 resource wait

リソースの条件が満たされるまで、CLI を待機状態にします。

az resource wait [--api-version]
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--ids]
                 [--include-response-body {false, true}]
                 [--interval]
                 [--name]
                 [--namespace]
                 [--parent]
                 [--resource-group]
                 [--resource-type]
                 [--timeout]
                 [--updated]

例

リソースの条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp}

リソースの条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --include-response-body true

リソースの条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az resource wait --exists --name MyResource --resource-group MyResourceGroup --resource-type subnets

省略可能のパラメーター

--api-version

リソースの API バージョン (最新の安定バージョンでは省略)。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 指定した場合は、他の "リソース ID" 引数を指定しないでください。

--include-response-body

既定のコマンド出力ですべてのプロパティ データがキャプチャされない場合に使用します。

指定可能な値: false, true

規定値: False

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--name -n

リソースの名前。 (例: myC)。

--namespace

プロバイダー名前空間 (例: 'Microsoft.Provider')。

--parent

親パス (例: 'resA/myA/resB/myB')。

--resource-group -g

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

--resource-type

リソースの種類 (例: 'resC')。 名前空間/型形式 (例: "Microsoft.Provider/resC") を受け入れることもできます。

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: 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 を使います。