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

az network bastion

注意

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

管理 Azure Bastion 主机。

命令

名称	说明	类型	Status
az network bastion create	创建指定的 Bastion 主机。	外延	加语
az network bastion delete	删除指定的 Bastion 主机。	外延	加语
az network bastion list	列出资源组中的所有 Bastion 主机。	外延	加语
az network bastion rdp	通过 RDP 从 Azure Bastion 通过隧道定位虚拟机。	外延	加语
az network bastion show	获取指定的 Bastion 主机。	外延	加语
az network bastion ssh	使用 Azure Bastion 的 Tunneling 通过 SSH 连接到虚拟机。	外延	加语
az network bastion tunnel	通过 Azure Bastion 打开到目标虚拟机的隧道。	外延	加语
az network bastion update	更新指定的 Bastion 主机。	外延	加语
az network bastion wait	将 CLI 置于等待状态，直到满足条件。	外延	加语

az network bastion create

创建指定的 Bastion 主机。

az network bastion create --name
                          --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}]
                          [--file-copy {0, 1, f, false, n, no, t, true, y, yes}]
                          [--kerberos {0, 1, f, false, n, no, t, true, y, yes}]
                          [--location]
                          [--network-acls-ips]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--public-ip-address]
                          [--scale-units]
                          [--session-recording {0, 1, f, false, n, no, t, true, y, yes}]
                          [--shareable-link {0, 1, f, false, n, no, t, true, y, yes}]
                          [--sku {Basic, Developer, Premium, Standard}]
                          [--tags]
                          [--zones]

示例

创建 Azure Bastion 主机。

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

使用区域创建 Bastion 主机

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

使用会话录制创建 Bastion 主机。

az network bastion create --location westus2 --name MyBastionHost --public-ip-address MyPublicIpAddress --resource-group MyResourceGroup --vnet-name MyVnet --zones 1 2 3 --sku Premium --session-recording

创建开发人员 SKU Bastion

az network bastion create --name MyBastion --resource-group MyResourceGroup --sku Developer --vnet-name MyVnet

使用网络 ACL IP 规则创建开发人员 SKU Bastion

az network bastion create --name MyBastion --resource-group MyResourceGroup --sku Developer --vnet-name MyVnet --network-acls-ips "1.1.1.1/16 100.64.0.0/10"

必需参数

--name -n

Bastion 主机的名称。

--resource-group -g

Bastion 主机的资源组名称。

--vnet-name

虚拟网络的名称或资源 ID。 对于所有 SKU，但开发人员 SKU，此虚拟网络必须具有名为 AzureBastionSubnet 的子网。

可选参数

--disable-copy-paste

启用/禁用 Bastion 主机资源的复制/粘贴功能。

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

默认值: False

--enable-ip-connect

启用/禁用 Bastion 主机资源的 IP Connect 功能。

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

默认值: False

--enable-tunneling

启用/禁用 Bastion 主机资源的隧道功能。

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

默认值: False

--file-copy

启用/禁用 Bastion 主机资源的文件复制功能。

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

默认值: False

--kerberos

启用/禁用 Bastion 主机资源的 Kerberos 功能。

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

默认值: False

--location -l

资源位置。

--network-acls-ips

[仅在开发人员 SKU 中受支持]网络 ACL IP 规则。 以空格分隔的 IP 地址列表。

--no-wait

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

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

--public-ip-address

[所有 SKU 是必需的，但开发人员 SKU]公共 IP 的名称或资源 ID。 公共 IP 的 SKU 必须为标准。

--scale-units

Bastion 主机资源的缩放单位。

默认值: 2

--session-recording

启用/禁用 Bastion 主机资源的会话录制功能。

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

默认值: False

--shareable-link

启用/禁用 Bastion 主机资源的可共享链接。

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

默认值: False

--sku

此 Bastion 主机的 SKU 的名称。

接受的值: Basic, Developer, Premium, Standard

默认值: Standard

--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

默认值: {}

--zones

一个可用性区域列表，表示资源需要来自何处。 支持速记语法、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

删除指定的 Bastion 主机。

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

示例

删除 Azure Bastion 主机。

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

可选参数

--ids

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

--name -n

Bastion 主机的名称。

--no-wait

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

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

--resource-group -g

Bastion 主机的资源组名称。

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

列出资源组中的所有 Bastion 主机。

az network bastion list [--max-items]
                        [--next-token]
                        [--resource-group]

示例

列出资源组中的所有 Azure Bastion 主机。

az network bastion list -g MyResourceGroup

可选参数

--max-items

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

--next-token

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

--resource-group -g

Bastion 主机的资源组名称。

全局参数

--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（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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

获取指定的 Bastion 主机。

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

示例

显示 Azure Bastion 主机。

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

可选参数

--ids

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

--name -n

Bastion 主机的名称。

--resource-group -g

Bastion 主机的资源组名称。

--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（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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

更新指定的 Bastion 主机。

az network bastion update [--add]
                          [--bastion-host-name]
                          [--disable-copy-paste {0, 1, f, false, n, no, t, true, y, yes}]
                          [--dns-name]
                          [--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}]
                          [--file-copy {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--ip-configurations]
                          [--kerberos {0, 1, f, false, n, no, t, true, y, yes}]
                          [--location]
                          [--network-acls]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--remove]
                          [--resource-group]
                          [--scale-units]
                          [--session-recording {0, 1, f, false, n, no, t, true, y, yes}]
                          [--set]
                          [--shareable-link {0, 1, f, false, n, no, t, true, y, yes}]
                          [--sku]
                          [--subscription]
                          [--tags]
                          [--virtual-network]
                          [--zones]

示例

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

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

可选参数

--add

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

--bastion-host-name --name -n

Bastion 主机的名称。

--disable-copy-paste

启用/禁用 Bastion 主机资源的复制/粘贴功能。

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

--dns-name

堡垒主机可访问的终结点的 FQDN。

--enable-ip-connect

启用/禁用 Bastion 主机资源的 IP Connect 功能。

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

--enable-tunneling

启用/禁用 Bastion 主机资源的隧道功能。

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

--file-copy

启用/禁用 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（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--ip-configurations

Bastion 主机资源的 IP 配置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--kerberos

启用/禁用 Bastion 主机资源的 Kerberos 功能。

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

--location -l

资源位置。

--network-acls

开发人员 Bastion 主机的 ACL 规则。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--no-wait

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

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

--remove

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

--resource-group -g

Bastion 主机的资源组名称。

--scale-units

Bastion 主机资源的缩放单位。

--session-recording

启用/禁用 Bastion 主机资源的会话录制功能。

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

--set

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

--shareable-link

启用/禁用 Bastion 主机资源的可共享链接。

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

--sku

此 Bastion 主机的 SKU。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--subscription

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

--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--virtual-network

仅对开发人员 Bastion 主机所需的现有虚拟网络的引用。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--zones

一个可用性区域列表，表示资源需要来自何处。 支持速记语法、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 wait

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

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

可选参数

--bastion-host-name --name -n

Bastion 主机的名称。

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

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

默认值: 30

--resource-group -g

Bastion 主机的资源组名称。

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