Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. webpubsub
  5. CustomCertificate

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.webpubsub.CustomCertificate

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Azure Web PubSub Custom Certificate.

Example Usage

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

const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleWebPubsubService = new azurerm.index.WebPubsubService("example", {
    name: "example-webpubsub",
    location: testAzurermResourceGroup.location,
    resourceGroupName: testAzurermResourceGroup.name,
    sku: [{
        name: "Premium_P1",
        capacity: 1,
    }],
    identity: [{
        type: "SystemAssigned",
    }],
});
const exampleKeyVault = new azure.keyvault.KeyVault("example", {
    name: "examplekeyvault",
    location: example.location,
    resourceGroupName: example.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "premium",
    accessPolicies: [
        {
            tenantId: current.then(current => current.tenantId),
            objectId: current.then(current => current.objectId),
            certificatePermissions: [
                "Create",
                "Get",
                "List",
            ],
            secretPermissions: [
                "Get",
                "List",
            ],
        },
        {
            tenantId: current.then(current => current.tenantId),
            objectId: testAzurermWebPubsubService.identity[0].principalId,
            certificatePermissions: [
                "Create",
                "Get",
                "List",
            ],
            secretPermissions: [
                "Get",
                "List",
            ],
        },
    ],
});
const exampleCertificate = new azure.keyvault.Certificate("example", {
    name: "imported-cert",
    keyVaultId: exampleKeyVault.id,
    certificate: {
        contents: std.filebase64({
            input: "certificate-to-import.pfx",
        }).then(invoke => invoke.result),
        password: "",
    },
});
const test = new azure.webpubsub.CustomCertificate("test", {
    name: "example-cert",
    webPubsubId: exampleWebPubsubService.id,
    customCertificateId: exampleCertificate.id,
}, {
    dependsOn: [exampleAzurermKeyVaultAccessPolicy],
});
Copy
import pulumi
import pulumi_azure as azure
import pulumi_azurerm as azurerm
import pulumi_std as std

current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_web_pubsub_service = azurerm.index.WebPubsubService("example",
    name=example-webpubsub,
    location=test_azurerm_resource_group.location,
    resource_group_name=test_azurerm_resource_group.name,
    sku=[{
        name: Premium_P1,
        capacity: 1,
    }],
    identity=[{
        type: SystemAssigned,
    }])
example_key_vault = azure.keyvault.KeyVault("example",
    name="examplekeyvault",
    location=example.location,
    resource_group_name=example.name,
    tenant_id=current.tenant_id,
    sku_name="premium",
    access_policies=[
        {
            "tenant_id": current.tenant_id,
            "object_id": current.object_id,
            "certificate_permissions": [
                "Create",
                "Get",
                "List",
            ],
            "secret_permissions": [
                "Get",
                "List",
            ],
        },
        {
            "tenant_id": current.tenant_id,
            "object_id": test_azurerm_web_pubsub_service["identity"][0]["principalId"],
            "certificate_permissions": [
                "Create",
                "Get",
                "List",
            ],
            "secret_permissions": [
                "Get",
                "List",
            ],
        },
    ])
example_certificate = azure.keyvault.Certificate("example",
    name="imported-cert",
    key_vault_id=example_key_vault.id,
    certificate={
        "contents": std.filebase64(input="certificate-to-import.pfx").result,
        "password": "",
    })
