Delete Bastion Shareable Link - Delete Bastion Shareable Link
Deletes 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}/deleteShareableLinks?api-version=2024-03-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
bastion
|
path | True |
string |
The name of the Bastion Host. |
resource
|
path | True |
string |
The name of the resource group. |
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. |
Request Body
Name | Type | Description |
---|---|---|
vms |
List of VM references. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. The operation deleted the BastionShareableLinks associated with the VMs, if they existed. No return body. |
|
202 Accepted |
Accepted and the operation will complete asynchronously. |
|
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
Delete Bastion Shareable Links for the request VMs
Sample request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/deleteShareableLinks?api-version=2024-03-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
location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}
Definitions
Name | Description |
---|---|
Bastion |
Bastion Shareable Link. |
Bastion |
Post request for Create/Delete/Get Bastion Shareable Link endpoints. |
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
VM |
Describes a Virtual Machine. |
BastionShareableLink
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 Create/Delete/Get Bastion Shareable Link endpoints.
Name | Type | Description |
---|---|---|
vms |
List of VM references. |
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. |