az resource

管理 Azure 資源。

命令

名稱 Description 類型 狀態
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

取得具有指定標識碼的資源連結。

核心 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

資源標識碼。

--is-full-object

表示 properties 物件包含其他選項,例如位置、標籤、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-01,而不傳入此參數。

預設值: False
--location -l

位置。​​ 來自的值: 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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

使用最新的 API 版本刪除名為 『MyVm』 的虛擬機,不論此版本是否為預覽版本。

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

選擇性參數

--api-version

資源的 API 版本(針對最新的穩定版本省略)。

--ids

一或多個資源識別碼 (以空格分隔)。 如果提供,則不應指定其他「資源標識元」自變數。

--latest-include-preview -v
預覽

指出不論其是否為預覽版本(例如 2020-01-01-preview),都會使用最新的 API 版本。 例如,如果支援的 API 版本資源提供者是 2020-01-01-preview 和 2019-01-01:傳入此參數時,它會採用最新版本 2020-01-01-preview,否則它會採用最新的穩定版本 2019-01-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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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]

範例

關閉 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

一或多個資源識別碼 (以空格分隔)。 如果提供,則不應指定其他「資源標識元」自變數。

--latest-include-preview -v
預覽

指出不論其是否為預覽版本(例如 2020-01-01-preview),都會使用最新的 API 版本。 例如,如果支援的 API 版本資源提供者是 2020-01-01-preview 和 2019-01-01:傳入此參數時,它會採用最新版本 2020-01-01-preview,否則它會採用最新的穩定版本 2019-01-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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

位置。​​ 來自的值: 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]' 格式的單一標記。 使用 「清除現有的標記」。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

要移動的空間分隔資源標識碼。

選擇性參數

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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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 版本來更新 Webapp。

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

一或多個資源識別碼 (以空格分隔)。 如果提供,則不應指定其他「資源標識元」自變數。

--is-full-object

表示 properties 物件包含其他選項,例如位置、標籤、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-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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

一或多個資源識別碼 (以空格分隔)。 如果提供,則不應指定其他「資源標識元」自變數。

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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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}

以密鑰 'vmlist' 和值 'vm1' 累加標記虛擬機 'MyVm'。 它不會清空現有的標記。

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

使用最新的 API 版本,使用金鑰 'vmlist' 和值 'vm1' 標記虛擬機 'MyVm',不論此版本是否為預覽版本。

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

一或多個資源識別碼 (以空格分隔)。 如果提供,則不應指定其他「資源標識元」自變數。

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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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 版本來更新 Webapp。

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

一或多個資源識別碼 (以空格分隔)。 如果提供,則不應指定其他「資源標識元」自變數。

--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-01,而不傳入此參數。

預設值: False
--name -n

資源名稱。 (例如:myC)。

--namespace

提供者命名空間(例如:『Microsoft.Provider』)。

--parent

父路徑(例如:'resA/myA/resB/myB')。

--remove

從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>--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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

一或多個資源識別碼 (以空格分隔)。 如果提供,則不應指定其他「資源標識元」自變數。

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

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。