1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. getPartnerTopic
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.eventgrid.getPartnerTopic

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

    Get properties of a partner topic. Azure REST API version: 2022-06-15.

    Other available API versions: 2023-06-01-preview, 2023-12-15-preview.

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:eventgrid:getPartnerTopic
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PartnerTopicName string
    Name of the partner topic.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    PartnerTopicName string
    Name of the partner topic.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    partnerTopicName String
    Name of the partner topic.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    partnerTopicName string
    Name of the partner topic.
    resourceGroupName string
    The name of the resource group within the user's subscription.
    partner_topic_name str
    Name of the partner topic.
    resource_group_name str
    The name of the resource group within the user's subscription.
    partnerTopicName String
    Name of the partner topic.
    resourceGroupName String
    The name of the resource group within the user's subscription.

    getPartnerTopic Result

    The following output properties are available:

    Id string
    Fully qualified identifier of the resource.
    Location string
    Location of the resource.
    Name string
    Name of the resource.
    ProvisioningState string
    Provisioning state of the partner topic.
    SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse
    The system metadata relating to Partner Topic resource.
    Type string
    Type of the resource.
    ActivationState string
    Activation state of the partner topic.
    EventTypeInfo Pulumi.AzureNative.EventGrid.Outputs.EventTypeInfoResponse
    Event Type information from the corresponding event channel.
    ExpirationTimeIfNotActivatedUtc string
    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.AzureNative.EventGrid.Outputs.IdentityInfoResponse
    Identity information for the Partner Topic resource.
    MessageForActivation string
    Context or helpful message that can be used during the approval process by the subscriber.
    PartnerRegistrationImmutableId string
    The immutableId of the corresponding partner registration.
    PartnerTopicFriendlyDescription string
    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.
    Tags Dictionary<string, string>
    Tags of the resource.
    Id string
    Fully qualified identifier of the resource.
    Location string
    Location of the resource.
    Name string
    Name of the resource.
    ProvisioningState string
    Provisioning state of the partner topic.
    SystemData SystemDataResponse
    The system metadata relating to Partner Topic resource.
    Type string
    Type of the resource.
    ActivationState string
    Activation state of the partner topic.
    EventTypeInfo EventTypeInfoResponse
    Event Type information from the corresponding event channel.
    ExpirationTimeIfNotActivatedUtc string
    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 IdentityInfoResponse
    Identity information for the Partner Topic resource.
    MessageForActivation string
    Context or helpful message that can be used during the approval process by the subscriber.
    PartnerRegistrationImmutableId string
    The immutableId of the corresponding partner registration.
    PartnerTopicFriendlyDescription string
    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.
    Tags map[string]string
    Tags of the resource.
    id String
    Fully qualified identifier of the resource.
    location String
    Location of the resource.
    name String
    Name of the resource.
    provisioningState String
    Provisioning state of the partner topic.
    systemData SystemDataResponse
    The system metadata relating to Partner Topic resource.
    type String
    Type of the resource.
    activationState String
    Activation state of the partner topic.
    eventTypeInfo EventTypeInfoResponse
    Event Type information from the corresponding event channel.
    expirationTimeIfNotActivatedUtc String
    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 IdentityInfoResponse
    Identity information for the Partner Topic resource.
    messageForActivation String
    Context or helpful message that can be used during the approval process by the subscriber.
    partnerRegistrationImmutableId String
    The immutableId of the corresponding partner registration.
    partnerTopicFriendlyDescription String
    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.
    tags Map<String,String>
    Tags of the resource.
    id string
    Fully qualified identifier of the resource.
    location string
    Location of the resource.
    name string
    Name of the resource.
    provisioningState string
    Provisioning state of the partner topic.
    systemData SystemDataResponse
    The system metadata relating to Partner Topic resource.
    type string
    Type of the resource.
    activationState string
    Activation state of the partner topic.
    eventTypeInfo EventTypeInfoResponse
    Event Type information from the corresponding event channel.
    expirationTimeIfNotActivatedUtc string
    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 IdentityInfoResponse
    Identity information for the Partner Topic resource.
    messageForActivation string
    Context or helpful message that can be used during the approval process by the subscriber.
    partnerRegistrationImmutableId string
    The immutableId of the corresponding partner registration.
    partnerTopicFriendlyDescription string
    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.
    tags {[key: string]: string}
    Tags 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 SystemDataResponse
    The system metadata relating to Partner Topic resource.
    type str
    Type of the resource.
    activation_state str
    Activation state of the partner topic.
    event_type_info EventTypeInfoResponse
    Event Type information from the corresponding event channel.
    expiration_time_if_not_activated_utc str
    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 IdentityInfoResponse
    Identity information for the Partner Topic resource.
    message_for_activation str
    Context or helpful message that can be used during the approval process by the subscriber.
    partner_registration_immutable_id str
    The immutableId of the corresponding partner registration.
    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.
    source str
    Source associated with this partner topic. This represents a unique partner resource.
    tags Mapping[str, str]
    Tags of the resource.
    id String
    Fully qualified identifier of the resource.
    location String
    Location of the resource.
    name String
    Name of the resource.
    provisioningState String
    Provisioning state of the partner topic.
    systemData Property Map
    The system metadata relating to Partner Topic resource.
    type String
    Type of the resource.
    activationState String
    Activation state of the partner topic.
    eventTypeInfo Property Map
    Event Type information from the corresponding event channel.
    expirationTimeIfNotActivatedUtc String
    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.
    messageForActivation String
    Context or helpful message that can be used during the approval process by the subscriber.
    partnerRegistrationImmutableId String
    The immutableId of the corresponding partner registration.
    partnerTopicFriendlyDescription String
    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.
    tags Map<String>
    Tags of the resource.

    Supporting Types

    EventTypeInfoResponse

    InlineEventTypes Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.InlineEventPropertiesResponse>
    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.
    InlineEventTypes map[string]InlineEventPropertiesResponse
    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.
    inlineEventTypes Map<String,InlineEventPropertiesResponse>
    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.
    inlineEventTypes {[key: string]: InlineEventPropertiesResponse}
    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_types Mapping[str, InlineEventPropertiesResponse]
    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.
    inlineEventTypes Map<Property Map>
    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

    PrincipalId string
    The principal ID of resource identity.
    TenantId 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.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.UserIdentityPropertiesResponse>
    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.
    PrincipalId string
    The principal ID of resource identity.
    TenantId 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.
    UserAssignedIdentities map[string]UserIdentityPropertiesResponse
    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.
    principalId String
    The principal ID of resource identity.
    tenantId 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.
    userAssignedIdentities Map<String,UserIdentityPropertiesResponse>
    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.
    principalId string
    The principal ID of resource identity.
    tenantId 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.
    userAssignedIdentities {[key: string]: UserIdentityPropertiesResponse}
    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_identities Mapping[str, UserIdentityPropertiesResponse]
    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.
    principalId String
    The principal ID of resource identity.
    tenantId 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.
    userAssignedIdentities Map<Property Map>
    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

    DataSchemaUrl string
    The dataSchemaUrl for the inline event.
    Description string
    The description for the inline event.
    DisplayName string
    The displayName for the inline event.
    DocumentationUrl string
    The documentationUrl for the inline event.
    DataSchemaUrl string
    The dataSchemaUrl for the inline event.
    Description string
    The description for the inline event.
    DisplayName string
    The displayName for the inline event.
    DocumentationUrl string
    The documentationUrl for the inline event.
    dataSchemaUrl String
    The dataSchemaUrl for the inline event.
    description String
    The description for the inline event.
    displayName String
    The displayName for the inline event.
    documentationUrl String
    The documentationUrl for the inline event.
    dataSchemaUrl string
    The dataSchemaUrl for the inline event.
    description string
    The description for the inline event.
    displayName string
    The displayName for the inline event.
    documentationUrl string
    The documentationUrl for the inline event.
    data_schema_url str
    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.
    dataSchemaUrl String
    The dataSchemaUrl for the inline event.
    description String
    The description for the inline event.
    displayName String
    The displayName for the inline event.
    documentationUrl String
    The documentationUrl for the inline event.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UserIdentityPropertiesResponse

    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.
    clientId string
    The client id of user assigned identity.
    principalId 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.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi