TopicProperties Class

Properties of the Topic.

Constructor

TopicProperties(*args: Any, **kwargs: Any)

Variables

Name Description
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", "Disabled", and "SecuredByPerimeter".
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 Microsoft Entra ID 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".
encryption
KeyEncryption

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

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

Attributes

data_residency_boundary

"WithinGeopair" and "WithinRegion".

data_residency_boundary: str | _models.DataResidencyBoundary | None

disable_local_auth

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.

disable_local_auth: bool | None

encryption

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

encryption: _models.KeyEncryption | None

endpoint

Endpoint for the topic.

endpoint: str | None

event_type_info

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.

event_type_info: _models.EventTypeInfo | None

inbound_ip_rules

These are considered only if PublicNetworkAccess is enabled.

inbound_ip_rules: list['_models.InboundIpRule'] | None

input_schema

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: str | _models.InputSchema | None

input_schema_mapping

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.

input_schema_mapping: _models.InputSchemaMapping | None

metric_resource_id

Metric resource id for the topic.

metric_resource_id: str | None

minimum_tls_version_allowed

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

minimum_tls_version_allowed: str | _models.TlsVersion | None

platform_capabilities

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

platform_capabilities: _models.PlatformCapabilities | None

private_endpoint_connections

List of private endpoint connections.

private_endpoint_connections: list['_models.PrivateEndpointConnection'] | None

provisioning_state

"Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed".

provisioning_state: str | _models.TopicProvisioningState | None

public_network_access

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", "Disabled", and "SecuredByPerimeter".

public_network_access: str | _models.PublicNetworkAccess | None