Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. signalrservice
  5. SignalRCustomDomain
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.signalrservice.SignalRCustomDomain

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 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

A custom domain

Uses Azure REST API version 2023-02-01. In version 1.x of the Azure Native provider, it used API version 2022-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

SignalRCustomDomains_CreateOrUpdate

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

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

});
Copy
package main

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

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

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

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

signal_r_custom_domain = azure_native.signalrservice.SignalRCustomDomain("signalRCustomDomain",
    custom_certificate={
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert",
    },
    domain_name="example.com",
    name="myDomain",
    resource_group_name="myResourceGroup",
    resource_name_="mySignalRService")
Copy
resources:
  signalRCustomDomain:
    type: azure-native:signalrservice:SignalRCustomDomain
    properties:
      customCertificate:
        id: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert
      domainName: example.com
      name: myDomain
      resourceGroupName: myResourceGroup
      resourceName: mySignalRService
Copy

Create SignalRCustomDomain Resource

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

Constructor syntax

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

@overload
def SignalRCustomDomain(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 NewSignalRCustomDomain(ctx *Context, name string, args SignalRCustomDomainArgs, opts ...ResourceOption) (*SignalRCustomDomain, error)
public SignalRCustomDomain(string name, SignalRCustomDomainArgs args, CustomResourceOptions? opts = null)
public SignalRCustomDomain(String name, SignalRCustomDomainArgs args)
public SignalRCustomDomain(String name, SignalRCustomDomainArgs args, CustomResourceOptions options)

type: azure-native:signalrservice:SignalRCustomDomain
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. SignalRCustomDomainArgs
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. SignalRCustomDomainArgs
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. SignalRCustomDomainArgs
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. SignalRCustomDomainArgs
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. SignalRCustomDomainArgs
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 signalRCustomDomainResource = new AzureNative.SignalRService.SignalRCustomDomain("signalRCustomDomainResource", new()
{
    CustomCertificate = new AzureNative.SignalRService.Inputs.ResourceReferenceArgs
    {
        Id = "string",
    },
    DomainName = "string",
    ResourceGroupName = "string",
    ResourceName = "string",
    Name = "string",
});
Copy
example, err := signalrservice.NewSignalRCustomDomain(ctx, "signalRCustomDomainResource", &signalrservice.SignalRCustomDomainArgs{
	CustomCertificate: &signalrservice.ResourceReferenceArgs{
		Id: pulumi.String("string"),
	},
	DomainName:        pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ResourceName:      pulumi.String("string"),
	Name:              pulumi.String("string"),
})
Copy
var signalRCustomDomainResource = new SignalRCustomDomain("signalRCustomDomainResource", SignalRCustomDomainArgs.builder()
    .customCertificate(ResourceReferenceArgs.builder()
        .id("string")
        .build())
    .domainName("string")
    .resourceGroupName("string")
    .resourceName("string")
    .name("string")
    .build());
Copy
signal_r_custom_domain_resource = azure_native.signalrservice.SignalRCustomDomain("signalRCustomDomainResource",
    custom_certificate={
        "id": "string",
    },
    domain_name="string",
    resource_group_name="string",
    resource_name_="string",
    name="string")
Copy
const signalRCustomDomainResource = new azure_native.signalrservice.SignalRCustomDomain("signalRCustomDomainResource", {
    customCertificate: {
        id: "string",
    },
    domainName: "string",
    resourceGroupName: "string",
    resourceName: "string",
    name: "string",
});
Copy
type: azure-native:signalrservice:SignalRCustomDomain
properties:
    customCertificate:
        id: string
    domainName: string
    name: string
    resourceGroupName: string
    resourceName: string
Copy

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

CustomCertificate This property is required. Pulumi.AzureNative.SignalRService.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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource.
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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
name Changes to this property will trigger replacement. String
Custom domain name.

Outputs

All input properties are implicitly available as output properties. Additionally, the SignalRCustomDomain 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.SignalRService.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:signalrservice:SignalRCustomDomain myDomain /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{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 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native