你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Bastion Hosts - List
Lists订阅中的所有 Bastion 主机。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts?api-version=2023-09-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
subscription
|
path | True |
string |
可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功。 该操作返回 Bastion 主机资源的列表。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
List all Bastion Hosts for a given subscription
Sample Request
Sample Response
{
"value": [
{
"name": "bastionhost'",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'",
"type": "Microsoft.Network/bastionHosts",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"location": "West US",
"sku": {
"name": "Standard"
},
"zones": [],
"properties": {
"provisioningState": "Succeeded",
"dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com",
"scaleUnits": 2,
"disableCopyPaste": false,
"enableTunneling": false,
"enableIpConnect": false,
"enableShareableLink": false,
"enableKerberos": false,
"ipConfigurations": [
{
"name": "bastionHostIpConfiguration",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations",
"properties": {
"provisioningState": "Succeeded",
"privateIPAllocationMethod": "Dynamic",
"subnet": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"
},
"publicIPAddress": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
}
}
}
]
}
},
{
"name": "bastionhostdeveloper'",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'",
"type": "Microsoft.Network/bastionHosts",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"location": "West US",
"sku": {
"name": "Developer"
},
"properties": {
"provisioningState": "Succeeded",
"virtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2"
},
"networkAcls": {
"ipRules": [
{
"addressPrefix": "1.1.1.1/16"
}
]
},
"dnsName": "omnibrain.uswest.bastionglobal.azure.com",
"ipConfigurations": []
}
}
]
}
定义
名称 | 说明 |
---|---|
Bastion |
堡垒主机资源。 |
Bastion |
Bastion 主机的 IP 配置。 |
Bastion |
ListBastionHosts API 服务调用的响应。 |
Bastion |
此 Bastion 主机的名称。 |
Cloud |
来自服务的错误响应。 |
Cloud |
来自服务的错误响应。 |
IPAllocation |
IP 地址分配方法。 |
IPRule | |
Network |
|
Provisioning |
当前预配状态。 |
Sku |
此 Bastion 主机的 SKU。 |
Sub |
对另一个子资源的引用。 |
BastionHost
堡垒主机资源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
etag |
string |
一个唯一的只读字符串,每当资源更新时都会更改。 |
|
id |
string |
资源 ID。 |
|
location |
string |
资源位置。 |
|
name |
string |
资源名称。 |
|
properties.disableCopyPaste |
boolean |
False |
启用/禁用 Bastion 主机资源的复制/粘贴功能。 |
properties.dnsName |
string |
可访问堡垒主机的终结点的 FQDN。 |
|
properties.enableFileCopy |
boolean |
False |
启用/禁用 Bastion 主机资源的文件复制功能。 |
properties.enableIpConnect |
boolean |
False |
启用/禁用 Bastion 主机资源的 IP 连接功能。 |
properties.enableKerberos |
boolean |
False |
启用/禁用 Bastion 主机资源的 Kerberos 功能。 |
properties.enableShareableLink |
boolean |
False |
启用/禁用 Bastion 主机资源的可共享链接。 |
properties.enableTunneling |
boolean |
False |
启用/禁用 Bastion 主机资源的隧道功能。 |
properties.ipConfigurations |
Bastion 主机资源的 IP 配置。 |
||
properties.networkAcls | |||
properties.provisioningState |
堡垒主机资源的预配状态。 |
||
properties.scaleUnits |
integer |
Bastion 主机资源的缩放单位。 |
|
properties.virtualNetwork |
仅对开发人员堡垒主机所需的现有虚拟网络的引用。 |
||
sku |
此 Bastion 主机的 SKU。 |
||
tags |
object |
资源标记。 |
|
type |
string |
资源类型。 |
|
zones |
string[] |
表示资源需要来自的可用性区域列表。 |
BastionHostIPConfiguration
Bastion 主机的 IP 配置。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
一个唯一的只读字符串,每当资源更新时都会更改。 |
id |
string |
资源 ID。 |
name |
string |
资源组中唯一的资源的名称。 此名称可用于访问资源。 |
properties.privateIPAllocationMethod |
专用 IP 分配方法。 |
|
properties.provisioningState |
堡垒主机 IP 配置资源的预配状态。 |
|
properties.publicIPAddress |
PublicIP 资源的引用。 |
|
properties.subnet |
子网资源的引用。 |
|
type |
string |
IP 配置类型。 |
BastionHostListResult
ListBastionHosts API 服务调用的响应。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
用于获取下一组结果的 URL。 |
value |
资源组中的 Bastion 主机列表。 |
BastionHostSkuName
此 Bastion 主机的名称。
名称 | 类型 | 说明 |
---|---|---|
Basic |
string |
|
Developer |
string |
|
Standard |
string |
CloudError
来自服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
云错误正文。 |
CloudErrorBody
来自服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
details |
有关错误的其他详细信息的列表。 |
|
message |
string |
描述错误的消息,该消息适用于在用户界面中显示。 |
target |
string |
特定错误的目标。 例如,属性的名称出错。 |
IPAllocationMethod
IP 地址分配方法。
名称 | 类型 | 说明 |
---|---|---|
Dynamic |
string |
|
Static |
string |
IPRule
名称 | 类型 | 说明 |
---|---|---|
addressPrefix |
string |
以 CIDR 格式指定 IP 或 IP 范围。 仅允许 IPV4 地址。 |
NetworkAcls
名称 | 类型 | 说明 |
---|---|---|
ipRules |
IPRule[] |
设置开发人员堡垒主机的 IP ACL 规则。 |
ProvisioningState
当前预配状态。
名称 | 类型 | 说明 |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
Sku
此 Bastion 主机的 SKU。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
name | Standard |
此 Bastion 主机的名称。 |
SubResource
对另一个子资源的引用。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |