Partilhar via


Tópicos Microsoft.EventGrid 2021-10-15-preview

Definição de recurso do Bicep

O tipo de recurso de tópicos pode ser implementado com operações que visam:

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/topics, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.EventGrid/topics@2021-10-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    dataResidencyBoundary: 'string'
    disableLocalAuth: bool
    inboundIpRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    publicNetworkAccess: 'string'
  }
}

InputSchemaMapping objects (Objetos InputSchemaMapping)

Defina a propriedade inputSchemaMappingType para especificar o tipo de objeto.

Para Json, utilize:

  inputSchemaMappingType: 'Json'
  properties: {
    dataVersion: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    eventTime: {
      sourceField: 'string'
    }
    eventType: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    id: {
      sourceField: 'string'
    }
    subject: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    topic: {
      sourceField: 'string'
    }
  }

Valores de propriedade

tópicos

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-50

Carateres válidos:
Alfanuméricos e hífenes.
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
sku O escalão de preço do SKU para o tópico. ResourceSku
tipo Tipo de recurso. "Azure"
"AzureArc"
extendedLocation Localização expandida do recurso. ExtendedLocation
identidade Informações de identidade do recurso. IdentityInfo
propriedades Propriedades do tópico. TopicProperties

ExtendedLocation

Nome Descrição Valor
name Nome completamente qualificado da localização expandida. string
tipo Tipo de localização expandida. string

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

TópicoPropriedades

Nome Descrição Valor
dataResidencyBoundary Data Residency Limite do recurso. "WithinGeopair"
"WithinRegion"
disableLocalAuth Este booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no tópico. bool
inboundIpRules Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado. InboundIpRule[]
inputSchema Isto determina o formato que o Event Grid deve esperar para os eventos recebidos publicados no tópico. 'CloudEventSchemaV1_0'
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Isto permite a publicação através de esquemas de eventos personalizados. É possível especificar um InputSchemaMapping para mapear várias propriedades de um esquema de origem para várias propriedades necessárias do esquema EventGridEvent. InputSchemaMapping
publicNetworkAccess Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativada.
Pode restringir ainda mais iPs específicos ao configurar {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" /}
"Desativado"
"Ativado"

InboundIpRule

Nome Descrição Valor
action Ação a executar com base na correspondência ou nenhuma correspondência do IpMask. "Permitir"
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

InputSchemaMapping

Nome Descrição Valor
inputSchemaMappingType Definir o tipo de objeto Json (obrigatório)

JsonInputSchemaMapping

Nome Descrição Valor
inputSchemaMappingType Tipo de mapeamento personalizado "Json" (obrigatório)
propriedades Propriedades JSON do mapeamento do esquema de entrada JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nome Descrição Valor
dataVersion As informações de mapeamento da propriedade DataVersion do Evento do Event Grid. JsonFieldWithDefault
eventTime As informações de mapeamento da propriedade EventTime do Evento do Event Grid. Campo Json
eventType As informações de mapeamento da propriedade EventType do Evento do Event Grid. JsonFieldWithDefault
ID As informações de mapeamento da propriedade ID do Evento do Event Grid. Campo Json
subject As informações de mapeamento da propriedade Assunto do Evento do Event Grid. JsonFieldWithDefault
tópico As informações de mapeamento da propriedade Tópico do Evento do Event Grid. Campo Json

JsonFieldWithDefault

Nome Descrição Valor
defaultValue O valor predefinido a ser utilizado para mapeamento quando um Campo de Origem não é fornecido ou se não existir nenhuma propriedade com o nome especificado no payload de evento JSON publicado. string
sourceField Nome de um campo no esquema de eventos de entrada que deve ser utilizado como a origem de um mapeamento. string

JsonField

Nome Descrição Valor
sourceField Nome de um campo no esquema de eventos de entrada que deve ser utilizado como a origem de um mapeamento. string

ResourceSku

Nome Descrição Valor
name O nome do SKU do recurso. Os valores possíveis são: Básico ou Premium. "Básico"
"Premium"

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar Azure Event Grid Tópico Personalizado e Subscrição

Implementar no Azure
Cria um tópico personalizado Azure Event Grid e uma subscrição de webhook. Modelo originalmente criado por John Downs.
Tópico/Subscrição de Azure Event Grid Personalizado com o CloudEvents

Implementar no Azure
Cria um tópico de Azure Event Grid personalizado, uma subscrição de webhook com esquema CloudEvents e uma Aplicação Lógica como processador de eventos. Modelo originalmente criado por Justin Yoo.
Criar tópico personalizado do Event Grid e processador do hub de eventos

Implementar no Azure
Cria um Azure Event Grid tópico personalizado e hub de eventos para processar os eventos.
Criar Azure Event Grid Tópico Personalizado e Subscrição de Fila

Implementar no Azure
Cria um tópico personalizado Azure Event Grid e uma subscrição de fila do service bus. Modelo originalmente criado por Markus Meyer.
Criar Azure Event Grid Subscrição de Tópico Personalizado

Implementar no Azure
Cria um tópico personalizado Azure Event Grid e uma subscrição de tópico do service bus. Modelo originalmente criado por Markus Meyer.

Definição de recurso de modelo do ARM

O tipo de recurso de tópicos pode ser implementado com operações que visam:

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/topics, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2021-10-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "dataResidencyBoundary": "string",
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "publicNetworkAccess": "string"
  }
}

