1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getBastionShareableLink
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

azure-native.network.getBastionShareableLink

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

    Return the Bastion Shareable Links for all the VMs specified in the request. Azure REST API version: 2023-02-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>
    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]
    func GetBastionShareableLink(ctx *Context, args *GetBastionShareableLinkArgs, opts ...InvokeOption) (*GetBastionShareableLinkResult, error)
    func GetBastionShareableLinkOutput(ctx *Context, args *GetBastionShareableLinkOutputArgs, opts ...InvokeOption) GetBastionShareableLinkResultOutput

    > 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)
    }
    public static CompletableFuture<GetBastionShareableLinkResult> getBastionShareableLink(GetBastionShareableLinkArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getBastionShareableLink
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BastionHostName string

    The name of the Bastion Host.

    ResourceGroupName string

    The name of the resource group.

    Vms List<Pulumi.AzureNative.Network.Inputs.BastionShareableLink>

    List of VM references.

    BastionHostName string

    The name of the Bastion Host.

    ResourceGroupName string

    The name of the resource group.

    Vms []BastionShareableLink

    List of VM references.

    bastionHostName String

    The name of the Bastion Host.

    resourceGroupName String

    The name of the resource group.

    vms List<BastionShareableLink>

    List of VM references.

    bastionHostName string

    The name of the Bastion Host.

    resourceGroupName string

    The name of the resource group.

    vms BastionShareableLink[]

    List of VM references.

    bastion_host_name str

    The name of the Bastion Host.

    resource_group_name str

    The name of the resource group.

    vms Sequence[BastionShareableLink]

    List of VM references.

    bastionHostName String

    The name of the Bastion Host.

    resourceGroupName 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 Pulumi.AzureNative.Network.Inputs.VM

    Reference of the virtual machine resource.

    Vm VM

    Reference of the virtual machine resource.

    vm VM

    Reference of the virtual machine resource.

    vm VM

    Reference of the virtual machine resource.

    vm VM

    Reference of the virtual machine resource.

    vm Property Map

    Reference of the virtual machine resource.

    BastionShareableLinkResponse

    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 Pulumi.AzureNative.Network.Inputs.VMResponse

    Reference of the virtual machine resource.

    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 VMResponse

    Reference of the virtual machine resource.

    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 VMResponse

    Reference of the virtual machine resource.

    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 VMResponse

    Reference of the virtual machine resource.

    bsl str

    The unique Bastion Shareable Link to the virtual machine.

    created_at str

    The time when the link was created.

    message str

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

    vm VMResponse

    Reference of the virtual machine resource.

    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 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 string

    Resource name.

    Type string

    Resource type.

    Id string

    Resource ID.

    Location string

    Resource location.

    Tags Dictionary<string, string>

    Resource tags.

    Name string

    Resource name.

    Type string

    Resource type.

    Id string

    Resource ID.

    Location string

    Resource location.

    Tags map[string]string

    Resource tags.

    name String

    Resource name.

    type String

    Resource type.

    id String

    Resource ID.

    location String

    Resource location.

    tags Map<String,String>

    Resource tags.

    name string

    Resource name.

    type string

    Resource type.

    id string

    Resource ID.

    location string

    Resource location.

    tags {[key: string]: string}

    Resource tags.

    name str

    Resource name.

    type str

    Resource type.

    id str

    Resource ID.

    location str

    Resource location.

    tags Mapping[str, str]

    Resource tags.

    name String

    Resource name.

    type String

    Resource type.

    id String

    Resource ID.

    location String

    Resource location.

    tags Map<String>

    Resource tags.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi