Share via

CustomDomainConfiguration Class

  • Reference

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

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.eventgrid._serialization.Model
CustomDomainConfiguration

Constructor

CustomDomainConfiguration(*, fully_qualified_domain_name: str, validation_state: str | _models.CustomDomainValidationState | None = None, identity: _models.CustomDomainIdentity | None = None, certificate_url: str | None = None, expected_txt_record_name: str | None = None, expected_txt_record_value: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
fully_qualified_domain_name
str

Fully Qualified Domain Name (FQDN) for the custom domain. Required.
validation_state
str or CustomDomainValidationState

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. Known values are: "Pending", "Approved", and "ErrorRetrievingDnsRecord".
identity
CustomDomainIdentity

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

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).
expected_txt_record_name
str

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.
expected_txt_record_value
str

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.

Variables

Name Description
fully_qualified_domain_name
str

Fully Qualified Domain Name (FQDN) for the custom domain. Required.
validation_state
str or CustomDomainValidationState

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. Known values are: "Pending", "Approved", and "ErrorRetrievingDnsRecord".
identity
CustomDomainIdentity

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

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).
expected_txt_record_name
str

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.
expected_txt_record_value
str

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.