bastion_shareable_links

Creates, updates, deletes, gets or lists a bastion_shareable_links resource.

Overview

Name	bastion_shareable_links
Type	Resource
Id	azure.network.bastion_shareable_links

Fields

The following fields are returned by SELECT queries:

get

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

Name	Datatype	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	object	Reference of the virtual machine resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, bastionHostName, subscriptionId		Return the Bastion Shareable Links for all the VMs specified in the request.
put	exec	resourceGroupName, bastionHostName, subscriptionId		Creates a Bastion Shareable Links for all the VMs specified in the request.
delete	exec	resourceGroupName, bastionHostName, subscriptionId		Deletes the Bastion Shareable Links for all the VMs specified in the request.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bastionHostName	string	The name of the Bastion Host.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

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

SELECT
bsl,
createdAt,
message,
vm
FROM azure.network.bastion_shareable_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND bastionHostName = '{{ bastionHostName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

Lifecycle Methods

put

Creates a Bastion Shareable Links for all the VMs specified in the request.

EXEC azure.network.bastion_shareable_links.put 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bastionHostName='{{ bastionHostName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"vms": "{{ vms }}"
}'
;

delete

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

EXEC azure.network.bastion_shareable_links.delete 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bastionHostName='{{ bastionHostName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"vms": "{{ vms }}"
}'
;