CustomDomainConfiguration Class
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.
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
|
Fully Qualified Domain Name (FQDN) for the custom ___domain. Required. |
|
validation_state
|
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". Default value: None
|
|
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. Default value: None
|
|
certificate_url
|
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). Default value: None
|
|
expected_txt_record_name
|
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. Default value: None
|
|
expected_txt_record_value
|
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. Default value: None
|
Variables
| Name | Description |
|---|---|
|
fully_qualified_domain_name
|
Fully Qualified Domain Name (FQDN) for the custom ___domain. Required. |
|
validation_state
|
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
|
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
|
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
|
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
|
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. |
