Get Bastion Shareable Link - Get Bastion Shareable Link

Return the Bastion Shareable Links for all the VMs specified in the request.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getShareableLinks?api-version=2022-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.

Request Body

Name Type Description
vms

List of VM references.

Responses

Name Type Description
200 OK

Success. The operation returns a list of shareable links for the specified VMs, giving appropriate error messages as needed.

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

Sample Request

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

{
  "vms": [
    {
      "vm": {
        "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1"
      }
    },
    {
      "vm": {
        "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2"
      }
    }
  ]
}

Sample Response

{
  "value": [
    {
      "vm": {
        "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1"
      },
      "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm1",
      "createdAt": "2019-10-18T12:00:00.0000Z"
    },
    {
      "vm": {
        "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2"
      },
      "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm2",
      "createdAt": "2019-10-17T12:00:00.0000Z"
    }
  ]
}

Definitions

BastionShareableLink

Bastion Shareable Link.

BastionShareableLinkListRequest

Post request for all the Bastion Shareable Link endpoints.

BastionShareableLinkListResult

Response for all the Bastion Shareable Link endpoints.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

VM

Describes a Virtual Machine.

Bastion Shareable Link.

Name Type Description
bsl
  • string

The unique Bastion Shareable Link to the virtual machine.

createdAt
  • string

The time when the link was created.

message
  • string

Optional field indicating the warning or error message related to the vm in case of partial failure.

vm

Reference of the virtual machine resource.

BastionShareableLinkListRequest

Post request for all the Bastion Shareable Link endpoints.

Name Type Description
vms

List of VM references.

BastionShareableLinkListResult

Response for all the Bastion Shareable Link endpoints.

Name Type Description
nextLink
  • string

The URL to get the next set of results.

value

List of Bastion Shareable Links for the request.

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.

VM

Describes a Virtual Machine.

Name Type Description
id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

tags
  • object

Resource tags.

type
  • string

Resource type.