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

az network bastion

参考

注意

此参考是 Azure CLI（版本 2.43.0 或更高版本）的堡垒扩展的一部分。该扩展将在首次运行 az network bastion 命令时自动安装。详细了解扩展。

管理 Azure Bastion 主机。

命令

名称	说明	类型	Status
az network bastion create	创建 Azure Bastion 主机。	扩展	预览
az network bastion delete	删除 Azure Bastion 主机。	扩展	预览
az network bastion list	列出所有 Azure Bastion 主机。	扩展	预览
az network bastion rdp	通过 RDP 从 Azure Bastion 通过隧道定位虚拟机。	扩展	GA
az network bastion show	显示 Azure Bastion 主机。	扩展	预览
az network bastion ssh	使用 Azure Bastion 的 Tunneling 通过 SSH 连接到虚拟机。	扩展	GA
az network bastion tunnel	通过 Azure Bastion 打开到目标虚拟机的隧道。	扩展	GA
az network bastion update	更新 Azure Bastion 主机。	扩展	预览
az network bastion wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az network bastion create

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

创建 Azure Bastion 主机。

az network bastion create --name
                          --public-ip-address
                          --resource-group
                          --vnet-name
                          [--disable-copy-paste {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-ip-connect {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tunneling {0, 1, f, false, n, no, t, true, y, yes}]
                          [--location]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--scale-units]
                          [--sku {Basic, Standard}]
                          [--tags]

示例

创建 Azure Bastion 主机。

az network bastion create --location westus2 --name MyBastionHost --public-ip-address MyPublicIpAddress --resource-group MyResourceGroup --vnet-name MyVnet

必需参数

--name -n

堡垒主机的名称。

--public-ip-address

Azure 公共 IP 的名称或 ID。公共 IP 的 SKU 必须为标准。

--resource-group -g

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

--vnet-name

虚拟网络的名称。它必须具有名为 AzureBastionSubnet 的子网。

可选参数

--disable-copy-paste

禁用此 Azure Bastion 资源上所有会话的复制和粘贴。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

默认值: False

--enable-ip-connect

在此 Azure Bastion 资源上启用基于 IP 的连接。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

默认值: False

--enable-tunneling

在此 Azure Bastion 资源上启用本机客户端支持。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

默认值: False

--location -l

Location。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--scale-units

具有 [2， 50] 范围的 Bastion 主机资源的缩放单位。

--sku

此 Bastion 主机的 SKU。

接受的值: Basic, Standard

默认值: Standard

--tags

空格分隔标记：key[=value] [key[=value] ...]。支持速记语法、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 network bastion delete

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

删除 Azure Bastion 主机。

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

示例

删除 Azure Bastion 主机。

az network bastion delete --name MyBastionHost --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

堡垒主机的名称。

--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 配置默认订阅。

全局参数

--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 network bastion list

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

列出所有 Azure Bastion 主机。

az network bastion list [--resource-group]

示例

列出所有 Azure Bastion 主机。

az network bastion list -g MyResourceGroup

可选参数

--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 network bastion rdp

通过 RDP 从 Azure Bastion 通过隧道定位虚拟机。

az network bastion rdp [--auth-type]
                       [--configure]
                       [--disable-gateway {false, true}]
                       [--enable-mfa {false, true}]
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--resource-port]
                       [--subscription]
                       [--target-ip-address]
                       [--target-resource-id]

示例

使用 Azure Bastion 通过 RDP 连接到虚拟机。

az network bastion rdp --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId

使用可访问 IP 地址通过 RDP 连接到计算机。

az network bastion rdp --name MyBastionHost --resource-group MyResourceGroup --target-ip-address 10.0.0.1

可选参数

--auth-type

用于 RDP 连接的身份验证类型。

--configure

用于配置 RDP 会话的标志。

默认值: False

--disable-gateway

通过 RD 网关禁用访问的标志。

接受的值: false, true

默认值: False

--enable-mfa

使用新协议登录到启用了 AAD 的 Windows 计算机，如果目标计算机支持，则使用 MFA 进行身份验证。在 Windows 10 20H2+、Windows 11 21H2+、WS 2022 上可用。

接受的值: false, true

默认值: False

--ids

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

--name -n

堡垒主机的名称。

--resource-group -g

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

--resource-port

堡垒要连接到的目标 VM 的资源端口。

--subscription

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

--target-ip-address

