Share via


Domain Class

Definition

EventGrid Domain.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.DomainTypeConverter))]
public class Domain : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IDomain, Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.DomainTypeConverter))>]
type Domain = class
    interface IDomain
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class Domain
Implements IDomain, IValidates
Inheritance
Domain
Attributes
Implements

Constructors

Domain()

Creates an new Domain 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.

Id

Fully qualified identifier of the resource.

IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.

IdentityUserAssignedIdentity

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. This property is currently not used and reserved for future usage.

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

Location

Location of the resource.

MetricResourceId

Metric resource id for the Event Grid Domain Resource.

MinimumTlsVersionAllowed

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

Name

Name of the resource.

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

ResourceGroupName

Gets the resource group name

SkuName

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

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Tags of the resource.

Type

Type of the resource.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Domain.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Domain.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IDomain.

FromJsonString(String)

Creates a new instance of Domain, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Domain into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to