Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. webpubsub
  5. WebPubSubCustomDomain
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.webpubsub.WebPubSubCustomDomain

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

A custom domain

Uses Azure REST API version 2024-03-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native webpubsub [ApiVersion]. See the version guide for details.

Example Usage

WebPubSubCustomDomains_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var webPubSubCustomDomain = new AzureNative.WebPubSub.WebPubSubCustomDomain("webPubSubCustomDomain", new()
    {
        CustomCertificate = new AzureNative.WebPubSub.Inputs.ResourceReferenceArgs
        {
            Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert",
        },
        DomainName = "example.com",
        Name = "myDomain",
        ResourceGroupName = "myResourceGroup",
        ResourceName = "myWebPubSubService",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := webpubsub.NewWebPubSubCustomDomain(ctx, "webPubSubCustomDomain", &webpubsub.WebPubSubCustomDomainArgs{
			CustomCertificate: &webpubsub.ResourceReferenceArgs{
				Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert"),
			},
			DomainName:        pulumi.String("example.com"),
			Name:              pulumi.String("myDomain"),
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ResourceName:      pulumi.String("myWebPubSubService"),
		})
		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.WebPubSubCustomDomain;
import com.pulumi.azurenative.webpubsub.WebPubSubCustomDomainArgs;
import com.pulumi.azurenative.webpubsub.inputs.ResourceReferenceArgs;
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 webPubSubCustomDomain = new WebPubSubCustomDomain("webPubSubCustomDomain", WebPubSubCustomDomainArgs.builder()
            .customCertificate(ResourceReferenceArgs.builder()
                .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert")
                .build())
            .domainName("example.com")
            .name("myDomain")
            .resourceGroupName("myResourceGroup")
            .resourceName("myWebPubSubService")
            .build());

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

const webPubSubCustomDomain = new azure_native.webpubsub.WebPubSubCustomDomain("webPubSubCustomDomain", {
    customCertificate: {
        id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert",
    },
    domainName: "example.com",
    name: "myDomain",
    resourceGroupName: "myResourceGroup",
    resourceName: "myWebPubSubService",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

web_pub_sub_custom_domain = azure_native.webpubsub.WebPubSubCustomDomain("webPubSubCustomDomain",
    custom_certificate={
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert",
    },
    domain_name="example.com",
    name="myDomain",
    resource_group_name="myResourceGroup",
    resource_name_="myWebPubSubService")
Copy
resources:
  webPubSubCustomDomain:
    type: azure-native:webpubsub:WebPubSubCustomDomain
    properties:
      customCertificate:
        id: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert
      domainName: example.com
      name: myDomain
      resourceGroupName: myResourceGroup
      resourceName: myWebPubSubService
Copy

Create WebPubSubCustomDomain Resource

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

Constructor syntax

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

@overload
def WebPubSubCustomDomain(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          custom_certificate: Optional[ResourceReferenceArgs] = None,
                          domain_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          resource_name_: Optional[str] = None,
                          name: Optional[str] = None)
func NewWebPubSubCustomDomain(ctx *Context, name string, args WebPubSubCustomDomainArgs, opts ...ResourceOption) (*WebPubSubCustomDomain, error)
public WebPubSubCustomDomain(string name, WebPubSubCustomDomainArgs args, CustomResourceOptions? opts = null)
public WebPubSubCustomDomain(String name, WebPubSubCustomDomainArgs args)
public WebPubSubCustomDomain(String name, WebPubSubCustomDomainArgs args, CustomResourceOptions options)

type: azure-native:webpubsub:WebPubSubCustomDomain
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. WebPubSubCustomDomainArgs
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. WebPubSubCustomDomainArgs
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. WebPubSubCustomDomainArgs
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. WebPubSubCustomDomainArgs
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. WebPubSubCustomDomainArgs
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 webPubSubCustomDomainResource = new AzureNative.WebPubSub.WebPubSubCustomDomain("webPubSubCustomDomainResource", new()
{
    CustomCertificate = new AzureNative.WebPubSub.Inputs.ResourceReferenceArgs
    {
        Id = "string",
    },
    DomainName = "string",
    ResourceGroupName = "string",
    ResourceName = "string",
    Name = "string",
});
Copy
example, err := webpubsub.NewWebPubSubCustomDomain(ctx, "webPubSubCustomDomainResource", &webpubsub.WebPubSubCustomDomainArgs{
	CustomCertificate: &webpubsub.ResourceReferenceArgs{
		Id: pulumi.String("string"),
	},
	DomainName:        pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ResourceName:      pulumi.String("string"),
	Name:              pulumi.String("string"),
})
Copy
var webPubSubCustomDomainResource = new WebPubSubCustomDomain("webPubSubCustomDomainResource", WebPubSubCustomDomainArgs.builder()
    .customCertificate(ResourceReferenceArgs.builder()
        .id("string")
        .build())
    .domainName("string")
    .resourceGroupName("string")
    .resourceName("string")
    .name("string")
    .build());
Copy
web_pub_sub_custom_domain_resource = azure_native.webpubsub.WebPubSubCustomDomain("webPubSubCustomDomainResource",
    custom_certificate={
        "id": "string",
    },
    domain_name="string",
    resource_group_name="string",
    resource_name_="string",
    name="string")
Copy
const webPubSubCustomDomainResource = new azure_native.webpubsub.WebPubSubCustomDomain("webPubSubCustomDomainResource", {
    customCertificate: {
        id: "string",
    },
    domainName: "string",
    resourceGroupName: "string",
    resourceName: "string",
    name: "string",
});
Copy
type: azure-native:webpubsub:WebPubSubCustomDomain
properties:
    customCertificate:
        id: string
    domainName: string
    name: string
    resourceGroupName: string
    resourceName: string
Copy

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

CustomCertificate This property is required. Pulumi.AzureNative.WebPubSub.Inputs.ResourceReference
Reference to a resource.
DomainName This property is required. string
The custom domain name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
Name Changes to this property will trigger replacement. string
Custom domain name.
CustomCertificate This property is required. ResourceReferenceArgs
Reference to a resource.
DomainName This property is required. string
The custom domain name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
Name Changes to this property will trigger replacement. string
Custom domain name.
customCertificate This property is required. ResourceReference
Reference to a resource.
domainName This property is required. String
The custom domain name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
name Changes to this property will trigger replacement. String
Custom domain name.
customCertificate This property is required. ResourceReference
Reference to a resource.
domainName This property is required. string
The custom domain name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
name Changes to this property will trigger replacement. string
Custom domain name.
custom_certificate This property is required. ResourceReferenceArgs
Reference to a resource.
domain_name This property is required. str
The custom domain name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource.
name Changes to this property will trigger replacement. str
Custom domain name.
customCertificate This property is required. Property Map
Reference to a resource.
domainName This property is required. String
The custom domain name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
name Changes to this property will trigger replacement. String
Custom domain name.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
Provisioning state of the resource.
SystemData Pulumi.AzureNative.WebPubSub.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
Provisioning state of the resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
Provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
provisioningState string
Provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
provisioning_state str
Provisioning state of the resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
Provisioning state of the resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ResourceReference
, ResourceReferenceArgs

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

ResourceReferenceResponse
, ResourceReferenceResponseArgs

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

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:WebPubSubCustomDomain myDomain /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native