1. Packages
  2. Azure Native v2
  3. API Docs
  4. webpubsub
  5. getWebPubSubSharedPrivateLinkResource
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

azure-native-v2.webpubsub.getWebPubSubSharedPrivateLinkResource

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

Get the specified shared private link resource Azure REST API version: 2023-02-01.

Other available API versions: 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview.

Using getWebPubSubSharedPrivateLinkResource

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 getWebPubSubSharedPrivateLinkResource(args: GetWebPubSubSharedPrivateLinkResourceArgs, opts?: InvokeOptions): Promise<GetWebPubSubSharedPrivateLinkResourceResult>
function getWebPubSubSharedPrivateLinkResourceOutput(args: GetWebPubSubSharedPrivateLinkResourceOutputArgs, opts?: InvokeOptions): Output<GetWebPubSubSharedPrivateLinkResourceResult>
Copy
def get_web_pub_sub_shared_private_link_resource(resource_group_name: Optional[str] = None,
                                                 resource_name: Optional[str] = None,
                                                 shared_private_link_resource_name: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetWebPubSubSharedPrivateLinkResourceResult
def get_web_pub_sub_shared_private_link_resource_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                                 resource_name: Optional[pulumi.Input[str]] = None,
                                                 shared_private_link_resource_name: Optional[pulumi.Input[str]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetWebPubSubSharedPrivateLinkResourceResult]
Copy
func LookupWebPubSubSharedPrivateLinkResource(ctx *Context, args *LookupWebPubSubSharedPrivateLinkResourceArgs, opts ...InvokeOption) (*LookupWebPubSubSharedPrivateLinkResourceResult, error)
func LookupWebPubSubSharedPrivateLinkResourceOutput(ctx *Context, args *LookupWebPubSubSharedPrivateLinkResourceOutputArgs, opts ...InvokeOption) LookupWebPubSubSharedPrivateLinkResourceResultOutput
Copy

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

public static class GetWebPubSubSharedPrivateLinkResource 
{
    public static Task<GetWebPubSubSharedPrivateLinkResourceResult> InvokeAsync(GetWebPubSubSharedPrivateLinkResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetWebPubSubSharedPrivateLinkResourceResult> Invoke(GetWebPubSubSharedPrivateLinkResourceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWebPubSubSharedPrivateLinkResourceResult> getWebPubSubSharedPrivateLinkResource(GetWebPubSubSharedPrivateLinkResourceArgs args, InvokeOptions options)
public static Output<GetWebPubSubSharedPrivateLinkResourceResult> getWebPubSubSharedPrivateLinkResource(GetWebPubSubSharedPrivateLinkResourceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:webpubsub:getWebPubSubSharedPrivateLinkResource
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
SharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the shared private link resource
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
SharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the shared private link resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the shared private link resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the shared private link resource
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource.
shared_private_link_resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the shared private link resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the shared private link resource

getWebPubSubSharedPrivateLinkResource Result

The following output properties are available:

GroupId string
The group id from the provider of resource the shared private link resource is for
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
PrivateLinkResourceId string
The resource id of the resource the shared private link resource is for
ProvisioningState string
Provisioning state of the resource.
Status string
Status of the shared private link resource
SystemData Pulumi.AzureNative.WebPubSub.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
RequestMessage string
The request message for requesting approval of the shared private link resource
GroupId string
The group id from the provider of resource the shared private link resource is for
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
PrivateLinkResourceId string
The resource id of the resource the shared private link resource is for
ProvisioningState string
Provisioning state of the resource.
Status string
Status of the shared private link resource
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
RequestMessage string
The request message for requesting approval of the shared private link resource
groupId String
The group id from the provider of resource the shared private link resource is for
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
privateLinkResourceId String
The resource id of the resource the shared private link resource is for
provisioningState String
Provisioning state of the resource.
status String
Status of the shared private link resource
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
requestMessage String
The request message for requesting approval of the shared private link resource
groupId string
The group id from the provider of resource the shared private link resource is for
id string
Fully qualified resource Id for the resource.
name string
The name of the resource.
privateLinkResourceId string
The resource id of the resource the shared private link resource is for
provisioningState string
Provisioning state of the resource.
status string
Status of the shared private link resource
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
requestMessage string
The request message for requesting approval of the shared private link resource
group_id str
The group id from the provider of resource the shared private link resource is for
id str
Fully qualified resource Id for the resource.
name str
The name of the resource.
private_link_resource_id str
The resource id of the resource the shared private link resource is for
provisioning_state str
Provisioning state of the resource.
status str
Status of the shared private link resource
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
request_message str
The request message for requesting approval of the shared private link resource
groupId String
The group id from the provider of resource the shared private link resource is for
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
privateLinkResourceId String
The resource id of the resource the shared private link resource is for
provisioningState String
Provisioning state of the resource.
status String
Status of the shared private link resource
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
requestMessage String
The request message for requesting approval of the shared private link resource

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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