Microsoft.EventGrid partnerTopics

Artigo
01/15/2024

Definição de recurso do Bicep

O tipo de recurso partnerTopics pode ser implementado com operações que visam:

Grupos de recursos – veja comandos de implementação de grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/partnerTopics, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

partnerTopics

Nome	Descrição	Valor
name	O nome do recurso	cadeia (obrigatório)
localização	Localização do recurso.	cadeia (obrigatório)
etiquetas	Etiquetas do recurso.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade	Informações de identidade para o recurso Tópico de Parceiro.	IdentityInfo
propriedades	Propriedades do Tópico de Parceiro.	PartnerTopicProperties

IdentityInfo

Nome	Descrição	Valor
principalId	O ID principal da identidade de recurso.	string
tenantId	O ID do inquilino do recurso.	string
tipo	O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.	"Nenhum" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned"
userAssignedIdentities	A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Esta propriedade não é atualmente utilizada e reservada para utilização futura.	IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		UserIdentityProperties

UserIdentityProperties

Nome	Descrição	Valor
clientId	O ID de cliente da identidade atribuída pelo utilizador.	string
principalId	O ID principal da identidade atribuída pelo utilizador.	string

PartnerTopicProperties

Nome	Descrição	Valor
activationState	Estado de ativação do tópico de parceiro.	"Ativado" "Desativado" "Nunca Ativado"
eventTypeInfo	Informações do Tipo de Evento do canal de eventos correspondente.	EventTypeInfo
expirationTimeIfNotActivatedUtc	Tempo de expiração do tópico do parceiro. Se este temporizador expirar enquanto o tópico de parceiro ainda não estiver ativado, o tópico do parceiro e o canal de eventos correspondente são eliminados.	string
messageForActivation	Mensagem de contexto ou útil que pode ser utilizada durante o processo de aprovação pelo subscritor.	string
partnerRegistrationImmutableId	O imutávelId do registo de parceiro correspondente.	string Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
partnerTopicFriendlyDescription	Descrição amigável sobre o tópico. Isto pode ser definido pelo editor/parceiro para mostrar a descrição personalizada do tópico do parceiro de cliente. Isto será útil para remover qualquer ambiguidade da origem da criação do tópico de parceiro para o cliente.	string
source	Origem associada a este tópico de parceiro. Isto representa um recurso de parceiro exclusivo.	string

EventTypeInfo

Nome	Descrição	Valor
inlineEventTypes	Uma coleção de tipos de eventos inline para o recurso. As chaves do tipo de evento inline são do tipo cadeia que representa o nome do evento. Um exemplo de um nome de evento inline válido é "Contoso.OrderCreated". Os valores do tipo de evento inline são do tipo InlineEventProperties e conterão informações adicionais para cada tipo de evento inline.	EventTypeInfoInlineEventTypes
tipo	O tipo de evento utilizado.	"Inline"

EventTypeInfoInlineEventTypes

Nome	Descrição	Valor
{customized property}		InlineEventProperties

InlineEventProperties

Nome	Descrição	Valor
dataSchemaUrl	O dataSchemaUrl para o evento inline.	string
descrição	A descrição do evento inline.	string
displayName	O displayName para o evento inline.	string
documentationUrl	A documentaçãoUrl para o evento inline.	string

Definição de recurso de modelo do ARM

O tipo de recurso partnerTopics pode ser implementado com operações que visam:

Grupos de recursos – veja comandos de implementação de grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/partnerTopics, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.EventGrid/partnerTopics",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "activationState": "string",
    "eventTypeInfo": {
      "inlineEventTypes": {
        "{customized property}": {
          "dataSchemaUrl": "string",
          "description": "string",
          "displayName": "string",
          "documentationUrl": "string"
        }
      },
      "kind": "Inline"
    },
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerRegistrationImmutableId": "string",
    "partnerTopicFriendlyDescription": "string",
    "source": "string"
  }
}

Valores de propriedade

partnerTopics

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.EventGrid/partnerTopics"
apiVersion	A versão da API de recursos	"2023-12-15-preview"
name	O nome do recurso	cadeia (obrigatório)
localização	Localização do recurso.	cadeia (obrigatório)
etiquetas	Etiquetas do recurso.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade	Informações de identidade para o recurso Tópico de Parceiro.	IdentityInfo
propriedades	Propriedades do Tópico de Parceiro.	PartnerTopicProperties

IdentityInfo

Nome	Descrição	Valor
principalId	O ID principal da identidade de recurso.	string
tenantId	O ID do inquilino do recurso.	string
tipo	O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.	"Nenhum" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned"
userAssignedIdentities	A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Esta propriedade não é atualmente utilizada e reservada para utilização futura.	IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		UserIdentityProperties

UserIdentityProperties

Nome	Descrição	Valor
clientId	O ID de cliente da identidade atribuída pelo utilizador.	string
principalId	O ID principal da identidade atribuída pelo utilizador.	string

PartnerTopicProperties

Nome	Descrição	Valor
activationState	Estado de ativação do tópico de parceiro.	"Ativado" "Desativado" "Nunca Ativado"
eventTypeInfo	Informações do Tipo de Evento do canal de eventos correspondente.	EventTypeInfo
expirationTimeIfNotActivatedUtc	Tempo de expiração do tópico do parceiro. Se este temporizador expirar enquanto o tópico de parceiro ainda não estiver ativado, o tópico do parceiro e o canal de eventos correspondente são eliminados.	string
messageForActivation	Mensagem de contexto ou útil que pode ser utilizada durante o processo de aprovação pelo subscritor.	string
partnerRegistrationImmutableId	O imutávelId do registo de parceiro correspondente.	string Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
partnerTopicFriendlyDescription	Descrição amigável sobre o tópico. Isto pode ser definido pelo editor/parceiro para mostrar a descrição personalizada do tópico do parceiro de cliente. Isto será útil para remover qualquer ambiguidade da origem da criação do tópico de parceiro para o cliente.	string
source	Origem associada a este tópico de parceiro. Isto representa um recurso de parceiro exclusivo.	string

