CustomDomainConfiguration Class

Definition

Namespace:: Azure.Provisioning.EventGrid

Assembly:: Azure.Provisioning.EventGrid.dll

Package:: Azure.Provisioning.EventGrid v1.1.0

Package:: Azure.Provisioning.EventGrid v1.0.0-beta.1

Source:: CustomDomainConfiguration.cs

Source:: CustomDomainConfiguration.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class CustomDomainConfiguration : Azure.Provisioning.Primitives.ProvisionableConstruct

public class CustomDomainConfiguration : Azure.Provisioning.Primitives.ProvisioningConstruct

type CustomDomainConfiguration = class
    inherit ProvisionableConstruct

type CustomDomainConfiguration = class
    inherit ProvisioningConstruct

Public Class CustomDomainConfiguration
Inherits ProvisionableConstruct

Public Class CustomDomainConfiguration
Inherits ProvisioningConstruct

Inheritance: Object

Provisionable

ProvisionableConstruct
CustomDomainConfiguration

Inheritance: Azure.Provisioning.Primitives.ProvisioningConstruct
CustomDomainConfiguration

Constructors

Name	Description
CustomDomainConfiguration()	Creates a new CustomDomainConfiguration.

Properties

Name	Description
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.

Methods

Name	Description
AssignOrReplace<T>(T, T)	(Inherited from ProvisionableConstruct)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from ProvisionableConstruct)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String)	(Inherited from ProvisionableConstruct)
DefineProvisionableProperties()	Define all the provisionable properties of CustomDomainConfiguration.
GetProvisionableResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
Initialize()	Initialize this construct. (Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression)	(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)	Validate the presence of any required members. (Inherited from ProvisionableConstruct)

Explicit Interface Implementations

Name	Description
IBicepValue.Assign(IBicepValue)	Assign a value to this property. (Inherited from ProvisionableConstruct)
IBicepValue.Compile()	Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct)
IBicepValue.Expression	Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty	Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct)
IBicepValue.IsOutput	Tracks whether this is an output only property. (Inherited from ProvisionableConstruct)
IBicepValue.IsRequired	Tracks whether this property is required. (Inherited from ProvisionableConstruct)
IBicepValue.IsSecure	Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct)
IBicepValue.Kind	Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue	Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct)
IBicepValue.Self	Gets information about where this value was defined. (Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()	Make this value readonly. (Inherited from ProvisionableConstruct)
IBicepValue.Source	Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct)

Extension Methods

Name	Description
ToBicepExpression(IBicepValue)	Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to

Feedback

Was this page helpful?