Share via

Microsoft.EventGrid partnerTopics

  • Article
  • 12/09/2024
Choose a deployment language

Bicep resource definition

The partnerTopics resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/partnerTopics resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventGrid/partnerTopics@2025-02-15' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    activationState: 'string'
    eventTypeInfo: {
      inlineEventTypes: {
        {customized property}: {
          dataSchemaUrl: 'string'
          description: 'string'
          displayName: 'string'
          documentationUrl: 'string'
        }
      }
      kind: 'string'
    }
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerRegistrationImmutableId: 'string'
    partnerTopicFriendlyDescription: 'string'
    source: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

EventTypeInfo

Name Description Value
inlineEventTypes 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.		 EventTypeInfoInlineEventTypes
kind The kind of event type used. 'Inline'

EventTypeInfoInlineEventTypes

Name Description Value

IdentityInfo

Name Description Value
principalId The principal ID of resource identity. string
tenantId The tenant ID of resource. string
type 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. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities 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.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Name Description Value

InlineEventProperties

Name Description Value
dataSchemaUrl The dataSchemaUrl for the inline event. string
description The description for the inline event. string
displayName The displayName for the inline event. string
documentationUrl The documentationUrl for the inline event. string

Microsoft.EventGrid/partnerTopics

Name Description Value
identity Identity information for the Partner Topic resource. IdentityInfo
location Location of the resource. string (required)
name The resource name string (required)
properties Properties of the Partner Topic. PartnerTopicProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

PartnerTopicProperties

Name Description Value
activationState Activation state of the partner topic. 'Activated'
'Deactivated'
'NeverActivated'
eventTypeInfo Event Type information from the corresponding event channel. 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.		 string
messageForActivation Context or helpful message that can be used during the approval process by the subscriber. string
partnerRegistrationImmutableId The immutableId of the corresponding partner registration. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
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.		 string
source Source associated with this partner topic. This represents a unique partner resource. string

TrackedResourceTags

Name Description Value

UserIdentityProperties

Name Description Value
clientId The client id of user assigned identity. string
principalId The principal id of user assigned identity. string

ARM template resource definition

The partnerTopics resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/partnerTopics resource, add the following JSON to your template.

{
  "type": "Microsoft.EventGrid/partnerTopics",
  "apiVersion": "2025-02-15",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "activationState": "string",
    "eventTypeInfo": {
      "inlineEventTypes": {
        "{customized property}": {
          "dataSchemaUrl": "string",
          "description": "string",
          "displayName": "string",
          "documentationUrl": "string"
        }
      },
      "kind": "string"
    },
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerRegistrationImmutableId": "string",
    "partnerTopicFriendlyDescription": "string",
    "source": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

EventTypeInfo

Name Description Value
inlineEventTypes 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.		 EventTypeInfoInlineEventTypes
kind The kind of event type used. 'Inline'

EventTypeInfoInlineEventTypes

Name Description Value

IdentityInfo

Name Description Value
principalId The principal ID of resource identity. string
tenantId The tenant ID of resource. string
type 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. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities 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.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Name Description Value

InlineEventProperties

Name Description Value
dataSchemaUrl The dataSchemaUrl for the inline event. string
description The description for the inline event. string
displayName The displayName for the inline event. string
documentationUrl The documentationUrl for the inline event. string

Microsoft.EventGrid/partnerTopics

Name Description Value
apiVersion The api version '2025-02-15'
identity Identity information for the Partner Topic resource. IdentityInfo
location Location of the resource. string (required)
name The resource name string (required)
properties Properties of the Partner Topic. PartnerTopicProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.EventGrid/partnerTopics'

PartnerTopicProperties

Name Description Value
activationState Activation state of the partner topic. 'Activated'
'Deactivated'
'NeverActivated'
eventTypeInfo Event Type information from the corresponding event channel. 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.		 string
messageForActivation Context or helpful message that can be used during the approval process by the subscriber. string
partnerRegistrationImmutableId The immutableId of the corresponding partner registration. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
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.		 string
source Source associated with this partner topic. This represents a unique partner resource. string

TrackedResourceTags

Name Description Value

UserIdentityProperties

Name Description Value
clientId The client id of user assigned identity. string
principalId The principal id of user assigned identity. string

Usage Examples

Terraform (AzAPI provider) resource definition

The partnerTopics resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/partnerTopics resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerTopics@2025-02-15"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      activationState = "string"
      eventTypeInfo = {
        inlineEventTypes = {
          {customized property} = {
            dataSchemaUrl = "string"
            description = "string"
            displayName = "string"
            documentationUrl = "string"
          }
        }
        kind = "string"
      }
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerRegistrationImmutableId = "string"
      partnerTopicFriendlyDescription = "string"
      source = "string"
    }
  }
}

Property Values

EventTypeInfo

Name Description Value
inlineEventTypes 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.		 EventTypeInfoInlineEventTypes
kind The kind of event type used. 'Inline'

EventTypeInfoInlineEventTypes

Name Description Value

IdentityInfo

Name Description Value
principalId The principal ID of resource identity. string
tenantId The tenant ID of resource. string
type 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. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities 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.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Name Description Value

InlineEventProperties

Name Description Value
dataSchemaUrl The dataSchemaUrl for the inline event. string
description The description for the inline event. string
displayName The displayName for the inline event. string
documentationUrl The documentationUrl for the inline event. string

Microsoft.EventGrid/partnerTopics

Name Description Value
identity Identity information for the Partner Topic resource. IdentityInfo
location Location of the resource. string (required)
name The resource name string (required)
properties Properties of the Partner Topic. PartnerTopicProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.EventGrid/partnerTopics@2025-02-15"

PartnerTopicProperties

Name Description Value
activationState Activation state of the partner topic. 'Activated'
'Deactivated'
'NeverActivated'
eventTypeInfo Event Type information from the corresponding event channel. 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.		 string
messageForActivation Context or helpful message that can be used during the approval process by the subscriber. string
partnerRegistrationImmutableId The immutableId of the corresponding partner registration. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
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.		 string
source Source associated with this partner topic. This represents a unique partner resource. string

TrackedResourceTags

Name Description Value

UserIdentityProperties

Name Description Value
clientId The client id of user assigned identity. string
principalId The principal id of user assigned identity. string