EventGridDomainData Class

Definition

A class representing the EventGridDomain data model. EventGrid Domain.

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

Constructors

EventGridDomainData(AzureLocation)

Initializes a new instance of EventGridDomainData.

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.

Endpoint

Endpoint for the Event Grid Domain Resource which is used for publishing the events.

EventTypeInfo

Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Identity

Identity information for the Event Grid Domain resource.

InboundIPRules

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. Please note EventGridInputSchemaMapping is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include EventGridJsonInputSchemaMapping.

IsLocalAuthDisabled

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.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
MetricResourceId

Metric resource id for the Event Grid Domain Resource.

MinimumTlsVersionAllowed

Minimum TLS version of the publisher allowed to publish to this domain.

Name

The name of the resource.

(Inherited from ResourceData)
PrivateEndpointConnections

List of private endpoint connections.

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 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SkuName

The Sku name of the resource. The possible values are: Basic or Premium.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<EventGridDomainData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<EventGridDomainData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<EventGridDomainData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<EventGridDomainData>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<EventGridDomainData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to