通过

az arcgateway

  • 参考

注释

此参考是 Azure CLI 的 arcgateway 扩展的一部分（版本 2.57.0 或更高版本）。 该扩展将在首次运行 az arcgateway 命令时自动安装。 了解更多关于扩展 的相关信息。

管理 Arc 计算机上的网关连接。

命令

名称 说明 类型 Status
az arcgateway create

创建 Azure 网关资源。

 扩展 GA
az arcgateway delete

删除 Arc 网关资源。

 扩展 GA
az arcgateway list

列出与特定订阅关联的所有 Arc 网关资源。

 扩展 GA
az arcgateway settings

管理 Azure Arc-Enabled 服务器的设置。

 扩展 GA
az arcgateway settings update

更新目标资源的基设置。

 扩展 GA
az arcgateway show

显示特定 Arc 网关资源的详细信息。

 扩展 GA
az arcgateway wait

将 CLI 置于等待状态，直到满足条件。

 扩展 GA

az arcgateway create

创建 Azure 网关资源。

az arcgateway create --gateway-name --name
                     --resource-group
                     [--allowed-features]
                     [--gateway-type {Public}]
                     [--___location]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--tags]

示例

网关创建的示例命令

az arcgateway create --name MyArcgateway --resource-group myResourceGroup --___location eastus2euap --subscription mySubscription

必需参数

--gateway-name --name -n

网关的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

--allowed-features

指定为此网关启用的功能列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

默认值: ['*']
--gateway-type

网关资源的类型。

接受的值: Public
--___location -l

未指定资源所在的地理位置，将使用资源组的位置。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--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 arcgateway delete

删除 Arc 网关资源。

az arcgateway delete [--gateway-name --name]
                     [--ids]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--resource-group]
                     [--subscription]
                     [--yes]

示例

示例命令或网关删除

az arcgateway delete --name MyArcgateway --resource-group myResourceGroup --subscription mySubscription

可选参数

--gateway-name --name -n

网关的名称。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--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 arcgateway list

列出与特定订阅关联的所有 Arc 网关资源。

az arcgateway list [--max-items]
                   [--next-token]
                   [--resource-group]

示例

示例命令或网关列表

az arcgateway list --subscription mySubscription

可选参数

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

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

显示特定 Arc 网关资源的详细信息。

az arcgateway show [--gateway-name --name]
                   [--ids]
                   [--resource-group]
                   [--subscription]

示例

网关显示的示例命令

az arcgateway show --name myArcgateway --resource-group myResourceGroup --subscription mySubscription

可选参数

--gateway-name --name -n

网关的名称。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

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

将 CLI 置于等待状态，直到满足条件。

az arcgateway wait [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--gateway-name --name]
                   [--ids]
                   [--interval]
                   [--resource-group]
                   [--subscription]
                   [--timeout]
                   [--updated]

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--gateway-name --name -n

网关的名称。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--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 获取完整的调试日志。