Topic interface
EventGrid Topic
- Extends
Properties
data |
Data Residency Boundary of the resource. |
disable |
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. |
event |
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. |
extended |
Extended location of the resource. |
identity | Identity information for the resource. |
inbound |
This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. |
input |
This determines the format that Event Grid should expect for incoming events published to the topic. |
input |
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. |
metric |
Metric resource id for the topic. NOTE: This property will not be serialized. It can only be populated by the server. |
minimum |
Minimum TLS version of the publisher allowed to publish to this topic |
private |
List of private endpoint connections. NOTE: This property will not be serialized. It can only be populated by the server. |
provisioning |
Provisioning state of the topic. NOTE: This property will not be serialized. It can only be populated by the server. |
public |
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. |
system |
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
extendedLocation
Extended location of the resource.
extendedLocation?: ExtendedLocation
Property Value
identity
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
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
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
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
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
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
Azure SDK for JavaScript