Microsoft.Cdn profiles/secrets 2024-02-01

Bicep resource definition

The profiles/secrets resource type can be deployed with operations that target:

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

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
CDN Profile - Secret AVM Child Module for CDN Profile - Secret

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Front Door Standard/Premium with domain and certificate This template creates a Front Door Standard/Premium including a custom domain and customer-managed certificate.

Resource format

To create a Microsoft.Cdn/profiles/secrets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cdn/profiles/secrets@2024-02-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    parameters: {
      type: 'string'
      // For remaining properties, see SecretParameters objects
    }
  }
}

SecretParameters objects

Set the type property to specify the type of object.

For AzureFirstPartyManagedCertificate, use:

{
  subjectAlternativeNames: [
    'string'
  ]
  type: 'AzureFirstPartyManagedCertificate'
}

For CustomerCertificate, use:

{
  secretSource: {
    id: 'string'
  }
  secretVersion: 'string'
  subjectAlternativeNames: [
    'string'
  ]
  type: 'CustomerCertificate'
  useLatestVersion: bool
}

For ManagedCertificate, use:

{
  type: 'ManagedCertificate'
}

For UrlSigningKey, use:

{
  keyId: 'string'
  secretSource: {
    id: 'string'
  }
  secretVersion: 'string'
  type: 'UrlSigningKey'
}

Property Values

Microsoft.Cdn/profiles/secrets

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: profiles
properties The JSON object that contains the properties of the Secret to create. SecretProperties

AzureFirstPartyManagedCertificateParameters

Name Description Value
subjectAlternativeNames The list of SANs. string[]
type The type of the secret resource. 'AzureFirstPartyManagedCertificate' (required)

CustomerCertificateParameters

Name Description Value
secretSource Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ ResourceReference (required)
secretVersion Version of the secret to be used string
subjectAlternativeNames The list of SANs. string[]
type The type of the secret resource. 'CustomerCertificate' (required)
useLatestVersion Whether to use the latest version for the certificate bool

ManagedCertificateParameters

Name Description Value
type The type of the secret resource. 'ManagedCertificate' (required)

ResourceReference

Name Description Value
id Resource ID. string

SecretParameters

Name Description Value
type Set to 'AzureFirstPartyManagedCertificate' for type AzureFirstPartyManagedCertificateParameters. Set to 'CustomerCertificate' for type CustomerCertificateParameters. Set to 'ManagedCertificate' for type ManagedCertificateParameters. Set to 'UrlSigningKey' for type UrlSigningKeyParameters. 'AzureFirstPartyManagedCertificate'
'CustomerCertificate'
'ManagedCertificate'
'UrlSigningKey' (required)

SecretProperties

Name Description Value
parameters object which contains secret parameters SecretParameters

UrlSigningKeyParameters

Name Description Value
keyId Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. string (required)
secretSource Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ ResourceReference (required)
secretVersion Version of the secret to be used string
type The type of the secret resource. 'UrlSigningKey' (required)

ARM template resource definition

The profiles/secrets resource type can be deployed with operations that target:

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Front Door Standard/Premium with domain and certificate

Deploy to Azure
This template creates a Front Door Standard/Premium including a custom domain and customer-managed certificate.

Resource format

To create a Microsoft.Cdn/profiles/secrets resource, add the following JSON to your template.

{
  "type": "Microsoft.Cdn/profiles/secrets",
  "apiVersion": "2024-02-01",
  "name": "string",
  "properties": {
    "parameters": {
      "type": "string"
      // For remaining properties, see SecretParameters objects
    }
  }
}

SecretParameters objects

Set the type property to specify the type of object.

For AzureFirstPartyManagedCertificate, use:

{
  "subjectAlternativeNames": [ "string" ],
  "type": "AzureFirstPartyManagedCertificate"
}

For CustomerCertificate, use:

{
  "secretSource": {
    "id": "string"
  },
  "secretVersion": "string",
  "subjectAlternativeNames": [ "string" ],
  "type": "CustomerCertificate",
  "useLatestVersion": "bool"
}

For ManagedCertificate, use:

{
  "type": "ManagedCertificate"
}

For UrlSigningKey, use:

{
  "keyId": "string",
  "secretSource": {
    "id": "string"
  },
  "secretVersion": "string",
  "type": "UrlSigningKey"
}

Property Values

Microsoft.Cdn/profiles/secrets