test = azure.webpubsub.CustomCertificate("test",
    name="example-cert",
    web_pubsub_id=example_web_pubsub_service["id"],
    custom_certificate_id=example_certificate.id,
    opts = pulumi.ResourceOptions(depends_on=[example_azurerm_key_vault_access_policy]))
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/keyvault"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/webpubsub"
	"github.com/pulumi/pulumi-azurerm/sdk/go/azurerm"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleWebPubsubService, err := azurerm.NewWebPubsubService(ctx, "example", &azurerm.WebPubsubServiceArgs{
			Name:              "example-webpubsub",
			Location:          testAzurermResourceGroup.Location,
			ResourceGroupName: testAzurermResourceGroup.Name,
			Sku: []map[string]interface{}{
				map[string]interface{}{
					"name":     "Premium_P1",
					"capacity": 1,
				},
			},
			Identity: []map[string]interface{}{
				map[string]interface{}{
					"type": "SystemAssigned",
				},
			},
		})
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
			Name:              pulumi.String("examplekeyvault"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			TenantId:          pulumi.String(current.TenantId),
			SkuName:           pulumi.String("premium"),
			AccessPolicies: keyvault.KeyVaultAccessPolicyArray{
				&keyvault.KeyVaultAccessPolicyArgs{
					TenantId: pulumi.String(current.TenantId),
					ObjectId: pulumi.String(current.ObjectId),
					CertificatePermissions: pulumi.StringArray{
						pulumi.String("Create"),
						pulumi.String("Get"),
						pulumi.String("List"),
					},
					SecretPermissions: pulumi.StringArray{
						pulumi.String("Get"),
						pulumi.String("List"),
					},
				},
				&keyvault.KeyVaultAccessPolicyArgs{
					TenantId: pulumi.String(current.TenantId),
					ObjectId: pulumi.Any(testAzurermWebPubsubService.Identity[0].PrincipalId),
					CertificatePermissions: pulumi.StringArray{
						pulumi.String("Create"),
						pulumi.String("Get"),
						pulumi.String("List"),
					},
					SecretPermissions: pulumi.StringArray{
						pulumi.String("Get"),
						pulumi.String("List"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
			Input: "certificate-to-import.pfx",
		}, nil)
		if err != nil {
			return err
		}
		exampleCertificate, err := keyvault.NewCertificate(ctx, "example", &keyvault.CertificateArgs{
			Name:       pulumi.String("imported-cert"),
			KeyVaultId: exampleKeyVault.ID(),
			Certificate: &keyvault.CertificateCertificateArgs{
				Contents: pulumi.String(invokeFilebase64.Result),
				Password: pulumi.String(""),
			},
		})
		if err != nil {
			return err
		}
		_, err = webpubsub.NewCustomCertificate(ctx, "test", &webpubsub.CustomCertificateArgs{
			Name:                pulumi.String("example-cert"),
			WebPubsubId:         exampleWebPubsubService.Id,
			CustomCertificateId: exampleCertificate.ID(),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAzurermKeyVaultAccessPolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Azurerm = Pulumi.Azurerm;
using Std = Pulumi.Std;

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

    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleWebPubsubService = new Azurerm.Index.WebPubsubService("example", new()
    {
        Name = "example-webpubsub",
        Location = testAzurermResourceGroup.Location,
        ResourceGroupName = testAzurermResourceGroup.Name,
        Sku = new[]
        {
            
            {
                { "name", "Premium_P1" },
                { "capacity", 1 },
            },
        },
        Identity = new[]
        {
            
            {
                { "type", "SystemAssigned" },
            },
        },
    });

    var exampleKeyVault = new Azure.KeyVault.KeyVault("example", new()
    {
        Name = "examplekeyvault",
        Location = example.Location,
        ResourceGroupName = example.Name,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        SkuName = "premium",
        AccessPolicies = new[]
        {
            new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
            {
                TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
                ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
                CertificatePermissions = new[]
                {
                    "Create",
                    "Get",
                    "List",
                },
                SecretPermissions = new[]
                {
                    "Get",
                    "List",
                },
            },
            new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
            {
                TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
                ObjectId = testAzurermWebPubsubService.Identity[0].PrincipalId,
                CertificatePermissions = new[]
                {
                    "Create",
                    "Get",
                    "List",
                },
                SecretPermissions = new[]
                {
                    "Get",
                    "List",
                },
            },
        },
    });

    var exampleCertificate = new Azure.KeyVault.Certificate("example", new()
    {
        Name = "imported-cert",
        KeyVaultId = exampleKeyVault.Id,
        KeyVaultCertificate = new Azure.KeyVault.Inputs.CertificateCertificateArgs
        {
            Contents = Std.Filebase64.Invoke(new()
            {
                Input = "certificate-to-import.pfx",
            }).Apply(invoke => invoke.Result),
            Password = "",
        },
    });

    var test = new Azure.WebPubSub.CustomCertificate("test", new()
    {
        Name = "example-cert",
        WebPubsubId = exampleWebPubsubService.Id,
        CustomCertificateId = exampleCertificate.Id,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAzurermKeyVaultAccessPolicy,
        },
    });

});
Copy
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.azurerm.webPubsubService;
import com.pulumi.azurerm.WebPubsubServiceArgs;
import com.pulumi.azure.keyvault.KeyVault;
import com.pulumi.azure.keyvault.KeyVaultArgs;
import com.pulumi.azure.keyvault.inputs.KeyVaultAccessPolicyArgs;
import com.pulumi.azure.keyvault.Certificate;
import com.pulumi.azure.keyvault.CertificateArgs;
import com.pulumi.azure.keyvault.inputs.CertificateCertificateArgs;
import com.pulumi.azure.webpubsub.CustomCertificate;
import com.pulumi.azure.webpubsub.CustomCertificateArgs;
import com.pulumi.resources.CustomResourceOptions;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleWebPubsubService = new WebPubsubService("exampleWebPubsubService", WebPubsubServiceArgs.builder()
            .name("example-webpubsub")
            .location(testAzurermResourceGroup.location())
            .resourceGroupName(testAzurermResourceGroup.name())
            .sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .identity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
            .name("examplekeyvault")
            .location(example.location())
            .resourceGroupName(example.name())
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .skuName("premium")
            .accessPolicies(            
                KeyVaultAccessPolicyArgs.builder()
                    .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                    .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
                    .certificatePermissions(                    
                        "Create",
                        "Get",
                        "List")
                    .secretPermissions(                    
                        "Get",
                        "List")
                    .build(),
                KeyVaultAccessPolicyArgs.builder()
                    .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                    .objectId(testAzurermWebPubsubService.identity()[0].principalId())
                    .certificatePermissions(                    
                        "Create",
                        "Get",
                        "List")
                    .secretPermissions(                    
                        "Get",
                        "List")
                    .build())
            .build());

        var exampleCertificate = new Certificate("exampleCertificate", CertificateArgs.builder()
            .name("imported-cert")
            .keyVaultId(exampleKeyVault.id())
            .certificate(CertificateCertificateArgs.builder()
                .contents(StdFunctions.filebase64(Filebase64Args.builder()
                    .input("certificate-to-import.pfx")
                    .build()).result())
                .password("")
                .build())
            .build());

        var test = new CustomCertificate("test", CustomCertificateArgs.builder()
            .name("example-cert")
            .webPubsubId(exampleWebPubsubService.id())
            .customCertificateId(exampleCertificate.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAzurermKeyVaultAccessPolicy)
                .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleWebPubsubService:
    type: azurerm:webPubsubService
    name: example
    properties:
      name: example-webpubsub
      location: ${testAzurermResourceGroup.location}
      resourceGroupName: ${testAzurermResourceGroup.name}
      sku:
        - name: Premium_P1
          capacity: 1
      identity:
        - type: SystemAssigned
  exampleKeyVault:
    type: azure:keyvault:KeyVault
    name: example
    properties:
      name: examplekeyvault
      location: ${example.location}
      resourceGroupName: ${example.name}
      tenantId: ${current.tenantId}
      skuName: premium
      accessPolicies:
        - tenantId: ${current.tenantId}
          objectId: ${current.objectId}
          certificatePermissions:
            - Create
            - Get
            - List
          secretPermissions:
            - Get
            - List
        - tenantId: ${current.tenantId}
          objectId: ${testAzurermWebPubsubService.identity[0].principalId}
          certificatePermissions:
            - Create
            - Get
            - List
          secretPermissions:
            - Get
            - List
  exampleCertificate:
    type: azure:keyvault:Certificate
    name: example
    properties:
      name: imported-cert
      keyVaultId: ${exampleKeyVault.id}
      certificate:
        contents:
          fn::invoke:
            function: std:filebase64
            arguments:
              input: certificate-to-import.pfx
            return: result
        password: ""
  test:
    type: azure:webpubsub:CustomCertificate
    properties:
      name: example-cert
      webPubsubId: ${exampleWebPubsubService.id}
      customCertificateId: ${exampleCertificate.id}
    options:
      dependsOn:
        - ${exampleAzurermKeyVaultAccessPolicy}
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
Copy

Create CustomCertificate Resource

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

Constructor syntax

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

@overload
def CustomCertificate(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      custom_certificate_id: Optional[str] = None,
                      web_pubsub_id: Optional[str] = None,
                      name: Optional[str] = None)
func NewCustomCertificate(ctx *Context, name string, args CustomCertificateArgs, opts ...ResourceOption) (*CustomCertificate, error)
public CustomCertificate(string name, CustomCertificateArgs args, CustomResourceOptions? opts = null)
public CustomCertificate(String name, CustomCertificateArgs args)
public CustomCertificate(String name, CustomCertificateArgs args, CustomResourceOptions options)

type: azure:webpubsub:CustomCertificate
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. CustomCertificateArgs
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. CustomCertificateArgs
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. CustomCertificateArgs
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. CustomCertificateArgs
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. CustomCertificateArgs
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 customCertificateResource = new Azure.WebPubSub.CustomCertificate("customCertificateResource", new()
{
    CustomCertificateId = "string",
    WebPubsubId = "string",
    Name = "string",
});
Copy
example, err := webpubsub.NewCustomCertificate(ctx, "customCertificateResource", &webpubsub.CustomCertificateArgs{
	CustomCertificateId: pulumi.String("string"),
	WebPubsubId:         pulumi.String("string"),
	Name:                pulumi.String("string"),
})
Copy
var customCertificateResource = new CustomCertificate("customCertificateResource", CustomCertificateArgs.builder()
    .customCertificateId("string")
    .webPubsubId("string")
    .name("string")
    .build());
Copy
custom_certificate_resource = azure.webpubsub.CustomCertificate("customCertificateResource",
    custom_certificate_id="string",
    web_pubsub_id="string",
    name="string")
Copy
const customCertificateResource = new azure.webpubsub.CustomCertificate("customCertificateResource", {
    customCertificateId: "string",
    webPubsubId: "string",
    name: "string",
});
Copy
type: azure:webpubsub:CustomCertificate
properties:
    customCertificateId: string
    name: string
    webPubsubId: string
Copy

CustomCertificate 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 CustomCertificate resource accepts the following input properties:

CustomCertificateId
This property is required.
Changes to this property will trigger replacement.
string

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

WebPubsubId
This property is required.
Changes to this property will trigger replacement.
string

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

Name Changes to this property will trigger replacement. string
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
CustomCertificateId
This property is required.
Changes to this property will trigger replacement.
string

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

WebPubsubId
This property is required.
Changes to this property will trigger replacement.
string

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

Name Changes to this property will trigger replacement. string
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
customCertificateId
This property is required.
Changes to this property will trigger replacement.
String

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

webPubsubId
This property is required.
Changes to this property will trigger replacement.
String

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

name Changes to this property will trigger replacement. String
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
customCertificateId
This property is required.
Changes to this property will trigger replacement.
string

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

webPubsubId
This property is required.
Changes to this property will trigger replacement.
string

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

name Changes to this property will trigger replacement. string
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
custom_certificate_id
This property is required.
Changes to this property will trigger replacement.
str

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

web_pubsub_id
This property is required.
Changes to this property will trigger replacement.
str

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

name Changes to this property will trigger replacement. str
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
customCertificateId
This property is required.
Changes to this property will trigger replacement.
String

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

webPubsubId
This property is required.
Changes to this property will trigger replacement.
String

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

name Changes to this property will trigger replacement. String
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Outputs

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

CertificateVersion string
The certificate version of the Web PubSub Custom Certificate.
Id string
The provider-assigned unique ID for this managed resource.
CertificateVersion string
The certificate version of the Web PubSub Custom Certificate.
Id string
The provider-assigned unique ID for this managed resource.
certificateVersion String
The certificate version of the Web PubSub Custom Certificate.
id String
The provider-assigned unique ID for this managed resource.
certificateVersion string
The certificate version of the Web PubSub Custom Certificate.
id string
The provider-assigned unique ID for this managed resource.
certificate_version str
The certificate version of the Web PubSub Custom Certificate.
id str
The provider-assigned unique ID for this managed resource.
certificateVersion String
The certificate version of the Web PubSub Custom Certificate.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing CustomCertificate Resource

Get an existing CustomCertificate 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?: CustomCertificateState, opts?: CustomResourceOptions): CustomCertificate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_version: Optional[str] = None,
        custom_certificate_id: Optional[str] = None,
        name: Optional[str] = None,
        web_pubsub_id: Optional[str] = None) -> CustomCertificate
func GetCustomCertificate(ctx *Context, name string, id IDInput, state *CustomCertificateState, opts ...ResourceOption) (*CustomCertificate, error)
public static CustomCertificate Get(string name, Input<string> id, CustomCertificateState? state, CustomResourceOptions? opts = null)
public static CustomCertificate get(String name, Output<String> id, CustomCertificateState state, CustomResourceOptions options)
resources:  _:    type: azure:webpubsub:CustomCertificate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CertificateVersion string
The certificate version of the Web PubSub Custom Certificate.
CustomCertificateId Changes to this property will trigger replacement. string

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

Name Changes to this property will trigger replacement. string
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
WebPubsubId Changes to this property will trigger replacement. string

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

CertificateVersion string
The certificate version of the Web PubSub Custom Certificate.
CustomCertificateId Changes to this property will trigger replacement. string

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

Name Changes to this property will trigger replacement. string
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
WebPubsubId Changes to this property will trigger replacement. string

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

certificateVersion String
The certificate version of the Web PubSub Custom Certificate.
customCertificateId Changes to this property will trigger replacement. String

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

name Changes to this property will trigger replacement. String
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
webPubsubId Changes to this property will trigger replacement. String

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

certificateVersion string
The certificate version of the Web PubSub Custom Certificate.
customCertificateId Changes to this property will trigger replacement. string

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

name Changes to this property will trigger replacement. string
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
webPubsubId Changes to this property will trigger replacement. string

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

certificate_version str
The certificate version of the Web PubSub Custom Certificate.
custom_certificate_id Changes to this property will trigger replacement. str

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

name Changes to this property will trigger replacement. str
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
web_pubsub_id Changes to this property will trigger replacement. str

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

certificateVersion String
The certificate version of the Web PubSub Custom Certificate.
customCertificateId Changes to this property will trigger replacement. String

The certificate ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: Self assigned certificate is not supported and the provisioning status will fail.

name Changes to this property will trigger replacement. String
The name of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.
webPubsubId Changes to this property will trigger replacement. String

The Web PubSub ID of the Web PubSub Custom Certificate. Changing this forces a new resource to be created.

Note: custom certificate is only available for Web PubSub Premium tier. Please enable managed identity in the corresponding Web PubSub Service and give the managed identity access to the key vault, the required permission is Get Certificate and Secret.

Import

Custom Certificate for a Web PubSub service can be imported using the resource id, e.g.

$ pulumi import azure:webpubsub/customCertificate:CustomCertificate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.SignalRService/webPubSub/WebPubsub1/customCertificates/cert1
Copy

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

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure