Share via


CustomDomainConfiguration Class

Definition

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

public class CustomDomainConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.EventGrid.Models.CustomDomainConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.EventGrid.Models.CustomDomainConfiguration>
type CustomDomainConfiguration = class
    interface IJsonModel<CustomDomainConfiguration>
    interface IPersistableModel<CustomDomainConfiguration>
Public Class CustomDomainConfiguration
Implements IJsonModel(Of CustomDomainConfiguration), IPersistableModel(Of CustomDomainConfiguration)
Inheritance
CustomDomainConfiguration
Implements

Constructors

CustomDomainConfiguration(String)

Initializes a new instance of CustomDomainConfiguration.

Properties

CertificateUri

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.

Explicit Interface Implementations

IJsonModel<CustomDomainConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CustomDomainConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CustomDomainConfiguration>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CustomDomainConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CustomDomainConfiguration>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to