Name Description Value
apiVersion The api version '2024-02-01'
name The resource name string (required)
properties The JSON object that contains the properties of the Secret to create. SecretProperties
type The resource type 'Microsoft.Cdn/profiles/secrets'

AzureFirstPartyManagedCertificateParameters

Name Description Value
subjectAlternativeNames The list of SANs. string[]
type The type of the secret resource. 'AzureFirstPartyManagedCertificate' (required)

CustomerCertificateParameters

Name Description Value
secretSource Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ ResourceReference (required)
secretVersion Version of the secret to be used string
subjectAlternativeNames The list of SANs. string[]
type The type of the secret resource. 'CustomerCertificate' (required)
useLatestVersion Whether to use the latest version for the certificate bool

ManagedCertificateParameters

Name Description Value
type The type of the secret resource. 'ManagedCertificate' (required)

ResourceReference

Name Description Value
id Resource ID. string

SecretParameters

Name Description Value
type Set to 'AzureFirstPartyManagedCertificate' for type AzureFirstPartyManagedCertificateParameters. Set to 'CustomerCertificate' for type CustomerCertificateParameters. Set to 'ManagedCertificate' for type ManagedCertificateParameters. Set to 'UrlSigningKey' for type UrlSigningKeyParameters. 'AzureFirstPartyManagedCertificate'
'CustomerCertificate'
'ManagedCertificate'
'UrlSigningKey' (required)

SecretProperties

Name Description Value
parameters object which contains secret parameters SecretParameters

UrlSigningKeyParameters

Name Description Value
keyId Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. string (required)
secretSource Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ ResourceReference (required)
secretVersion Version of the secret to be used string
type The type of the secret resource. 'UrlSigningKey' (required)

Terraform (AzAPI provider) resource definition

The profiles/secrets 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.Cdn/profiles/secrets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cdn/profiles/secrets@2024-02-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      parameters = {
        type = "string"
        // For remaining properties, see SecretParameters objects
      }
    }
  }
}

SecretParameters objects

Set the type property to specify the type of object.

For AzureFirstPartyManagedCertificate, use:

{
  subjectAlternativeNames = [
    "string"
  ]
  type = "AzureFirstPartyManagedCertificate"
}

For CustomerCertificate, use:

{
  secretSource = {
    id = "string"
  }
  secretVersion = "string"
  subjectAlternativeNames = [
    "string"
  ]
  type = "CustomerCertificate"
  useLatestVersion = bool
}

For ManagedCertificate, use:

{
  type = "ManagedCertificate"
}

For UrlSigningKey, use:

{
  keyId = "string"
  secretSource = {
    id = "string"
  }
  secretVersion = "string"
  type = "UrlSigningKey"
}

Property Values

Microsoft.Cdn/profiles/secrets

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: profiles
properties The JSON object that contains the properties of the Secret to create. SecretProperties
type The resource type "Microsoft.Cdn/profiles/secrets@2024-02-01"

AzureFirstPartyManagedCertificateParameters

Name Description Value
subjectAlternativeNames The list of SANs. string[]
type The type of the secret resource. 'AzureFirstPartyManagedCertificate' (required)

CustomerCertificateParameters

Name Description Value
secretSource Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ ResourceReference (required)
secretVersion Version of the secret to be used string
subjectAlternativeNames The list of SANs. string[]
type The type of the secret resource. 'CustomerCertificate' (required)
useLatestVersion Whether to use the latest version for the certificate bool

ManagedCertificateParameters

Name Description Value
type The type of the secret resource. 'ManagedCertificate' (required)

ResourceReference

Name Description Value
id Resource ID. string

SecretParameters

Name Description Value
type Set to 'AzureFirstPartyManagedCertificate' for type AzureFirstPartyManagedCertificateParameters. Set to 'CustomerCertificate' for type CustomerCertificateParameters. Set to 'ManagedCertificate' for type ManagedCertificateParameters. Set to 'UrlSigningKey' for type UrlSigningKeyParameters. 'AzureFirstPartyManagedCertificate'
'CustomerCertificate'
'ManagedCertificate'
'UrlSigningKey' (required)

SecretProperties

Name Description Value
parameters object which contains secret parameters SecretParameters

UrlSigningKeyParameters

Name Description Value
keyId Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. string (required)
secretSource Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ ResourceReference (required)
secretVersion Version of the secret to be used string
type The type of the secret resource. 'UrlSigningKey' (required)