DomainProperties Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models

Assembly:: Az.EventGrid.private.dll

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.

Properties of the Event Grid Domain Resource.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.DomainPropertiesTypeConverter))]
public class DomainProperties : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IDomainProperties

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.DomainPropertiesTypeConverter))>]
type DomainProperties = class
    interface IDomainProperties
    interface IJsonSerializable

Public Class DomainProperties
Implements IDomainProperties

Inheritance: Object
DomainProperties

Attributes: TypeConverterAttribute

Implements: IDomainProperties IJsonSerializable

Constructors

DomainProperties()

Creates an new DomainProperties instance.

Properties

AutoCreateTopicWithFirstSubscription	This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.
AutoDeleteTopicWithLastSubscription	This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.
DataResidencyBoundary	Data Residency Boundary of the resource.
DisableLocalAuth	This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
Endpoint	Endpoint for the Event Grid Domain Resource which is used for publishing the events.
EventTypeInfoInlineEventType	A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
EventTypeInfoKind	The kind of event type used.
InboundIPRule	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
InputSchema	This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
InputSchemaMapping	Information about the InputSchemaMapping which specified the info about mapping event payload.
InputSchemaMappingInputSchemaMappingType	Type of the custom mapping
MetricResourceId	Metric resource id for the Event Grid Domain Resource.
MinimumTlsVersionAllowed	Minimum TLS version of the publisher allowed to publish to this domain
PrivateEndpointConnection
ProvisioningState	Provisioning state of the Event Grid Domain Resource.
PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of DomainProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of DomainProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IDomainProperties.
FromJsonString(String)	Creates a new instance of DomainProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of DomainProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()

Applies to

Share via