你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

使用最新的 API 版本（此版本是否为预览版）删除名为“MyVm”的虚拟机。

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

可选参数

--api-version

资源的 API 版本（对于最新的稳定版本省略）。

--ids

一个或多个资源 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

一个或多个资源 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

将在 post 请求正文中传递的操作的 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]”格式的单个标记。 使用“”清除现有标记。

全局参数
--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

一个或多个资源 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

一个或多个资源 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}

使用密钥“vmlist”和值“vm1”以增量方式标记虚拟机“MyVm”。 它不会清空现有标记。

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

使用密钥“vmlist”和值“vm1”标记虚拟机“MyVm”，方法是使用此版本是否为预览版本的最新 API 版本。

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

一个或多个资源 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

一个或多个资源 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

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

一个或多个资源 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 获取完整的调试日志。