Share via

CustomDomainConfiguration interface

  • Reference
Package:
@azure/arm-eventgrid

A custom domain configuration that allows users to publish to their own domain name.

Properties

certificateUrl

The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert)
expectedTxtRecordName

Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value.
expectedTxtRecordValue

Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain.
fullyQualifiedDomainName

Fully Qualified Domain Name (FQDN) for the custom domain.
identity

Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace.
validationState

Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated.

Property Details

certificateUrl

The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert)

certificateUrl?: string

Property Value

string

expectedTxtRecordName

Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value.

expectedTxtRecordName?: string

Property Value

string

expectedTxtRecordValue

Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain.

expectedTxtRecordValue?: string

Property Value

string

fullyQualifiedDomainName

Fully Qualified Domain Name (FQDN) for the custom domain.

fullyQualifiedDomainName: string

Property Value

string

identity

Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace.

identity?: CustomDomainIdentity

Property Value

CustomDomainIdentity

validationState

Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated.

validationState?: string

Property Value

string