Docs Home Pulumi IaC Pulumi ESC 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.webpubsub.WebPubSubCustomDomain

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    A custom domain Azure REST API version: 2023-02-01.

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

    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",
    });

});

    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.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
	})
}

    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());

    }
}

    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",
});

    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")

    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

    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 string
    The unique name of the resource.
    args WebPubSubCustomDomainArgs
    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 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 string
    The unique name of the resource.
    args WebPubSubCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebPubSubCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    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"),
})

    var webPubSubCustomDomainResource = new WebPubSubCustomDomain("webPubSubCustomDomainResource", WebPubSubCustomDomainArgs.builder()
    .customCertificate(ResourceReferenceArgs.builder()
        .id("string")
        .build())
    .domainName("string")
    .resourceGroupName("string")
    .resourceName("string")
    .name("string")
    .build());

    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")

    const webPubSubCustomDomainResource = new azure_native.webpubsub.WebPubSubCustomDomain("webPubSubCustomDomainResource", {
    customCertificate: {
        id: "string",
    },
    domainName: "string",
    resourceGroupName: "string",
    resourceName: "string",
    name: "string",
});

    type: azure-native:webpubsub:WebPubSubCustomDomain
properties:
    customCertificate:
        id: string
    domainName: string
    name: string
    resourceGroupName: string
    resourceName: string

    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 Pulumi.AzureNative.WebPubSub.Inputs.ResourceReference
    Reference to a resource.
    DomainName string
    The custom domain name.
    ResourceGroupName 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 string
    The name of the resource.
    Name string
    Custom domain name.
    CustomCertificate ResourceReferenceArgs
    Reference to a resource.
    DomainName string
    The custom domain name.
    ResourceGroupName 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 string
    The name of the resource.
    Name string
    Custom domain name.
    customCertificate ResourceReference
    Reference to a resource.
    domainName String
    The custom domain name.
    resourceGroupName 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 String
    The name of the resource.
    name String
    Custom domain name.
    customCertificate ResourceReference
    Reference to a resource.
    domainName string
    The custom domain name.
    resourceGroupName 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 string
    The name of the resource.
    name string
    Custom domain name.
    custom_certificate ResourceReferenceArgs
    Reference to a resource.
    domain_name str
    The custom domain name.
    resource_group_name 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 str
    The name of the resource.
    name str
    Custom domain name.
    customCertificate Property Map
    Reference to a resource.
    domainName String
    The custom domain name.
    resourceGroupName 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 String
    The name of the resource.
    name String
    Custom domain name.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    Provisioning state of the 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.
    ProvisioningState string
    Provisioning state of the 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.
    provisioningState String
    Provisioning state of the 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.
    provisioningState string
    Provisioning state of the 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.
    provisioning_state str
    Provisioning state of the 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.
    provisioningState String
    Provisioning state of the 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

    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}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native