Share via


TopicProperties Class

Definition

Properties of the Topic.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.TopicPropertiesTypeConverter))]
public class TopicProperties : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ITopicProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.TopicPropertiesTypeConverter))>]
type TopicProperties = class
    interface ITopicProperties
    interface IJsonSerializable
Public Class TopicProperties
Implements ITopicProperties
Inheritance
TopicProperties
Attributes
Implements

Constructors

TopicProperties()

Creates an new TopicProperties instance.

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.

EventTypeInfoInlineEventType

A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.

EventTypeInfoKind

The kind of event type used.

InboundIPRule

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.

InputSchemaMappingInputSchemaMappingType

Type of the custom mapping

MetricResourceId

Metric resource id for the topic.

MinimumTlsVersionAllowed

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

PrivateEndpointConnection
ProvisioningState

Provisioning state of the topic.

PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of TopicProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of TopicProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ITopicProperties.

FromJsonString(String)

Creates a new instance of TopicProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of TopicProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to