Share via

Topic Class

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

Constructor

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

Keyword-Only Parameters

Name Description
location
str

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

Tags of the resource.

Default value: None
identity
IdentityInfo

Identity information for the resource.

Default value: None
event_type_info
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.

Default value: None
minimum_tls_version_allowed
str or TlsVersion

Minimum TLS version of the publisher allowed to publish to this topic. Known values are: "1.0", "1.1", and "1.2".

Default value: None
input_schema
str or InputSchema

This determines the format that Event Grid should expect for incoming events published to the topic. Known values are: "EventGridSchema", "CustomEventSchema", and "CloudEventSchemaV1_0".

Default value: None
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.

Default value: None
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" />. Known values are: "Enabled" and "Disabled".

Default value: None
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.

Default value: None
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.

Default value: False
data_residency_boundary
str or DataResidencyBoundary

Data Residency Boundary of the resource. Known values are: "WithinGeopair" and "WithinRegion".

Default value: None

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

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

Tags of the resource.
identity
IdentityInfo

Identity information for the resource.
system_data
SystemData

The system metadata relating to the Event Grid resource.
private_endpoint_connections
list[PrivateEndpointConnection]

List of private endpoint connections.
provisioning_state
str or TopicProvisioningState

Provisioning state of the topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed".
endpoint
str

Endpoint for the topic.
event_type_info
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.
minimum_tls_version_allowed
str or TlsVersion

Minimum TLS version of the publisher allowed to publish to this topic. Known values are: "1.0", "1.1", and "1.2".
input_schema
str or InputSchema

This determines the format that Event Grid should expect for incoming events published to the topic. Known values are: "EventGridSchema", "CustomEventSchema", and "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" />. Known values are: "Enabled" and "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. Known values are: "WithinGeopair" and "WithinRegion".