PartnerTopic interface

Package:

@azure/arm-eventgrid

Event Grid Partner Topic.

Extends

TrackedResource

Properties

activationState	Activation state of the partner topic.
eventTypeInfo	Event Type information from the corresponding event channel.
expirationTimeIfNotActivatedUtc	Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted.
identity	Identity information for the Partner Topic resource.
messageForActivation	Context or helpful message that can be used during the approval process by the subscriber.
partnerRegistrationImmutableId	The immutableId of the corresponding partner registration.
partnerTopicFriendlyDescription	Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
provisioningState	Provisioning state of the partner topic. NOTE: This property will not be serialized. It can only be populated by the server.
source	Source associated with this partner topic. This represents a unique partner resource.
systemData	The system metadata relating to Partner Topic resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
location	Location of the resource.
name	Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Tags of the resource.
type	Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

activationState

Activation state of the partner topic.

activationState?: string

Property Value

string

eventTypeInfo

Event Type information from the corresponding event channel.

eventTypeInfo?: EventTypeInfo

Property Value

EventTypeInfo

expirationTimeIfNotActivatedUtc

Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted.

expirationTimeIfNotActivatedUtc?: Date

Property Value

Date

identity

Identity information for the Partner Topic resource.

identity?: IdentityInfo

Property Value

IdentityInfo

messageForActivation

Context or helpful message that can be used during the approval process by the subscriber.

messageForActivation?: string

Property Value

string

partnerRegistrationImmutableId

The immutableId of the corresponding partner registration.

partnerRegistrationImmutableId?: string

Property Value

string

partnerTopicFriendlyDescription

Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.

partnerTopicFriendlyDescription?: string

Property Value

string

provisioningState

Provisioning state of the partner topic. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

source

Source associated with this partner topic. This represents a unique partner resource.

source?: string

Property Value

string

systemData

The system metadata relating to Partner Topic resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited Property Details

id

Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Location of the resource.

location: string

Property Value

string

Inherited From TrackedResource.location

name

Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Tags of the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type