Share via


Domain Class

Definition

EventGrid Domain.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Domain : Microsoft.Azure.Management.EventGrid.Models.TrackedResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Domain = class
    inherit TrackedResource
Public Class Domain
Inherits TrackedResource
Inheritance
Attributes

Constructors

Domain()

Initializes a new instance of the Domain class.

Domain(String, String, String, String, IDictionary<String,String>, IList<PrivateEndpointConnection>, String, String, String, InputSchemaMapping, String, String, IList<InboundIpRule>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, SystemData, IdentityInfo)

Initializes a new instance of the Domain class.

Properties

AutoCreateTopicWithFirstSubscription

Gets or sets 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

Gets or sets 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

Gets or sets data Residency Boundary of the resource. Possible values include: 'WithinGeopair', 'WithinRegion'

DisableLocalAuth

Gets or sets 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

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

Id

Gets fully qualified identifier of the resource.

(Inherited from Resource)
Identity

Gets or sets identity information for the Event Grid Domain resource.

InboundIpRules

Gets or sets this can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

InputSchema

Gets or sets this determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Possible values include: 'EventGridSchema', 'CustomEventSchema', 'CloudEventSchemaV1_0'

InputSchemaMapping

Gets or sets information about the InputSchemaMapping which specified the info about mapping event payload.

Location

Gets or sets location of the resource.

(Inherited from TrackedResource)
MetricResourceId

Gets metric resource id for the Event Grid Domain Resource.

Name

Gets name of the resource.

(Inherited from Resource)
PrivateEndpointConnections

Gets list of private endpoint connections.

ProvisioningState

Gets provisioning state of the Event Grid Domain Resource. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Canceled', 'Failed'

PublicNetworkAccess

Gets or sets this determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring &lt;seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /&gt;. Possible values include: 'Enabled', 'Disabled'

SystemData

Gets the system metadata relating to the Event Grid Domain resource.

Tags

Gets or sets tags of the resource.

(Inherited from TrackedResource)
Type

Gets type of the resource.

(Inherited from Resource)

Methods

Validate()

Validate the object.

Applies to