azure-native.eventgrid.getPartnerTopic
Explore with Pulumi AI
Get properties of a partner topic.
Uses Azure REST API version 2025-02-15.
Other available API versions: 2022-06-15, 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview, 2024-12-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native eventgrid [ApiVersion]
. See the version guide for details.
Using getPartnerTopic
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPartnerTopic(args: GetPartnerTopicArgs, opts?: InvokeOptions): Promise<GetPartnerTopicResult>
function getPartnerTopicOutput(args: GetPartnerTopicOutputArgs, opts?: InvokeOptions): Output<GetPartnerTopicResult>
def get_partner_topic(partner_topic_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPartnerTopicResult
def get_partner_topic_output(partner_topic_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPartnerTopicResult]
func LookupPartnerTopic(ctx *Context, args *LookupPartnerTopicArgs, opts ...InvokeOption) (*LookupPartnerTopicResult, error)
func LookupPartnerTopicOutput(ctx *Context, args *LookupPartnerTopicOutputArgs, opts ...InvokeOption) LookupPartnerTopicResultOutput
> Note: This function is named LookupPartnerTopic
in the Go SDK.
public static class GetPartnerTopic
{
public static Task<GetPartnerTopicResult> InvokeAsync(GetPartnerTopicArgs args, InvokeOptions? opts = null)
public static Output<GetPartnerTopicResult> Invoke(GetPartnerTopicInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPartnerTopicResult> getPartnerTopic(GetPartnerTopicArgs args, InvokeOptions options)
public static Output<GetPartnerTopicResult> getPartnerTopic(GetPartnerTopicArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:eventgrid:getPartnerTopic
arguments:
# arguments dictionary
The following arguments are supported:
- Partner
Topic stringName - Name of the partner topic.
- Resource
Group stringName - The name of the resource group within the user's subscription.
- Partner
Topic stringName - Name of the partner topic.
- Resource
Group stringName - The name of the resource group within the user's subscription.
- partner
Topic StringName - Name of the partner topic.
- resource
Group StringName - The name of the resource group within the user's subscription.
- partner
Topic stringName - Name of the partner topic.
- resource
Group stringName - The name of the resource group within the user's subscription.
- partner_
topic_ strname - Name of the partner topic.
- resource_
group_ strname - The name of the resource group within the user's subscription.
- partner
Topic StringName - Name of the partner topic.
- resource
Group StringName - The name of the resource group within the user's subscription.
getPartnerTopic Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified identifier of the resource.
- Location string
- Location of the resource.
- Name string
- Name of the resource.
- Provisioning
State string - Provisioning state of the partner topic.
- System
Data Pulumi.Azure Native. Event Grid. Outputs. System Data Response - The system metadata relating to the Event Grid resource.
- Type string
- Type of the resource.
- Activation
State string - Activation state of the partner topic.
- Event
Type Pulumi.Info Azure Native. Event Grid. Outputs. Event Type Info Response - Event Type information from the corresponding event channel.
- Expiration
Time stringIf Not Activated Utc - 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
Pulumi.
Azure Native. Event Grid. Outputs. Identity Info Response - Identity information for the Partner Topic resource.
- Message
For stringActivation - Context or helpful message that can be used during the approval process by the subscriber.
- Partner
Registration stringImmutable Id - The immutableId of the corresponding partner registration.
- Partner
Topic stringFriendly Description - 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.
- Source string
- Source associated with this partner topic. This represents a unique partner resource.
- Dictionary<string, string>
- Tags of the resource.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified identifier of the resource.
- Location string
- Location of the resource.
- Name string
- Name of the resource.
- Provisioning
State string - Provisioning state of the partner topic.
- System
Data SystemData Response - The system metadata relating to the Event Grid resource.
- Type string
- Type of the resource.
- Activation
State string - Activation state of the partner topic.
- Event
Type EventInfo Type Info Response - Event Type information from the corresponding event channel.
- Expiration
Time stringIf Not Activated Utc - 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
Info Response - Identity information for the Partner Topic resource.
- Message
For stringActivation - Context or helpful message that can be used during the approval process by the subscriber.
- Partner
Registration stringImmutable Id - The immutableId of the corresponding partner registration.
- Partner
Topic stringFriendly Description - 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.
- Source string
- Source associated with this partner topic. This represents a unique partner resource.
- map[string]string
- Tags of the resource.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified identifier of the resource.
- location String
- Location of the resource.
- name String
- Name of the resource.
- provisioning
State String - Provisioning state of the partner topic.
- system
Data SystemData Response - The system metadata relating to the Event Grid resource.
- type String
- Type of the resource.
- activation
State String - Activation state of the partner topic.
- event
Type EventInfo Type Info Response - Event Type information from the corresponding event channel.
- expiration
Time StringIf Not Activated Utc - 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
Info Response - Identity information for the Partner Topic resource.
- message
For StringActivation - Context or helpful message that can be used during the approval process by the subscriber.
- partner
Registration StringImmutable Id - The immutableId of the corresponding partner registration.
- partner
Topic StringFriendly Description - 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.
- source String
- Source associated with this partner topic. This represents a unique partner resource.
- Map<String,String>
- Tags of the resource.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified identifier of the resource.
- location string
- Location of the resource.
- name string
- Name of the resource.
- provisioning
State string - Provisioning state of the partner topic.
- system
Data SystemData Response - The system metadata relating to the Event Grid resource.
- type string
- Type of the resource.
- activation
State string - Activation state of the partner topic.
- event
Type EventInfo Type Info Response - Event Type information from the corresponding event channel.
- expiration
Time stringIf Not Activated Utc - 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
Info Response - Identity information for the Partner Topic resource.
- message
For stringActivation - Context or helpful message that can be used during the approval process by the subscriber.
- partner
Registration stringImmutable Id - The immutableId of the corresponding partner registration.
- partner
Topic stringFriendly Description - 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.
- source string
- Source associated with this partner topic. This represents a unique partner resource.
- {[key: string]: string}
- Tags of the resource.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified identifier of the resource.
- location str
- Location of the resource.
- name str
- Name of the resource.
- provisioning_
state str - Provisioning state of the partner topic.
- system_
data SystemData Response - The system metadata relating to the Event Grid resource.
- type str
- Type of the resource.
- activation_
state str - Activation state of the partner topic.
- event_
type_ Eventinfo Type Info Response - Event Type information from the corresponding event channel.
- expiration_
time_ strif_ not_ activated_ utc - 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
Info Response - Identity information for the Partner Topic resource.
- message_
for_ stractivation - Context or helpful message that can be used during the approval process by the subscriber.
- partner_
registration_ strimmutable_ id - The immutableId of the corresponding partner registration.
- partner_
topic_ strfriendly_ description - 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.
- source str
- Source associated with this partner topic. This represents a unique partner resource.
- Mapping[str, str]
- Tags of the resource.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified identifier of the resource.
- location String
- Location of the resource.
- name String
- Name of the resource.
- provisioning
State String - Provisioning state of the partner topic.
- system
Data Property Map - The system metadata relating to the Event Grid resource.
- type String
- Type of the resource.
- activation
State String - Activation state of the partner topic.
- event
Type Property MapInfo - Event Type information from the corresponding event channel.
- expiration
Time StringIf Not Activated Utc - 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 Property Map
- Identity information for the Partner Topic resource.
- message
For StringActivation - Context or helpful message that can be used during the approval process by the subscriber.
- partner
Registration StringImmutable Id - The immutableId of the corresponding partner registration.
- partner
Topic StringFriendly Description - 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.
- source String
- Source associated with this partner topic. This represents a unique partner resource.
- Map<String>
- Tags of the resource.
Supporting Types
EventTypeInfoResponse
- Inline
Event Dictionary<string, Pulumi.Types Azure Native. Event Grid. Inputs. Inline Event Properties Response> - 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.
- Kind string
- The kind of event type used.
- Inline
Event map[string]InlineTypes Event Properties Response - 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.
- Kind string
- The kind of event type used.
- inline
Event Map<String,InlineTypes Event Properties Response> - 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.
- kind String
- The kind of event type used.
- inline
Event {[key: string]: InlineTypes Event Properties Response} - 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.
- kind string
- The kind of event type used.
- inline_
event_ Mapping[str, Inlinetypes Event Properties Response] - 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.
- kind str
- The kind of event type used.
- inline
Event Map<Property Map>Types - 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.
- kind String
- The kind of event type used.
IdentityInfoResponse
- Principal
Id string - The principal ID of resource identity.
- Tenant
Id string - The tenant ID of resource.
- Type string
- 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.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Event Grid. Inputs. User Identity Properties Response> - 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.
- Principal
Id string - The principal ID of resource identity.
- Tenant
Id string - The tenant ID of resource.
- Type string
- 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.
- User
Assigned map[string]UserIdentities Identity Properties Response - 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.
- principal
Id String - The principal ID of resource identity.
- tenant
Id String - The tenant ID of resource.
- type String
- 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.
- user
Assigned Map<String,UserIdentities Identity Properties Response> - 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.
- principal
Id string - The principal ID of resource identity.
- tenant
Id string - The tenant ID of resource.
- type string
- 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.
- user
Assigned {[key: string]: UserIdentities Identity Properties Response} - 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.
- principal_
id str - The principal ID of resource identity.
- tenant_
id str - The tenant ID of resource.
- type str
- 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.
- user_
assigned_ Mapping[str, Useridentities Identity Properties Response] - 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.
- principal
Id String - The principal ID of resource identity.
- tenant
Id String - The tenant ID of resource.
- type String
- 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.
- user
Assigned Map<Property Map>Identities - 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.
InlineEventPropertiesResponse
- Data
Schema stringUrl - The dataSchemaUrl for the inline event.
- Description string
- The description for the inline event.
- Display
Name string - The displayName for the inline event.
- Documentation
Url string - The documentationUrl for the inline event.
- Data
Schema stringUrl - The dataSchemaUrl for the inline event.
- Description string
- The description for the inline event.
- Display
Name string - The displayName for the inline event.
- Documentation
Url string - The documentationUrl for the inline event.
- data
Schema StringUrl - The dataSchemaUrl for the inline event.
- description String
- The description for the inline event.
- display
Name String - The displayName for the inline event.
- documentation
Url String - The documentationUrl for the inline event.
- data
Schema stringUrl - The dataSchemaUrl for the inline event.
- description string
- The description for the inline event.
- display
Name string - The displayName for the inline event.
- documentation
Url string - The documentationUrl for the inline event.
- data_
schema_ strurl - The dataSchemaUrl for the inline event.
- description str
- The description for the inline event.
- display_
name str - The displayName for the inline event.
- documentation_
url str - The documentationUrl for the inline event.
- data
Schema StringUrl - The dataSchemaUrl for the inline event.
- description String
- The description for the inline event.
- display
Name String - The displayName for the inline event.
- documentation
Url String - The documentationUrl for the inline event.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserIdentityPropertiesResponse
- Client
Id string - The client id of user assigned identity.
- Principal
Id string - The principal id of user assigned identity.
- Client
Id string - The client id of user assigned identity.
- Principal
Id string - The principal id of user assigned identity.
- client
Id String - The client id of user assigned identity.
- principal
Id String - The principal id of user assigned identity.
- client
Id string - The client id of user assigned identity.
- principal
Id string - The principal id of user assigned identity.
- client_
id str - The client id of user assigned identity.
- principal_
id str - The principal id of user assigned identity.
- client
Id String - The client id of user assigned identity.
- principal
Id String - The principal id of user assigned identity.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0