Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. webpubsub
  5. WebPubSubSharedPrivateLinkResource
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.webpubsub.WebPubSubSharedPrivateLinkResource

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

Describes a Shared Private Link Resource Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2021-04-01-preview.

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.

Example Usage

WebPubSubSharedPrivateLinkResources_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var webPubSubSharedPrivateLinkResource = new AzureNative.WebPubSub.WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResource", new()
    {
        GroupId = "sites",
        PrivateLinkResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp",
        RequestMessage = "Please approve",
        ResourceGroupName = "myResourceGroup",
        ResourceName = "myWebPubSubService",
        SharedPrivateLinkResourceName = "upstream",
    });

});
Copy
package main

import (
	webpubsub "github.com/pulumi/pulumi-azure-native-sdk/webpubsub/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := webpubsub.NewWebPubSubSharedPrivateLinkResource(ctx, "webPubSubSharedPrivateLinkResource", &webpubsub.WebPubSubSharedPrivateLinkResourceArgs{
			GroupId:                       pulumi.String("sites"),
			PrivateLinkResourceId:         pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp"),
			RequestMessage:                pulumi.String("Please approve"),
			ResourceGroupName:             pulumi.String("myResourceGroup"),
			ResourceName:                  pulumi.String("myWebPubSubService"),
			SharedPrivateLinkResourceName: pulumi.String("upstream"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.webpubsub.WebPubSubSharedPrivateLinkResource;
import com.pulumi.azurenative.webpubsub.WebPubSubSharedPrivateLinkResourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var webPubSubSharedPrivateLinkResource = new WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResource", WebPubSubSharedPrivateLinkResourceArgs.builder()
            .groupId("sites")
            .privateLinkResourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp")
            .requestMessage("Please approve")
            .resourceGroupName("myResourceGroup")
            .resourceName("myWebPubSubService")
            .sharedPrivateLinkResourceName("upstream")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const webPubSubSharedPrivateLinkResource = new azure_native.webpubsub.WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResource", {
    groupId: "sites",
    privateLinkResourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp",
    requestMessage: "Please approve",
    resourceGroupName: "myResourceGroup",
    resourceName: "myWebPubSubService",
    sharedPrivateLinkResourceName: "upstream",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

web_pub_sub_shared_private_link_resource = azure_native.webpubsub.WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResource",
    group_id="sites",
    private_link_resource_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp",
    request_message="Please approve",
    resource_group_name="myResourceGroup",
    resource_name_="myWebPubSubService",
    shared_private_link_resource_name="upstream")
Copy
resources:
  webPubSubSharedPrivateLinkResource:
    type: azure-native:webpubsub:WebPubSubSharedPrivateLinkResource
    properties:
      groupId: sites
      privateLinkResourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp
      requestMessage: Please approve
      resourceGroupName: myResourceGroup
      resourceName: myWebPubSubService
      sharedPrivateLinkResourceName: upstream
Copy

Create WebPubSubSharedPrivateLinkResource Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WebPubSubSharedPrivateLinkResource(name: string, args: WebPubSubSharedPrivateLinkResourceArgs, opts?: CustomResourceOptions);
@overload
def WebPubSubSharedPrivateLinkResource(resource_name: str,
                                       args: WebPubSubSharedPrivateLinkResourceArgs,
                                       opts: Optional[ResourceOptions] = None)

@overload
def WebPubSubSharedPrivateLinkResource(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       group_id: Optional[str] = None,
                                       private_link_resource_id: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       resource_name_: Optional[str] = None,
                                       request_message: Optional[str] = None,
                                       shared_private_link_resource_name: Optional[str] = None)
func NewWebPubSubSharedPrivateLinkResource(ctx *Context, name string, args WebPubSubSharedPrivateLinkResourceArgs, opts ...ResourceOption) (*WebPubSubSharedPrivateLinkResource, error)
public WebPubSubSharedPrivateLinkResource(string name, WebPubSubSharedPrivateLinkResourceArgs args, CustomResourceOptions? opts = null)
public WebPubSubSharedPrivateLinkResource(String name, WebPubSubSharedPrivateLinkResourceArgs args)
public WebPubSubSharedPrivateLinkResource(String name, WebPubSubSharedPrivateLinkResourceArgs args, CustomResourceOptions options)

type: azure-native:webpubsub:WebPubSubSharedPrivateLinkResource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WebPubSubSharedPrivateLinkResourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WebPubSubSharedPrivateLinkResourceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WebPubSubSharedPrivateLinkResourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WebPubSubSharedPrivateLinkResourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WebPubSubSharedPrivateLinkResourceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var webPubSubSharedPrivateLinkResourceResource = new AzureNative.Webpubsub.WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResourceResource", new()
{
    GroupId = "string",
    PrivateLinkResourceId = "string",
    ResourceGroupName = "string",
    ResourceName = "string",
    RequestMessage = "string",
    SharedPrivateLinkResourceName = "string",
});
Copy
example, err := webpubsub.NewWebPubSubSharedPrivateLinkResource(ctx, "webPubSubSharedPrivateLinkResourceResource", &webpubsub.WebPubSubSharedPrivateLinkResourceArgs{
	GroupId:                       "string",
	PrivateLinkResourceId:         "string",
	ResourceGroupName:             "string",
	ResourceName:                  "string",
	RequestMessage:                "string",
	SharedPrivateLinkResourceName: "string",
})
Copy
var webPubSubSharedPrivateLinkResourceResource = new WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResourceResource", WebPubSubSharedPrivateLinkResourceArgs.builder()
    .groupId("string")
    .privateLinkResourceId("string")
    .resourceGroupName("string")
    .resourceName("string")
    .requestMessage("string")
    .sharedPrivateLinkResourceName("string")
    .build());
