Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getBastionShareableLink
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getBastionShareableLink

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Return the Bastion Shareable Links for all the VMs specified in the request. Azure REST API version: 2023-02-01.

Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using getBastionShareableLink

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBastionShareableLink(args: GetBastionShareableLinkArgs, opts?: InvokeOptions): Promise<GetBastionShareableLinkResult>
function getBastionShareableLinkOutput(args: GetBastionShareableLinkOutputArgs, opts?: InvokeOptions): Output<GetBastionShareableLinkResult>
Copy
def get_bastion_shareable_link(bastion_host_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               vms: Optional[Sequence[BastionShareableLink]] = None,
                               opts: Optional[InvokeOptions] = None) -> GetBastionShareableLinkResult
def get_bastion_shareable_link_output(bastion_host_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               vms: Optional[pulumi.Input[Sequence[pulumi.Input[BastionShareableLinkArgs]]]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetBastionShareableLinkResult]
Copy
func GetBastionShareableLink(ctx *Context, args *GetBastionShareableLinkArgs, opts ...InvokeOption) (*GetBastionShareableLinkResult, error)
func GetBastionShareableLinkOutput(ctx *Context, args *GetBastionShareableLinkOutputArgs, opts ...InvokeOption) GetBastionShareableLinkResultOutput
Copy

> Note: This function is named GetBastionShareableLink in the Go SDK.

public static class GetBastionShareableLink 
{
    public static Task<GetBastionShareableLinkResult> InvokeAsync(GetBastionShareableLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetBastionShareableLinkResult> Invoke(GetBastionShareableLinkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBastionShareableLinkResult> getBastionShareableLink(GetBastionShareableLinkArgs args, InvokeOptions options)
public static Output<GetBastionShareableLinkResult> getBastionShareableLink(GetBastionShareableLinkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getBastionShareableLink
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BastionHostName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bastion Host.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Vms List<Pulumi.AzureNative.Network.Inputs.BastionShareableLink>
List of VM references.
BastionHostName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bastion Host.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Vms []BastionShareableLink
List of VM references.
bastionHostName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Bastion Host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
vms List<BastionShareableLink>
List of VM references.
bastionHostName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bastion Host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
vms BastionShareableLink[]
List of VM references.
bastion_host_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Bastion Host.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
vms Sequence[BastionShareableLink]
List of VM references.
bastionHostName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Bastion Host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
vms List<Property Map>
List of VM references.

getBastionShareableLink Result

The following output properties are available:

NextLink string
The URL to get the next set of results.
Value List<Pulumi.AzureNative.Network.Outputs.BastionShareableLinkResponse>
List of Bastion Shareable Links for the request.
NextLink string
The URL to get the next set of results.
Value []BastionShareableLinkResponse
List of Bastion Shareable Links for the request.
nextLink String
The URL to get the next set of results.
value List<BastionShareableLinkResponse>
List of Bastion Shareable Links for the request.
nextLink string
The URL to get the next set of results.
value BastionShareableLinkResponse[]
List of Bastion Shareable Links for the request.
next_link str
The URL to get the next set of results.
value Sequence[BastionShareableLinkResponse]
List of Bastion Shareable Links for the request.
nextLink String
The URL to get the next set of results.
value List<Property Map>
List of Bastion Shareable Links for the request.

Supporting Types

Vm This property is required. Pulumi.AzureNative.Network.Inputs.VM
Reference of the virtual machine resource.
Vm This property is required. VM
Reference of the virtual machine resource.
vm This property is required. VM
Reference of the virtual machine resource.
vm This property is required. VM
Reference of the virtual machine resource.
vm This property is required. VM
Reference of the virtual machine resource.
vm This property is required. Property Map
Reference of the virtual machine resource.

BastionShareableLinkResponse

Bsl This property is required. string
The unique Bastion Shareable Link to the virtual machine.
CreatedAt This property is required. string
The time when the link was created.
Message This property is required. string
Optional field indicating the warning or error message related to the vm in case of partial failure.
Vm This property is required. Pulumi.AzureNative.Network.Inputs.VMResponse
Reference of the virtual machine resource.
Bsl This property is required. string
The unique Bastion Shareable Link to the virtual machine.
CreatedAt This property is required. string
The time when the link was created.
Message This property is required. string
Optional field indicating the warning or error message related to the vm in case of partial failure.
Vm This property is required. VMResponse
Reference of the virtual machine resource.
bsl This property is required. String
The unique Bastion Shareable Link to the virtual machine.
createdAt This property is required. String
The time when the link was created.
message This property is required. String
Optional field indicating the warning or error message related to the vm in case of partial failure.
vm This property is required. VMResponse
Reference of the virtual machine resource.
bsl This property is required. string
The unique Bastion Shareable Link to the virtual machine.
createdAt This property is required. string
The time when the link was created.
message This property is required. string
Optional field indicating the warning or error message related to the vm in case of partial failure.
vm This property is required. VMResponse
Reference of the virtual machine resource.
bsl This property is required. str
The unique Bastion Shareable Link to the virtual machine.
created_at This property is required. str
The time when the link was created.
message This property is required. str
Optional field indicating the warning or error message related to the vm in case of partial failure.
vm This property is required. VMResponse
Reference of the virtual machine resource.
bsl This property is required. String
The unique Bastion Shareable Link to the virtual machine.
createdAt This property is required. String
The time when the link was created.
message This property is required. String
Optional field indicating the warning or error message related to the vm in case of partial failure.
vm This property is required. Property Map
Reference of the virtual machine resource.

VM

Id string
Resource ID.
Location string
Resource location.
Tags Dictionary<string, string>
Resource tags.
Id string
Resource ID.
Location string
Resource location.
Tags map[string]string
Resource tags.
id String
Resource ID.
location String
Resource location.
tags Map<String,String>
Resource tags.
id string
Resource ID.
location string
Resource location.
tags {[key: string]: string}
Resource tags.
id str
Resource ID.
location str
Resource location.
tags Mapping[str, str]
Resource tags.
id String
Resource ID.
location String
Resource location.
tags Map<String>
Resource tags.

VMResponse

Name This property is required. string
Resource name.
Type This property is required. string
Resource type.
Id string
Resource ID.
Location string
Resource location.
Tags Dictionary<string, string>
Resource tags.
Name This property is required. string
Resource name.
Type This property is required. string
Resource type.
Id string
Resource ID.
Location string
Resource location.
Tags map[string]string
Resource tags.
name This property is required. String
Resource name.
type This property is required. String
Resource type.
id String
Resource ID.
location String
Resource location.
tags Map<String,String>
Resource tags.
name This property is required. string
Resource name.
type This property is required. string
Resource type.
id string
Resource ID.
location string
Resource location.
tags {[key: string]: string}
Resource tags.
name This property is required. str
Resource name.
type This property is required. str
Resource type.
id str
Resource ID.
location str
Resource location.
tags Mapping[str, str]
Resource tags.
name This property is required. String
Resource name.
type This property is required. String
Resource type.
id String
Resource ID.
location String
Resource location.
tags Map<String>
Resource tags.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native