InputSchemaMapping objects (Objetos InputSchemaMapping)

Defina a propriedade inputSchemaMappingType para especificar o tipo de objeto.

Para Json, utilize:

  "inputSchemaMappingType": "Json",
  "properties": {
    "dataVersion": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "eventTime": {
      "sourceField": "string"
    },
    "eventType": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "id": {
      "sourceField": "string"
    },
    "subject": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "topic": {
      "sourceField": "string"
    }
  }

Valores de propriedade

tópicos

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/topics"
apiVersion A versão da API de recursos "2021-10-15-preview"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-50

Carateres válidos:
Alfanuméricos e hífenes.
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
sku O escalão de preço do SKU para o tópico. ResourceSku
tipo Tipo de recurso. "Azure"
"AzureArc"
extendedLocation Localização expandida do recurso. ExtendedLocation
identidade Informações de identidade do recurso. IdentityInfo
propriedades Propriedades do tópico. TopicProperties

ExtendedLocation

Nome Descrição Valor
name Nome completamente qualificado da localização expandida. string
tipo Tipo de localização expandida. string

IdentityInfo

Nome Descrição Valor
principalId O ID principal da identidade do recurso. string
tenantId O ID de 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 está 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

TópicoPropriedades

Nome Descrição Valor
dataResidencyBoundary Data Residency Limite do recurso. "WithinGeopair"
"WithinRegion"
disableLocalAuth Este booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no tópico. bool
inboundIpRules Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado. InboundIpRule[]
inputSchema Isto determina o formato que o Event Grid deve esperar para os eventos recebidos publicados no tópico. 'CloudEventSchemaV1_0'
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Isto permite a publicação através de esquemas de eventos personalizados. É possível especificar um InputSchemaMapping para mapear várias propriedades de um esquema de origem para várias propriedades necessárias do esquema EventGridEvent. InputSchemaMapping
publicNetworkAccess Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativada.
Pode restringir ainda mais iPs específicos ao configurar {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" /}
"Desativado"
"Ativado"

InboundIpRule

Nome Descrição Valor
action Ação a executar com base na correspondência ou nenhuma correspondência do IpMask. "Permitir"
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

InputSchemaMapping

Nome Descrição Valor
inputSchemaMappingType Definir o tipo de objeto Json (obrigatório)

JsonInputSchemaMapping

Nome Descrição Valor
inputSchemaMappingType Tipo de mapeamento personalizado "Json" (obrigatório)
propriedades Propriedades JSON do mapeamento do esquema de entrada JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nome Descrição Valor
dataVersion As informações de mapeamento da propriedade DataVersion do Evento do Event Grid. JsonFieldWithDefault
eventTime As informações de mapeamento da propriedade EventTime do Evento do Event Grid. Campo Json
eventType As informações de mapeamento da propriedade EventType do Evento do Event Grid. JsonFieldWithDefault
ID As informações de mapeamento da propriedade ID do Evento do Event Grid. Campo Json
subject As informações de mapeamento da propriedade Assunto do Evento do Event Grid. JsonFieldWithDefault
tópico As informações de mapeamento da propriedade Tópico do Evento do Event Grid. Campo Json

JsonFieldWithDefault

Nome Descrição Valor
valordepredefinido O valor predefinido a ser utilizado para mapeamento quando um SourceField não é fornecido ou se não existe nenhuma propriedade com o nome especificado no payload de evento JSON publicado. string
sourceField Nome de um campo no esquema de evento de entrada que vai ser utilizado como a origem de um mapeamento. string

Campo Json

Nome Descrição Valor
sourceField Nome de um campo no esquema de evento de entrada que vai ser utilizado como a origem de um mapeamento. string

ResourceSku

Nome Descrição Valor
name O nome do SKU do recurso. Os valores possíveis são: Básico ou Premium. "Básico"
"Premium"

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar Azure Event Grid Tópico e Subscrição Personalizados

Implementar no Azure
Cria um tópico personalizado Azure Event Grid e uma subscrição de webhook. Modelo originalmente criado por John Downs.
Tópico/Subscrição de Azure Event Grid Personalizado com o CloudEvents

Implementar no Azure
Cria um tópico de Azure Event Grid personalizado, uma subscrição de webhook com esquema CloudEvents e uma Aplicação Lógica como processador de eventos. Modelo originalmente criado por Justin Yoo.
Criar tópico personalizado do Event Grid e processador do hub de eventos

Implementar no Azure
Cria uma Azure Event Grid tópico personalizado e um hub de eventos para processar os eventos.
Criar Azure Event Grid Tópico Personalizado e Subscrição de Fila

Implementar no Azure
Cria um tópico personalizado Azure Event Grid e uma subscrição de fila do service bus. Modelo originalmente criado por Markus Meyer.
Criar Azure Event Grid Subscrição de Tópico Personalizado

Implementar no Azure
Cria um tópico personalizado Azure Event Grid e uma subscrição de tópico do service bus. Modelo originalmente criado por Markus Meyer.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso de tópicos pode ser implementado com operações que visam:

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2021-10-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      dataResidencyBoundary = "string"
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      publicNetworkAccess = "string"
    }
    sku = {
      name = "string"
    }
    kind = "string"
    extendedLocation = {
      name = "string"
      type = "string"
    }
  })
}

