Topic Class

Definition

EventGrid Topic

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.TopicTypeConverter))]
public class Topic : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ITopic, Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.TopicTypeConverter))>]
type Topic = class
    interface ITopic
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class Topic
Implements ITopic, IValidates
Inheritance
Topic
Attributes
Implements

Constructors

Topic()

Creates an new Topic 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.

ExtendedLocationName

Fully qualified name of the extended location.

ExtendedLocationType

Type of the extended location.

Id

Fully qualified identifier of the resource.

IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.

IdentityUserAssignedIdentity

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. This property is currently not used and reserved for future usage.

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

Kind

Kind of the resource.

Location

Location of the resource.

MetricResourceId

Metric resource id for the topic.

MinimumTlsVersionAllowed

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

Name

Name of the resource.

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

ResourceGroupName

Gets the resource group name

SkuName

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

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Tags of the resource.

Type

Type of the resource.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Topic.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Topic.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of Topic into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to