EventGridTopicData Class

Definition

A class representing the EventGridTopic data model. EventGrid Topic

public class EventGridTopicData : Azure.ResourceManager.Models.TrackedResourceData
public class EventGridTopicData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.EventGrid.EventGridTopicData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.EventGrid.EventGridTopicData>
type EventGridTopicData = class
    inherit TrackedResourceData
type EventGridTopicData = class
    inherit TrackedResourceData
    interface IJsonModel<EventGridTopicData>
    interface IPersistableModel<EventGridTopicData>
Public Class EventGridTopicData
Inherits TrackedResourceData
Public Class EventGridTopicData
Inherits TrackedResourceData
Implements IJsonModel(Of EventGridTopicData), IPersistableModel(Of EventGridTopicData)
Inheritance
Implements

Constructors

EventGridTopicData(AzureLocation)

Initializes a new instance of EventGridTopicData.

Properties

DataResidencyBoundary

Data Residency Boundary of the resource.

Endpoint

Endpoint for the topic.

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.

ExtendedLocation

Extended location of the resource.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Identity

Identity information for the resource.

InboundIPRules

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. Please note EventGridInputSchemaMapping is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include EventGridJsonInputSchemaMapping.

IsLocalAuthDisabled

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.

Kind

Kind of the resource.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
MetricResourceId

Metric resource id for the topic.

MinimumTlsVersionAllowed

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

Name

The name of the resource.

(Inherited from ResourceData)
PrivateEndpointConnections

List of private endpoint connections.

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 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SkuName

The Sku name of the resource. The possible values are: Basic or Premium.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<EventGridTopicData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<EventGridTopicData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<EventGridTopicData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<EventGridTopicData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<EventGridTopicData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to