Share via

PartnerTopic Class

Event Grid Partner Topic.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

PartnerTopic(*, ___location: str, tags: Dict[str, str] | None = None, identity: _models.IdentityInfo | None = None, partner_registration_immutable_id: str | None = None, source: str | None = None, event_type_info: _models.EventTypeInfo | None = None, expiration_time_if_not_activated_utc: datetime | None = None, activation_state: str | _models.PartnerTopicActivationState | None = None, partner_topic_friendly_description: str | None = None, message_for_activation: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
___location
str

Location of the resource. Required.
tags
dict[str, str]

Tags of the resource.

Default value: None
identity
IdentityInfo

Identity information for the Partner Topic resource.

Default value: None
partner_registration_immutable_id
str

The immutableId of the corresponding partner registration.

Default value: None
source
str

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

Default value: None
event_type_info
EventTypeInfo

Event Type information from the corresponding event channel.

Default value: None
expiration_time_if_not_activated_utc
datetime

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.

Default value: None
activation_state
str or PartnerTopicActivationState

Activation state of the partner topic. Known values are: "NeverActivated", "Activated", and "Deactivated".

Default value: None
partner_topic_friendly_description
str

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.

Default value: None
message_for_activation
str

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

Default value: None

Variables

Name Description
id
str

Fully qualified identifier of the resource.
name
str

Name of the resource.
type
str

Type of the resource.
___location
str

Location of the resource. Required.
tags
dict[str, str]

Tags of the resource.
system_data
SystemData

The system metadata relating to Partner Topic resource.
identity
IdentityInfo

Identity information for the Partner Topic resource.
partner_registration_immutable_id
str

The immutableId of the corresponding partner registration.
source
str

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

Event Type information from the corresponding event channel.
expiration_time_if_not_activated_utc
datetime

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.
provisioning_state
str or PartnerTopicProvisioningState

Provisioning state of the partner topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "IdleDueToMirroredChannelResourceDeletion".
activation_state
str or PartnerTopicActivationState

Activation state of the partner topic. Known values are: "NeverActivated", "Activated", and "Deactivated".
partner_topic_friendly_description
str

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.
message_for_activation
str

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