Share via

Microsoft.SignalRService signalR/customDomains

Bicep resource definition

The signalR/customDomains resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SignalRService/signalR/customDomains resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.SignalRService/signalR/customDomains@2025-01-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    customCertificate: {
      id: 'string'
    }
    domainName: 'string'
  }
}

Property Values

Microsoft.SignalRService/signalR/customDomains

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: signalR
properties Properties of a custom domain. CustomDomainProperties (required)

CustomDomainProperties

Name Description Value
customCertificate Reference to a resource. ResourceReference (required)
domainName The custom domain name. string (required)

ResourceReference

Name Description Value
id Resource ID. string

ARM template resource definition

The signalR/customDomains resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SignalRService/signalR/customDomains resource, add the following JSON to your template.

{
  "type": "Microsoft.SignalRService/signalR/customDomains",
  "apiVersion": "2025-01-01-preview",
  "name": "string",
  "properties": {
    "customCertificate": {
      "id": "string"
    },
    "domainName": "string"
  }
}

Property Values

Microsoft.SignalRService/signalR/customDomains

Name Description Value
apiVersion The api version '2025-01-01-preview'
name The resource name string (required)
properties Properties of a custom domain. CustomDomainProperties (required)
type The resource type 'Microsoft.SignalRService/signalR/customDomains'

CustomDomainProperties

Name Description Value
customCertificate Reference to a resource. ResourceReference (required)
domainName The custom domain name. string (required)

ResourceReference

Name Description Value
id Resource ID. string

Usage Examples

Terraform (AzAPI provider) resource definition

The signalR/customDomains resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SignalRService/signalR/customDomains resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR/customDomains@2025-01-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      customCertificate = {
        id = "string"
      }
      domainName = "string"
    }
  }
}

Property Values

Microsoft.SignalRService/signalR/customDomains

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: signalR
properties Properties of a custom domain. CustomDomainProperties (required)
type The resource type "Microsoft.SignalRService/signalR/customDomains@2025-01-01-preview"

CustomDomainProperties

Name Description Value
customCertificate Reference to a resource. ResourceReference (required)
domainName The custom domain name. string (required)

ResourceReference

Name Description Value
id Resource ID. string
  • Last updated on