EventTypeInfo

Nome	Descrição	Valor
inlineEventTypes	Uma coleção de tipos de eventos inline para o recurso. As chaves do tipo de evento inline são do tipo cadeia que representa o nome do evento. Um exemplo de um nome de evento inline válido é "Contoso.OrderCreated". Os valores do tipo de evento inline são do tipo InlineEventProperties e conterão informações adicionais para cada tipo de evento inline.	EventTypeInfoInlineEventTypes
tipo	O tipo de evento utilizado.	"Inline"

EventTypeInfoInlineEventTypes

Nome	Descrição	Valor
{customized property}		InlineEventProperties

InlineEventProperties

Nome	Descrição	Valor
dataSchemaUrl	O dataSchemaUrl para o evento inline.	string
descrição	A descrição do evento inline.	string
displayName	O displayName para o evento inline.	string
documentationUrl	A documentaçãoUrl para o evento inline.	string

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso partnerTopics pode ser implementado com operações que visam:

Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/partnerTopics, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerTopics@2023-12-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      activationState = "string"
      eventTypeInfo = {
        inlineEventTypes = {
          {customized property} = {
            dataSchemaUrl = "string"
            description = "string"
            displayName = "string"
            documentationUrl = "string"
          }
        }
        kind = "Inline"
      }
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerRegistrationImmutableId = "string"
      partnerTopicFriendlyDescription = "string"
      source = "string"
    }
  })
}

Valores de propriedade

partnerTopics

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.EventGrid/partnerTopics@2023-12-15-preview"
name	O nome do recurso	cadeia (obrigatório)
localização	Localização do recurso.	cadeia (obrigatório)
parent_id	Para implementar num grupo de recursos, utilize o ID desse grupo de recursos.	cadeia (obrigatório)
etiquetas	Etiquetas do recurso.	Dicionário de nomes e valores de etiquetas.
identidade	Informações de identidade do recurso Tópico de Parceiro.	IdentityInfo
propriedades	Propriedades do Tópico de Parceiro.	PartnerTopicProperties

IdentityInfo

Nome	Descrição	Valor
tipo	O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.	"SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned"
identity_ids	A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Esta propriedade não é atualmente utilizada e está reservada para utilização futura.	Matriz de IDs de identidade do utilizador.

IdentityInfoUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		UserIdentityProperties

UserIdentityProperties

Nome	Descrição	Valor
clientId	O ID de cliente da identidade atribuída pelo utilizador.	string
principalId	O ID principal da identidade atribuída pelo utilizador.	string

PartnerTopicProperties

Nome	Descrição	Valor
activationState	Estado de ativação do tópico de parceiro.	"Ativado" "Desativado" "NeverActivated"
eventTypeInfo	Informações do Tipo de Evento do canal de eventos correspondente.	EventTypeInfo
expirationTimeIfNotActivatedUtc	Tempo de expiração do tópico de parceiro. Se este temporizador expirar enquanto o tópico de parceiro ainda não estiver ativado, o tópico de parceiro e o canal de eventos correspondente são eliminados.	string
messageForActivation	Contexto ou mensagem útil que pode ser utilizada durante o processo de aprovação pelo subscritor.	string
partnerRegistrationImmutableId	O imutávelId do registo de parceiro correspondente.	string Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
partnerTopicFriendlyDescription	Descrição amigável sobre o tópico. Isto pode ser definido pelo publicador/parceiro para mostrar uma descrição personalizada do tópico do parceiro de cliente. Isto será útil para remover qualquer ambiguidade da origem da criação do tópico de parceiro para o cliente.	string
source	Origem associada a este tópico de parceiro. Isto representa um recurso de parceiro exclusivo.	string

EventTypeInfo

Nome	Descrição	Valor
inlineEventTypes	Uma coleção de tipos de eventos inline para o recurso. As chaves de tipo de evento inline são do tipo cadeia que representa o nome do evento. Um exemplo de um nome de evento inline válido é "Contoso.OrderCreated". Os valores do tipo de evento inline são do tipo InlineEventProperties e irão conter informações adicionais para cada tipo de evento inline.	EventTypeInfoInlineEventTypes
tipo	O tipo de evento utilizado.	"Inline"

EventTypeInfoInlineEventTypes

Nome	Descrição	Valor
{customized property}		InlineEventProperties

InlineEventProperties

Nome	Descrição	Valor
dataSchemaUrl	O dataSchemaUrl para o evento inline.	string
descrição	A descrição do evento inline.	string
displayName	O displayName para o evento inline.	string
documentationUrl	A documentationUrl para o evento inline.	string

Partilhar via

Microsoft.EventGrid partnerTopics

Definição de recurso do Bicep

Formato do recurso

Valores de propriedade

partnerTopics

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

PartnerTopicProperties

EventTypeInfo

EventTypeInfoInlineEventTypes

InlineEventProperties

Definição de recurso de modelo do ARM

Formato do recurso

Valores de propriedade

partnerTopics

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

PartnerTopicProperties

EventTypeInfo

EventTypeInfoInlineEventTypes

InlineEventProperties

Definição de recurso do Terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

partnerTopics

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

PartnerTopicProperties

EventTypeInfo

EventTypeInfoInlineEventTypes

InlineEventProperties

Comentários

Recursos adicionais