Azure Classic v5.38.0, Mar 21 23

azure.signalr.SharedPrivateLinkResource

Manages the Shared Private Link Resource for a Signalr service.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var current = Azure.Core.GetClientConfig.Invoke();

    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "east us",
    });

    var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        SkuName = "standard",
        SoftDeleteRetentionDays = 7,
        AccessPolicies = new[]
        {
            new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
            {
                TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
                ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
                CertificatePermissions = new[]
                {
                    "ManageContacts",
                },
                KeyPermissions = new[]
                {
                    "Create",
                },
                SecretPermissions = new[]
                {
                    "Set",
                },
            },
        },
    });

    var test = new Azure.SignalR.Service("test", new()
    {
        Location = azurerm_resource_group.Test.Location,
        ResourceGroupName = azurerm_resource_group.Test.Name,
        Sku = new Azure.SignalR.Inputs.ServiceSkuArgs
        {
            Name = "Standard_S1",
            Capacity = 1,
        },
    });

    var exampleSharedPrivateLinkResource = new Azure.SignalR.SharedPrivateLinkResource("exampleSharedPrivateLinkResource", new()
    {
        SignalrServiceId = azurerm_signalr_service.Example.Id,
        SubResourceName = "vault",
        TargetResourceId = exampleKeyVault.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/keyvault"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/signalr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("east us"),
		})
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "exampleKeyVault", &keyvault.KeyVaultArgs{
			Location:                exampleResourceGroup.Location,
			ResourceGroupName:       exampleResourceGroup.Name,
			TenantId:                *pulumi.String(current.TenantId),
			SkuName:                 pulumi.String("standard"),
			SoftDeleteRetentionDays: pulumi.Int(7),
			AccessPolicies: keyvault.KeyVaultAccessPolicyArray{
				&keyvault.KeyVaultAccessPolicyArgs{
					TenantId: *pulumi.String(current.TenantId),
					ObjectId: *pulumi.String(current.ObjectId),
					CertificatePermissions: pulumi.StringArray{
						pulumi.String("ManageContacts"),
					},
					KeyPermissions: pulumi.StringArray{
						pulumi.String("Create"),
					},
					SecretPermissions: pulumi.StringArray{
						pulumi.String("Set"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = signalr.NewService(ctx, "test", &signalr.ServiceArgs{
			Location:          pulumi.Any(azurerm_resource_group.Test.Location),
			ResourceGroupName: pulumi.Any(azurerm_resource_group.Test.Name),
			Sku: &signalr.ServiceSkuArgs{
				Name:     pulumi.String("Standard_S1"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		_, err = signalr.NewSharedPrivateLinkResource(ctx, "exampleSharedPrivateLinkResource", &signalr.SharedPrivateLinkResourceArgs{
			SignalrServiceId: pulumi.Any(azurerm_signalr_service.Example.Id),
			SubResourceName:  pulumi.String("vault"),
			TargetResourceId: exampleKeyVault.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.keyvault.KeyVault;
import com.pulumi.azure.keyvault.KeyVaultArgs;
import com.pulumi.azure.keyvault.inputs.KeyVaultAccessPolicyArgs;
import com.pulumi.azure.signalr.Service;
import com.pulumi.azure.signalr.ServiceArgs;
import com.pulumi.azure.signalr.inputs.ServiceSkuArgs;
import com.pulumi.azure.signalr.SharedPrivateLinkResource;
import com.pulumi.azure.signalr.SharedPrivateLinkResourceArgs;
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) {
        final var current = CoreFunctions.getClientConfig();

        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("east us")
            .build());

        var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .skuName("standard")
            .softDeleteRetentionDays(7)
            .accessPolicies(KeyVaultAccessPolicyArgs.builder()
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
                .certificatePermissions("ManageContacts")
                .keyPermissions("Create")
                .secretPermissions("Set")
                .build())
            .build());

        var test = new Service("test", ServiceArgs.builder()        
            .location(azurerm_resource_group.test().location())
            .resourceGroupName(azurerm_resource_group.test().name())
            .sku(ServiceSkuArgs.builder()
                .name("Standard_S1")
                .capacity(1)
                .build())
            .build());

        var exampleSharedPrivateLinkResource = new SharedPrivateLinkResource("exampleSharedPrivateLinkResource", SharedPrivateLinkResourceArgs.builder()        
            .signalrServiceId(azurerm_signalr_service.example().id())
            .subResourceName("vault")
            .targetResourceId(exampleKeyVault.id())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="east us")
example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tenant_id=current.tenant_id,
    sku_name="standard",
    soft_delete_retention_days=7,
    access_policies=[azure.keyvault.KeyVaultAccessPolicyArgs(
        tenant_id=current.tenant_id,
        object_id=current.object_id,
        certificate_permissions=["ManageContacts"],
        key_permissions=["Create"],
        secret_permissions=["Set"],
    )])
test = azure.signalr.Service("test",
    location=azurerm_resource_group["test"]["location"],
    resource_group_name=azurerm_resource_group["test"]["name"],
    sku=azure.signalr.ServiceSkuArgs(
        name="Standard_S1",
        capacity=1,
    ))
example_shared_private_link_resource = azure.signalr.SharedPrivateLinkResource("exampleSharedPrivateLinkResource",
    signalr_service_id=azurerm_signalr_service["example"]["id"],
    sub_resource_name="vault",
    target_resource_id=example_key_vault.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "east us"});
const exampleKeyVault = new azure.keyvault.KeyVault("exampleKeyVault", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "standard",
    softDeleteRetentionDays: 7,
    accessPolicies: [{
        tenantId: current.then(current => current.tenantId),
        objectId: current.then(current => current.objectId),
        certificatePermissions: ["ManageContacts"],
        keyPermissions: ["Create"],
        secretPermissions: ["Set"],
    }],
});
const test = new azure.signalr.Service("test", {
    location: azurerm_resource_group.test.location,
    resourceGroupName: azurerm_resource_group.test.name,
    sku: {
        name: "Standard_S1",
        capacity: 1,
    },
});
const exampleSharedPrivateLinkResource = new azure.signalr.SharedPrivateLinkResource("exampleSharedPrivateLinkResource", {
    signalrServiceId: azurerm_signalr_service.example.id,
    subResourceName: "vault",
    targetResourceId: exampleKeyVault.id,
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: east us
  exampleKeyVault:
    type: azure:keyvault:KeyVault
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      tenantId: ${current.tenantId}
      skuName: standard
      softDeleteRetentionDays: 7
      accessPolicies:
        - tenantId: ${current.tenantId}
          objectId: ${current.objectId}
          certificatePermissions:
            - ManageContacts
          keyPermissions:
            - Create
          secretPermissions:
            - Set
  test:
    type: azure:signalr:Service
    properties:
      location: ${azurerm_resource_group.test.location}
      resourceGroupName: ${azurerm_resource_group.test.name}
      sku:
        name: Standard_S1
        capacity: 1
  exampleSharedPrivateLinkResource:
    type: azure:signalr:SharedPrivateLinkResource
    properties:
      signalrServiceId: ${azurerm_signalr_service.example.id}
      subResourceName: vault
      targetResourceId: ${exampleKeyVault.id}
variables:
  current:
    fn::invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

Create SharedPrivateLinkResource Resource

new SharedPrivateLinkResource(name: string, args: SharedPrivateLinkResourceArgs, opts?: CustomResourceOptions);

@overload
def SharedPrivateLinkResource(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              name: Optional[str] = None,
                              request_message: Optional[str] = None,
                              signalr_service_id: Optional[str] = None,
                              sub_resource_name: Optional[str] = None,
                              target_resource_id: Optional[str] = None)
@overload
def SharedPrivateLinkResource(resource_name: str,
                              args: SharedPrivateLinkResourceArgs,
                              opts: Optional[ResourceOptions] = None)

func NewSharedPrivateLinkResource(ctx *Context, name string, args SharedPrivateLinkResourceArgs, opts ...ResourceOption) (*SharedPrivateLinkResource, error)

public SharedPrivateLinkResource(string name, SharedPrivateLinkResourceArgs args, CustomResourceOptions? opts = null)

public SharedPrivateLinkResource(String name, SharedPrivateLinkResourceArgs args)
public SharedPrivateLinkResource(String name, SharedPrivateLinkResourceArgs args, CustomResourceOptions options)

type: azure:signalr:SharedPrivateLinkResource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SharedPrivateLinkResourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SharedPrivateLinkResourceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SharedPrivateLinkResourceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SharedPrivateLinkResourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SharedPrivateLinkResourceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

SharedPrivateLinkResource Resource Properties

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

Inputs

The SharedPrivateLinkResource resource accepts the following input properties:

SignalrServiceId string: The id of the Signalr Service. Changing this forces a new resource to be created.
SubResourceName string: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.
Name string: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
RequestMessage string: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.

SignalrServiceId string: The id of the Signalr Service. Changing this forces a new resource to be created.
SubResourceName string: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.
Name string: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
RequestMessage string: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.

signalrServiceId String: The id of the Signalr Service. Changing this forces a new resource to be created.
subResourceName String: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
targetResourceId String: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.
name String: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
requestMessage String: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.

signalrServiceId string: The id of the Signalr Service. Changing this forces a new resource to be created.
subResourceName string: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
targetResourceId string: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.
name string: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
requestMessage string: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.

signalr_service_id str: The id of the Signalr Service. Changing this forces a new resource to be created.
sub_resource_name str: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
target_resource_id str: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.
name str: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
request_message str: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.

signalrServiceId String: The id of the Signalr Service. Changing this forces a new resource to be created.
subResourceName String: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
targetResourceId String: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.
name String: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
requestMessage String: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

id String: The provider-assigned unique ID for this managed resource.
status String: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

id string: The provider-assigned unique ID for this managed resource.
status string: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

id str: The provider-assigned unique ID for this managed resource.
status str: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

id String: The provider-assigned unique ID for this managed resource.
status String: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

Look up Existing SharedPrivateLinkResource Resource

Get an existing SharedPrivateLinkResource resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SharedPrivateLinkResourceState, opts?: CustomResourceOptions): SharedPrivateLinkResource

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        request_message: Optional[str] = None,
        signalr_service_id: Optional[str] = None,
        status: Optional[str] = None,
        sub_resource_name: Optional[str] = None,
        target_resource_id: Optional[str] = None) -> SharedPrivateLinkResource

func GetSharedPrivateLinkResource(ctx *Context, name string, id IDInput, state *SharedPrivateLinkResourceState, opts ...ResourceOption) (*SharedPrivateLinkResource, error)

public static SharedPrivateLinkResource Get(string name, Input<string> id, SharedPrivateLinkResourceState? state, CustomResourceOptions? opts = null)

public static SharedPrivateLinkResource get(String name, Output<String> id, SharedPrivateLinkResourceState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Name string: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
RequestMessage string: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.
SignalrServiceId string: The id of the Signalr Service. Changing this forces a new resource to be created.
Status string: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
SubResourceName string: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.

Name string: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
RequestMessage string: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.
SignalrServiceId string: The id of the Signalr Service. Changing this forces a new resource to be created.
Status string: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
SubResourceName string: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.

name String: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
requestMessage String: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.
signalrServiceId String: The id of the Signalr Service. Changing this forces a new resource to be created.
status String: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
subResourceName String: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
targetResourceId String: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.

name string: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
requestMessage string: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.
signalrServiceId string: The id of the Signalr Service. Changing this forces a new resource to be created.
status string: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
subResourceName string: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
targetResourceId string: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.

name str: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
request_message str: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.
signalr_service_id str: The id of the Signalr Service. Changing this forces a new resource to be created.
status str: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
sub_resource_name str: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
target_resource_id str: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.

name String: The name of the Signalr Shared Private Link Resource. Changing this forces a new resource to be created.
requestMessage String: The request message for requesting approval of the Shared Private Link Enabled Remote Resource.
signalrServiceId String: The id of the Signalr Service. Changing this forces a new resource to be created.
status String: The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
subResourceName String: The sub resource name which the Signalr Private Endpoint can connect to. Possible values are sites, vault. Changing this forces a new resource to be created.
targetResourceId String: The ID of the Shared Private Link Enabled Remote Resource which this Signalr Private Endpoint should be connected to. Changing this forces a new resource to be created.

Import

Signalr Shared Private Link Resource can be imported using the resource id, e.g.

 $ pulumi import azure:signalr/sharedPrivateLinkResource:SharedPrivateLinkResource example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.SignalRService/signalR/signalr1/sharedPrivateLinkResources/resource1

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.