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 AAD token will be used to authenticate if user is allowed to publish to the topic.
endpoint	Endpoint for the topic. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
minimumTlsVersionAllowed	Minimum TLS version of the publisher allowed to publish to this topic
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 topic. 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
sku	The Sku pricing tier for the topic.
systemData	The system metadata relating to Topic 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

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 topic.

disableLocalAuth?: boolean

Property Value

boolean

endpoint

Endpoint for the topic. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

metricResourceId?: string

Property Value

string

minimumTlsVersionAllowed

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

minimumTlsVersionAllowed?: 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 topic. 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

sku

The Sku pricing tier for the topic.

sku?: ResourceSku

Property Value

ResourceSku

systemData

The system metadata relating to Topic 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