Share via


Microsoft.SignalRService webPubSub/customCertificates

Bicep resource definition

The webPubSub/customCertificates 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/webPubSub/customCertificates resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.SignalRService/webPubSub/customCertificates@2025-08-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    keyVaultBaseUri: 'string'
    keyVaultSecretName: 'string'
    keyVaultSecretVersion: 'string'
  }
}

Property Values

Microsoft.SignalRService/webPubSub/customCertificates

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: webPubSub
properties Custom certificate properties. CustomCertificateProperties (required)

CustomCertificateProperties

Name Description Value
keyVaultBaseUri Base uri of the KeyVault that stores certificate. string (required)
keyVaultSecretName Certificate secret name. string (required)
keyVaultSecretVersion Certificate secret version. string

ARM template resource definition

The webPubSub/customCertificates 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/webPubSub/customCertificates resource, add the following JSON to your template.

{
  "type": "Microsoft.SignalRService/webPubSub/customCertificates",
  "apiVersion": "2025-08-01-preview",
  "name": "string",
  "properties": {
    "keyVaultBaseUri": "string",
    "keyVaultSecretName": "string",
    "keyVaultSecretVersion": "string"
  }
}

Property Values

Microsoft.SignalRService/webPubSub/customCertificates

Name Description Value
apiVersion The api version '2025-08-01-preview'
name The resource name string (required)
properties Custom certificate properties. CustomCertificateProperties (required)
type The resource type 'Microsoft.SignalRService/webPubSub/customCertificates'

CustomCertificateProperties

Name Description Value
keyVaultBaseUri Base uri of the KeyVault that stores certificate. string (required)
keyVaultSecretName Certificate secret name. string (required)
keyVaultSecretVersion Certificate secret version. string

Usage Examples

Terraform (AzAPI provider) resource definition

The webPubSub/customCertificates resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/webPubSub/customCertificates@2025-08-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      keyVaultBaseUri = "string"
      keyVaultSecretName = "string"
      keyVaultSecretVersion = "string"
    }
  }
}

Property Values

Microsoft.SignalRService/webPubSub/customCertificates

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: webPubSub
properties Custom certificate properties. CustomCertificateProperties (required)
type The resource type "Microsoft.SignalRService/webPubSub/customCertificates@2025-08-01-preview"

CustomCertificateProperties

Name Description Value
keyVaultBaseUri Base uri of the KeyVault that stores certificate. string (required)
keyVaultSecretName Certificate secret name. string (required)
keyVaultSecretVersion Certificate secret version. string