Compartilhar via

Microsoft.EventGrid partnerTopics 2022-06-15

  • Artigo

Definição de recurso do Bicep

O tipo de recurso partnerTopics pode ser implantado com operações direcionadas:

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

Formato de recurso

Para criar um recurso Microsoft.EventGrid/partnerTopics, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.EventGrid/partnerTopics@2022-06-15' = {
  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 de caracteres (obrigatório)
local Local do recurso. cadeia de caracteres (obrigatório)
marcas Marcas do recurso. Dicionário de nomes e valores de marcas. Confira Marcas em modelos
identidade Informações de identidade para o recurso tópico do parceiro. IdentityInfo
properties Propriedades do Tópico do Parceiro. PartnerTopicProperties

IdentityInfo

Nome Descrição Valor
principalId A ID da entidade de segurança da identidade do recurso. string
tenantId A ID do locatário do recurso. string
type O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
No momento, essa propriedade não é usada e reservada para uso futuro.
 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId A ID do cliente da identidade atribuída pelo usuário. string
principalId A ID principal da identidade atribuída pelo usuário. string

PartnerTopicProperties

Nome Descrição Valor
activationState Estado de ativação do tópico do parceiro. 'Ativado'
'Desativado'
'NeverActivated'
eventTypeInfo Informações de Tipo de Evento do canal de evento correspondente. EventTypeInfo
expirationTimeIfNotActivatedUtc Hora de expiração do tópico do parceiro. Se esse temporizador expirar enquanto o tópico do parceiro ainda não estiver ativado,
o tópico do parceiro e o canal de eventos correspondente são excluídos.		 string
messageForActivation Contexto ou mensagem útil que pode ser usada durante o processo de aprovação pelo assinante. string
partnerRegistrationImmutableId A immutableId do registro 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. Isso pode ser definido pelo editor/parceiro para mostrar a descrição personalizada para o tópico do parceiro do cliente.
Isso 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. Isso representa um recurso de parceiro exclusivo. string

EventTypeInfo

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

EventTypeInfoInlineEventTypes

Nome Descrição Valor
{propriedade personalizada} InlineEventProperties

InlineEventProperties

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

Definição de recurso de modelo do ARM

O tipo de recurso partnerTopics pode ser implantado com operações direcionadas:

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

Formato de recurso

Para criar um recurso Microsoft.EventGrid/partnerTopics, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.EventGrid/partnerTopics",
  "apiVersion": "2022-06-15",
  "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 do recurso '2022-06-15'
name O nome do recurso cadeia de caracteres (obrigatório)
local Local do recurso. cadeia de caracteres (obrigatório)
marcas Marcas do recurso. Dicionário de nomes e valores de marcas. Confira Marcas em modelos
identidade Informações de identidade para o recurso tópico do parceiro. IdentityInfo
properties Propriedades do Tópico do Parceiro. PartnerTopicProperties

IdentityInfo

Nome Descrição Valor
principalId A ID da entidade de segurança da identidade do recurso. string
tenantId A ID do locatário do recurso. string
type O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
No momento, essa propriedade não é usada e reservada para uso futuro.
 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId A ID do cliente da identidade atribuída pelo usuário. string
principalId A ID principal da identidade atribuída pelo usuário. string

PartnerTopicProperties

Nome Descrição Valor
activationState Estado de ativação do tópico do parceiro. 'Ativado'
'Desativado'
'NeverActivated'
eventTypeInfo Informações de Tipo de Evento do canal de evento correspondente. EventTypeInfo
expirationTimeIfNotActivatedUtc Hora de expiração do tópico do parceiro. Se esse temporizador expirar enquanto o tópico do parceiro ainda não estiver ativado,
o tópico do parceiro e o canal de eventos correspondente são excluídos.		 string
messageForActivation Contexto ou mensagem útil que pode ser usada durante o processo de aprovação pelo assinante. string
partnerRegistrationImmutableId A immutableId do registro 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. Isso pode ser definido pelo editor/parceiro para mostrar a descrição personalizada para o tópico do parceiro do cliente.
Isso 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. Isso representa um recurso de parceiro exclusivo. string

EventTypeInfo

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

EventTypeInfoInlineEventTypes

Nome Descrição Valor
{propriedade personalizada} InlineEventProperties

InlineEventProperties

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

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

O tipo de recurso partnerTopics pode ser implantado com operações direcionadas:

  • Grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.EventGrid/partnerTopics, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerTopics@2022-06-15"
  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@2022-06-15"
name O nome do recurso cadeia de caracteres (obrigatório)
local Local do recurso. cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas Marcas do recurso. Dicionário de nomes e valores de marcas.
identidade Informações de identidade para o recurso tópico do parceiro. IdentityInfo
properties Propriedades do Tópico do Parceiro. PartnerTopicProperties

IdentityInfo

Nome Descrição Valor
tipo O tipo de identidade gerenciada usada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
No momento, essa propriedade não é usada e reservada para uso futuro.
 Matriz de IDs de identidade do usuário.

IdentityInfoUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId A ID do cliente da identidade atribuída pelo usuário. string
principalId A ID principal da identidade atribuída pelo usuário. string

PartnerTopicProperties

Nome Descrição Valor
activationState Estado de ativação do tópico do parceiro. "Ativado"
"Desativado"
"NeverActivated"
eventTypeInfo Informações de Tipo de Evento do canal de evento correspondente. EventTypeInfo
expirationTimeIfNotActivatedUtc Hora de expiração do tópico do parceiro. Se esse temporizador expirar enquanto o tópico do parceiro ainda não estiver ativado,
o tópico do parceiro e o canal de eventos correspondente são excluídos.		 string
messageForActivation Contexto ou mensagem útil que pode ser usada durante o processo de aprovação pelo assinante. string
partnerRegistrationImmutableId A immutableId do registro 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. Isso pode ser definido pelo editor/parceiro para mostrar a descrição personalizada para o tópico do parceiro do cliente.
Isso 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. Isso representa um recurso de parceiro exclusivo. string

EventTypeInfo

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

EventTypeInfoInlineEventTypes

Nome Descrição Valor
{propriedade personalizada} InlineEventProperties

InlineEventProperties

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