Bastion Hosts - Get

Reference

Service:: Virtual Networks

API Version:: 2024-05-01

Gets the specified Bastion Host.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
bastionHostName	path	True	string	The name of the Bastion Host.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	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	BastionHost	Request successful. The operation returns an BastionHost resource.
Other Status Codes	CloudError	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

Get Bastion Host

Get Bastion Host With Private Only

Get Bastion Host With Zones

Get Developer Bastion Host

Get Bastion Host

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'?api-version=2024-05-01

Sample response

Status code:: 200

{
  "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",
  "tags": {
    "key1": "value1"
  },
  "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/vnet2/subnets/BastionHostSubnet"
          },
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
          }
        }
      }
    ]
  }
}

Get Bastion Host With Private Only

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant?api-version=2024-05-01

Sample response

Status code:: 200

{
  "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",
  "tags": {
    "key1": "value1"
  },
  "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/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"
          }
        }
      }
    ]
  }
}

Get Bastion Host With Zones

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant?api-version=2024-05-01

Sample response

Status code:: 200

{
  "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",
  "tags": {
    "key1": "value1"
  },
  "sku": {
    "name": "Standard"
  },
  "zones": [
    "1",
    "2"
  ],
  "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/vnet2/subnets/BastionHostSubnet"
          },
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
          }
        }
      }
    ]
  }
}

Get Developer Bastion Host

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'?api-version=2024-05-01

Sample response

Status code:: 200

{
  "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": []
  }
}

Definitions

Name	Description
BastionHost	Bastion Host resource.
BastionHostIPConfiguration	IP configuration of an Bastion Host.
BastionHostSkuName	The name of the sku of this Bastion Host.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
IPAllocationMethod	IP address allocation method.
IPRule
NetworkAcls
ProvisioningState	The current provisioning state.
Sku	The sku of this Bastion Host.
SubResource	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	BastionHostIPConfiguration[]		IP configuration of the Bastion Host resource.
properties.networkAcls	NetworkAcls
properties.provisioningState	ProvisioningState		The provisioning state of the bastion host resource.
properties.scaleUnits	integer		The scale units for the Bastion Host resource.
properties.virtualNetwork	SubResource		Reference to an existing virtual network required for Developer Bastion Host only.
sku	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	IPAllocationMethod	Private IP allocation method.
properties.provisioningState	ProvisioningState	The provisioning state of the bastion host IP configuration resource.
properties.publicIPAddress	SubResource	Reference of the PublicIP resource. Null for private only bastion
properties.subnet	SubResource	Reference of the subnet resource.
type	string	Ip configuration type.

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	CloudErrorBody	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	CloudErrorBody[]	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	BastionHostSkuName	Standard	The name of the sku of this Bastion Host.

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

共用方式為

Bastion Hosts - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get Bastion Host

Sample request

Sample response

Get Bastion Host With Private Only

Sample request

Sample response

Get Bastion Host With Zones

Sample request

Sample response

Get Developer Bastion Host

Sample request

Sample response

Definitions

BastionHost

BastionHostIPConfiguration

BastionHostSkuName

CloudError

CloudErrorBody

IPAllocationMethod

IPRule

NetworkAcls

ProvisioningState

Sku

SubResource

其他資源