Copy
web_pub_sub_shared_private_link_resource_resource = azure_native.webpubsub.WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResourceResource",
    group_id=string,
    private_link_resource_id=string,
    resource_group_name=string,
    resource_name_=string,
    request_message=string,
    shared_private_link_resource_name=string)
Copy
const webPubSubSharedPrivateLinkResourceResource = new azure_native.webpubsub.WebPubSubSharedPrivateLinkResource("webPubSubSharedPrivateLinkResourceResource", {
    groupId: "string",
    privateLinkResourceId: "string",
    resourceGroupName: "string",
    resourceName: "string",
    requestMessage: "string",
    sharedPrivateLinkResourceName: "string",
});
Copy
type: azure-native:webpubsub:WebPubSubSharedPrivateLinkResource
properties:
    groupId: string
    privateLinkResourceId: string
    requestMessage: string
    resourceGroupName: string
    resourceName: string
    sharedPrivateLinkResourceName: string
Copy

WebPubSubSharedPrivateLinkResource Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WebPubSubSharedPrivateLinkResource resource accepts the following input properties:

GroupId This property is required. string
The group id from the provider of resource the shared private link resource is for
PrivateLinkResourceId This property is required. string
The resource id of the resource the shared private link resource is for
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.
RequestMessage string
The request message for requesting approval of the shared private link resource
SharedPrivateLinkResourceName Changes to this property will trigger replacement. string
The name of the shared private link resource
GroupId This property is required. string
The group id from the provider of resource the shared private link resource is for
PrivateLinkResourceId This property is required. string
The resource id of the resource the shared private link resource is for
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.
RequestMessage string
The request message for requesting approval of the shared private link resource
SharedPrivateLinkResourceName Changes to this property will trigger replacement. string
The name of the shared private link resource
groupId This property is required. String
The group id from the provider of resource the shared private link resource is for
privateLinkResourceId This property is required. String
The resource id of the resource the shared private link resource is for
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.
requestMessage String
The request message for requesting approval of the shared private link resource
sharedPrivateLinkResourceName Changes to this property will trigger replacement. String
The name of the shared private link resource
groupId This property is required. string
The group id from the provider of resource the shared private link resource is for
privateLinkResourceId This property is required. string
The resource id of the resource the shared private link resource is for
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.
requestMessage string
The request message for requesting approval of the shared private link resource
sharedPrivateLinkResourceName Changes to this property will trigger replacement. string
The name of the shared private link resource
group_id This property is required. str
The group id from the provider of resource the shared private link resource is for
private_link_resource_id This property is required. str
The resource id of the resource the shared private link resource is for
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.
request_message str
The request message for requesting approval of the shared private link resource
shared_private_link_resource_name Changes to this property will trigger replacement. str
The name of the shared private link resource
groupId This property is required. String
The group id from the provider of resource the shared private link resource is for
privateLinkResourceId This property is required. String
The resource id of the resource the shared private link resource is for
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.
requestMessage String
The request message for requesting approval of the shared private link resource
sharedPrivateLinkResourceName Changes to this property will trigger replacement. String
The name of the shared private link resource

Outputs

All input properties are implicitly available as output properties. Additionally, the WebPubSubSharedPrivateLinkResource resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource.
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"
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource.
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"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource.
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"
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource.
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"
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource.
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"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource.
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"

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:webpubsub:WebPubSubSharedPrivateLinkResource upstream /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

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