Domain interface

Package:

@azure/arm-eventgrid

EventGrid Domain.

Extends

TrackedResource

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. NOTE: This property will not be serialized. It can only be populated by the server.
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.
metricResourceId	Metric resource id for the Event Grid Domain Resource. NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections	List of private endpoint connections. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning state of the Event Grid Domain Resource. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
systemData	The system metadata relating to the Event Grid Domain resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
location	Location of the resource.
name	Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Tags of the resource.
type	Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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.

autoCreateTopicWithFirstSubscription?: boolean

Property Value

boolean

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.

autoDeleteTopicWithLastSubscription?: boolean

Property Value

boolean

dataResidencyBoundary

Data Residency Boundary of the resource.

dataResidencyBoundary?: string

Property Value

string

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.

disableLocalAuth?: boolean

Property Value

boolean

endpoint

Endpoint for the Event Grid Domain Resource which is used for publishing the events. NOTE: This property will not be serialized. It can only be populated by the server.

endpoint?: string

Property Value

string

identity

Identity information for the Event Grid Domain resource.

identity?: IdentityInfo

Property Value

IdentityInfo

inboundIpRules

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

inboundIpRules?: InboundIpRule[]

Property Value

InboundIpRule[]

inputSchema

This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.

inputSchema?: string

Property Value

string

inputSchemaMapping

Information about the InputSchemaMapping which specified the info about mapping event payload.

inputSchemaMapping?: InputSchemaMappingUnion

Property Value

InputSchemaMappingUnion

metricResourceId

Metric resource id for the Event Grid Domain Resource. NOTE: This property will not be serialized. It can only be populated by the server.

metricResourceId?: string

Property Value

string

privateEndpointConnections

List of private endpoint connections. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Provisioning state of the Event Grid Domain Resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

publicNetworkAccess?: string

Property Value

string

systemData

The system metadata relating to the Event Grid Domain resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited Property Details

id

Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Location of the resource.

location: string

Property Value

string

Inherited From TrackedResource.location

name

Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Tags of the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type