目标虚拟机的 IP 地址。

--target-resource-id

目标虚拟机的 ResourceId。

全局参数

--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 network bastion show

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

显示 Azure Bastion 主机。

az network bastion show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

示例

显示 Azure Bastion 主机。

az network bastion show --name MyBastionHost --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

堡垒主机的名称。

--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 network bastion ssh

使用 Azure Bastion 的 Tunneling 通过 SSH 连接到虚拟机。

az network bastion ssh --auth-type
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--resource-port]
                       [--ssh-key]
                       [--subscription]
                       [--target-ip-address]
                       [--target-resource-id]
                       [--username]
                       [<SSH_ARGS>]

示例

使用密码通过 Azure Bastion 通过 SSH 连接到虚拟机。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type password --username xyz

使用 Ssh 密钥文件通过 Azure Bastion 通过 SSH 连接到虚拟机。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type ssh-key --username xyz --ssh-key C:/filepath/sshkey.pem

使用 AAD 通过 Azure Bastion 通过 SSH 连接到虚拟机。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type AAD

使用 AAD 通过 Azure Bastion 通过 SSH 连接到虚拟机，同时提供其他 SSH 参数。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type AAD -- -L 8080:127.0.0.1:8080

必需参数

--auth-type

用于 SSH 连接的身份验证类型。

可选参数

--ids

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

--name -n

堡垒主机的名称。

--resource-group -g

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

--resource-port

堡垒要连接到的目标 VM 的资源端口。

--ssh-key

SSH 连接的 SSH 密钥文件位置。

--subscription

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

--target-ip-address

目标虚拟机的 IP 地址。

--target-resource-id

目标虚拟机的 ResourceId。

--username

SSH 连接的用户名。

<SSH_ARGS>

传递给 OpenSSH 的其他参数。

全局参数

--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 network bastion tunnel

通过 Azure Bastion 打开到目标虚拟机的隧道。

az network bastion tunnel --port
                          --resource-port
                          [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--target-ip-address]
                          [--target-resource-id]
                          [--timeout]

示例

使用 resourceId 通过 Azure Bastion 打开到目标虚拟机的隧道。

az network bastion tunnel --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --resource-port 22 --port 50022

使用 Azure Bastion 的 IP 地址通过 Azure Bastion 打开到目标虚拟机的隧道。

az network bastion tunnel --name MyBastionHost --resource-group MyResourceGroup --target-ip-address 10.0.0.1 --resource-port 22 --port 50022

必需参数

--port

用于隧道的本地端口。

--resource-port

堡垒要连接到的目标 VM 的资源端口。

可选参数

--ids

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

--name -n

堡垒主机的名称。

--resource-group -g

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

--subscription

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

--target-ip-address

目标虚拟机的 IP 地址。

--target-resource-id

目标虚拟机的 ResourceId。

--timeout

与堡垒主机隧道的连接超时。

全局参数

--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 network bastion update

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

更新 Azure Bastion 主机。

az network bastion update [--add]
                          [--disable-copy-paste {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-ip-connect {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tunneling {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--remove]
                          [--resource-group]
                          [--scale-units]
                          [--set]
                          [--sku {Basic, Standard}]
                          [--subscription]

示例

更新 Azure Bastion 主机以启用本机客户端支持。

az network bastion update --name MyBastionHost --resource-group MyResourceGroup --enable-tunneling

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--disable-copy-paste

禁用此 Azure Bastion 资源上所有会话的复制和粘贴。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--enable-ip-connect

在此 Azure Bastion 资源上启用基于 IP 的连接。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--enable-tunneling

在此 Azure Bastion 资源上启用本机客户端支持。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--name -n

堡垒主机的名称。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--scale-units

具有 [2， 50] 范围的 Bastion 主机资源的缩放单位。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--sku

此 Bastion 主机的 SKU。

接受的值: Basic, Standard

--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 network bastion wait

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

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

可选参数

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

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

默认值: 30

--name -n

堡垒主机的名称。

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

通过

az network bastion

命令

az network bastion create

示例

必需参数

可选参数

az network bastion delete

示例

可选参数

az network bastion list

示例

可选参数

az network bastion rdp

示例

可选参数

az network bastion show

示例

可选参数

az network bastion ssh

示例

必需参数

可选参数

az network bastion tunnel

示例

必需参数

可选参数

az network bastion update

示例

可选参数

az network bastion wait

可选参数

其他资源