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_bastion_shareable_link

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. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bastion_shareable_link	select	resource_group_name, bastion_host_name, subscription_id		Return the Bastion Shareable Links for all the VMs specified in the request.
delete_bastion_shareable_link	delete	resource_group_name, bastion_host_name, subscription_id		Deletes the Bastion Shareable Links for all the VMs specified in the request.
put_bastion_shareable_link	exec	resource_group_name, bastion_host_name, subscription_id		Creates a Bastion Shareable Links for all the VMs specified in the request.
delete_bastion_shareable_link_by_token	exec	resource_group_name, bastion_host_name, subscription_id		Deletes the Bastion Shareable Links for all the tokens 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
bastion_host_name	string	The name of the Bastion Host. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_bastion_shareable_link

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 resource_group_name = '{{ resource_group_name }}' -- required
AND bastion_host_name = '{{ bastion_host_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete_bastion_shareable_link

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

DELETE FROM azure.network.bastion_shareable_links
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND bastion_host_name = '{{ bastion_host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put_bastion_shareable_link

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

EXEC azure.network.bastion_shareable_links.put_bastion_shareable_link 
@resource_group_name='{{ resource_group_name }}' --required, 
@bastion_host_name='{{ bastion_host_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"vms": "{{ vms }}"
}'
;

delete_bastion_shareable_link_by_token

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

EXEC azure.network.bastion_shareable_links.delete_bastion_shareable_link_by_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@bastion_host_name='{{ bastion_host_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tokens": "{{ tokens }}"
}'
;