Topic interface

Package:

@azure/arm-eventgrid

EventGrid Topic

Extends

TrackedResource

Properties

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 Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the topic.
encryption	Key encryption configuration properties of the topic resource. This is an optional property. When not specified, no key encryption is used.
endpoint	Endpoint for the topic.
eventTypeInfo	Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
extendedLocation	Extended location of the resource.
identity	Identity information for the 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 topic.
inputSchemaMapping	This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
kind	Kind of the resource.
metricResourceId	Metric resource id for the topic.
minimumTlsVersionAllowed	Minimum TLS version of the publisher allowed to publish to this topic
platformCapabilities	Represents the platform capabilities of the resource, including Azure Confidential Compute related properties.
privateEndpointConnections	List of private endpoint connections.
provisioningState	Provisioning state of the topic.
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.TopicProperties.InboundIpRules" />
sku	The Sku pricing tier for the topic.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

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 Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the topic.

disableLocalAuth?: boolean

Property Value

boolean

encryption

Key encryption configuration properties of the topic resource. This is an optional property. When not specified, no key encryption is used.

encryption?: KeyEncryption

Property Value

KeyEncryption

endpoint

Endpoint for the topic.

endpoint?: string

Property Value

string

eventTypeInfo

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

eventTypeInfo?: EventTypeInfo

Property Value

EventTypeInfo

extendedLocation

Extended location of the resource.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

identity

Identity information for the 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 topic.

inputSchema?: string

Property Value

string

inputSchemaMapping

This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.

inputSchemaMapping?: InputSchemaMappingUnion

Property Value

InputSchemaMappingUnion

kind

Kind of the resource.

kind?: string

Property Value

string

metricResourceId

Metric resource id for the topic.

metricResourceId?: string

Property Value

string

minimumTlsVersionAllowed

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

minimumTlsVersionAllowed?: string

Property Value

string

platformCapabilities

Represents the platform capabilities of the resource, including Azure Confidential Compute related properties.

platformCapabilities?: PlatformCapabilities

Property Value

PlatformCapabilities

privateEndpointConnections

List of private endpoint connections.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Provisioning state of the topic.

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

publicNetworkAccess?: string

Property Value

string

sku

The Sku pricing tier for the topic.

sku?: ResourceSku

Property Value

ResourceSku

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

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

type?: string

Property Value

string

Inherited From TrackedResource.type