Objetos InputSchemaMapping

Defina a propriedade inputSchemaMappingType para especificar o tipo de objeto.

Para Json, utilize:

  inputSchemaMappingType = "Json"
  properties = {
    dataVersion = {
      defaultValue = "string"
      sourceField = "string"
    }
    eventTime = {
      sourceField = "string"
    }
    eventType = {
      defaultValue = "string"
      sourceField = "string"
    }
    id = {
      sourceField = "string"
    }
    subject = {
      defaultValue = "string"
      sourceField = "string"
    }
    topic = {
      sourceField = "string"
    }
  }

Valores de propriedade

tópicos

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/topics@2021-10-15-preview"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-50

Carateres válidos:
Alfanuméricos e hífenes.
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.
sku O escalão de preço do SKU para o tópico. ResourceSku
tipo Tipo de recurso. "Azure"
"AzureArc"
extendedLocation Localização expandida do recurso. ExtendedLocation
identidade Informações de identidade do recurso. IdentityInfo
propriedades Propriedades do tópico. TópicoPropriedades

ExtendedLocation

Nome Descrição Valor
name Nome completamente qualificado da localização expandida. string
tipo Tipo de localização expandida. string

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

TópicoPropriedades

Nome Descrição Valor
dataResidencyBoundary Data Residency Limite do recurso. "WithinGeopair"
"WithinRegion"
disableLocalAuth Este booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no tópico. bool
inboundIpRules Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado. InboundIpRule[]
inputSchema Isto determina o formato que o Event Grid deve esperar para os eventos recebidos publicados no tópico. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Isto permite a publicação através de esquemas de eventos personalizados. É possível especificar um InputSchemaMapping para mapear várias propriedades de um esquema de origem para várias propriedades necessárias do esquema EventGridEvent. InputSchemaMapping
publicNetworkAccess Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativada.
Pode restringir ainda mais iPs específicos ao configurar {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" /}
"Desativado"
"Ativado"

InboundIpRule

Nome Descrição Valor
action Ação a executar com base na correspondência ou sem correspondência do IpMask. "Permitir"
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

InputSchemaMapping

Nome Descrição Valor
inputSchemaMappingType Definir o tipo de objeto Json (obrigatório)

JsonInputSchemaMapping

Nome Descrição Valor
inputSchemaMappingType Tipo de mapeamento personalizado "Json" (obrigatório)
propriedades Propriedades JSON do mapeamento do esquema de entrada JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nome Descrição Valor
dataVersion As informações de mapeamento da propriedade DataVersion do Evento do Event Grid. JsonFieldWithDefault
eventTime As informações de mapeamento da propriedade EventTime do Evento do Event Grid. JsonField
eventType As informações de mapeamento da propriedade EventType do Evento do Event Grid. JsonFieldWithDefault
ID As informações de mapeamento da propriedade ID do Evento do Event Grid. JsonField
subject As informações de mapeamento da propriedade Assunto do Evento do Event Grid. JsonFieldWithDefault
tópico As informações de mapeamento da propriedade Tópico do Evento do Event Grid. JsonField

JsonFieldWithDefault

Nome Descrição Valor
defaultValue O valor predefinido a ser utilizado para mapeamento quando um Campo de Origem não é fornecido ou se não existir nenhuma propriedade com o nome especificado no payload de evento JSON publicado. string
sourceField Nome de um campo no esquema de eventos de entrada que deve ser utilizado como a origem de um mapeamento. string

JsonField

Nome Descrição Valor
sourceField Nome de um campo no esquema de eventos de entrada que deve ser utilizado como a origem de um mapeamento. string

ResourceSku

Nome Descrição Valor
name O nome do SKU do recurso. Os valores possíveis são: Básico ou Premium. "Básico"
"Premium"