Share via

Topic Class

  • Reference

EventGrid Topic.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.eventgrid.models._models_py3.TrackedResource
Topic

Constructor

Topic(*, location: str, tags: Dict[str, str] | None = None, identity: IdentityInfo | None = None, input_schema: str | InputSchema | None = None, input_schema_mapping: InputSchemaMapping | None = None, public_network_access: str | PublicNetworkAccess | None = None, inbound_ip_rules: List[InboundIpRule] | None = None, disable_local_auth: bool | None = False, data_residency_boundary: str | DataResidencyBoundary | None = None, **kwargs)

Keyword-Only Parameters

Name Description
location
str

Required. Location of the resource.
tags
dict[str, str]

A set of tags. Tags of the resource.
identity
IdentityInfo

Identity information for the resource.
input_schema
str or InputSchema

This determines the format that Event Grid should expect for incoming events published to the topic. Possible values include: "EventGridSchema", "CustomEventSchema", "CloudEventSchemaV1_0".
input_schema_mapping
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.
public_network_access
str or 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" />. Possible values include: "Enabled", "Disabled".
inbound_ip_rules
list[InboundIpRule]

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

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.
data_residency_boundary
str or DataResidencyBoundary

Data Residency Boundary of the resource. Possible values include: "WithinGeopair", "WithinRegion".

Variables

Name Description
id
str

Fully qualified identifier of the resource.
name
str

Name of the resource.
type
str

Type of the resource.
location
str

Required. Location of the resource.
tags
dict[str, str]

A set of tags. Tags of the resource.
identity
IdentityInfo

Identity information for the resource.
system_data
SystemData

The system metadata relating to Topic resource.
private_endpoint_connections
list[PrivateEndpointConnection]
provisioning_state
str or TopicProvisioningState

Provisioning state of the topic. Possible values include: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed".
endpoint
str

Endpoint for the topic.
input_schema
str or InputSchema

This determines the format that Event Grid should expect for incoming events published to the topic. Possible values include: "EventGridSchema", "CustomEventSchema", "CloudEventSchemaV1_0".
input_schema_mapping
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.
metric_resource_id
str

Metric resource id for the topic.
public_network_access
str or 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" />. Possible values include: "Enabled", "Disabled".
inbound_ip_rules
list[InboundIpRule]

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

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.
data_residency_boundary
str or DataResidencyBoundary

Data Residency Boundary of the resource. Possible values include: "WithinGeopair", "WithinRegion".