Bastion Hosts - List
Lists all Bastion Hosts in a subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts?api-version=2024-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. The operation returns a list of Bastion Host resources. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
List all Bastion Hosts for a given subscription
Sample request
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/bastionHosts?api-version=2024-05-01
Sample response
{
"value": [
{
"name": "bastionhosttenant",
"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,
"enableSessionRecording": false,
"enablePrivateOnlyBastion": 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/vnet/subnets/AzureBastionSubnet"
},
"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": []
}
},
{
"name": "bastionhost3",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3",
"type": "Microsoft.Network/bastionHosts",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"location": "West US",
"sku": {
"name": "Premium"
},
"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,
"enableSessionRecording": true,
"enablePrivateOnlyBastion": false,
"ipConfigurations": [
{
"name": "bastionHostIpConfiguration",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3/bastionHostIpConfigurations/IpConf",
"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/vnet3/subnets/AzureBastionSubnet"
},
"publicIPAddress": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName3"
}
}
}
]
}
},
{
"name": "bastionhost4",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost4",
"type": "Microsoft.Network/bastionHosts",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"location": "West US",
"sku": {
"name": "Premium"
},
"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,
"enableSessionRecording": false,
"enablePrivateOnlyBastion": true,
"ipConfigurations": [
{
"name": "bastionHostIpConfiguration",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost4/bastionHostIpConfigurations/IpConf",
"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/vnet4/subnets/AzureBastionSubnet"
}
}
}
]
}
}
]
}
Definitions
Name | Description |
---|---|
Bastion |
Bastion Host resource. |
Bastion |
IP configuration of an Bastion Host. |
Bastion |
Response for ListBastionHosts API service call. |
Bastion |
The name of the sku of this Bastion Host. |
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
IPAllocation |
IP address allocation method. |
IPRule | |
Network |
|
Provisioning |
The current provisioning state. |
Sku |
The sku of this Bastion Host. |
Sub |
Reference to another subresource. |
BastionHost
Bastion Host resource.
Name | Type | Default value | Description |
---|---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
|
id |
string |
Resource ID. |
|
location |
string |
Resource location. |
|
name |
string |
Resource name. |
|
properties.disableCopyPaste |
boolean |
False |
Enable/Disable Copy/Paste feature of the Bastion Host resource. |
properties.dnsName |
string |
FQDN for the endpoint on which bastion host is accessible. |
|
properties.enableFileCopy |
boolean |
False |
Enable/Disable File Copy feature of the Bastion Host resource. |
properties.enableIpConnect |
boolean |
False |
Enable/Disable IP Connect feature of the Bastion Host resource. |
properties.enableKerberos |
boolean |
False |
Enable/Disable Kerberos feature of the Bastion Host resource. |
properties.enablePrivateOnlyBastion |
boolean |
False |
Enable/Disable Private Only feature of the Bastion Host resource. |
properties.enableSessionRecording |
boolean |
False |
Enable/Disable Session Recording feature of the Bastion Host resource. |
properties.enableShareableLink |
boolean |
False |
Enable/Disable Shareable Link of the Bastion Host resource. |
properties.enableTunneling |
boolean |
False |
Enable/Disable Tunneling feature of the Bastion Host resource. |
properties.ipConfigurations |
IP configuration of the Bastion Host resource. |
||
properties.networkAcls | |||
properties.provisioningState |
The provisioning state of the bastion host resource. |
||
properties.scaleUnits |
integer |
The scale units for the Bastion Host resource. |
|
properties.virtualNetwork |
Reference to an existing virtual network required for Developer Bastion Host only. |
||
sku |
The sku of this Bastion Host. |
||
tags |
object |
Resource tags. |
|
type |
string |
Resource type. |
|
zones |
string[] |
A list of availability zones denoting where the resource needs to come from. |
BastionHostIPConfiguration
IP configuration of an Bastion Host.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
id |
string |
Resource ID. |
name |
string |
Name of the resource that is unique within a resource group. This name can be used to access the resource. |
properties.privateIPAllocationMethod |
Private IP allocation method. |
|
properties.provisioningState |
The provisioning state of the bastion host IP configuration resource. |
|
properties.publicIPAddress |
Reference of the PublicIP resource. Null for private only bastion |
|
properties.subnet |
Reference of the subnet resource. |
|
type |
string |
Ip configuration type. |
BastionHostListResult
Response for ListBastionHosts API service call.
Name | Type | Description |
---|---|---|
nextLink |
string |
URL to get the next set of results. |
value |
List of Bastion Hosts in a resource group. |
BastionHostSkuName
The name of the sku of this Bastion Host.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Developer |
string |
|
Premium |
string |
|
Standard |
string |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Cloud error body. |
CloudErrorBody
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
IPAllocationMethod
IP address allocation method.
Name | Type | Description |
---|---|---|
Dynamic |
string |
|
Static |
string |
IPRule
Name | Type | Description |
---|---|---|
addressPrefix |
string |
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
NetworkAcls
Name | Type | Description |
---|---|---|
ipRules |
IPRule[] |
Sets the IP ACL rules for Developer Bastion Host. |
ProvisioningState
The current provisioning state.
Name | Type | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
Sku
The sku of this Bastion Host.
Name | Type | Default value | Description |
---|---|---|---|
name | Standard |
The name of the sku of this Bastion Host. |
SubResource
Reference to another subresource.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |