Partilhar via


Tópicos Microsoft.EventGrid 2021-06-01-preview

Definição de recursos do bíceps

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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-06-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    disableLocalAuth: bool
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    publicNetworkAccess: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Objetos InputSchemaMapping

Defina a propriedade inputSchemaMappingType para especificar o tipo de objeto.

Para Json, use:

{
  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

Localização Estendida

Designação Descrição Valor
Designação Nome totalmente qualificado do local estendido. string
tipo Tipo de local estendido. string

IdentityInfo

Designação Descrição Valor
principalId A ID principal da identidade do recurso. string
inquilinoId A ID do locatário do recurso. string
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 'Nenhum' removerá qualquer identidade. 'Nenhuma'
'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 ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propriedade não é usada no momento e está reservada para uso futuro.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Designação Descrição Valor

InboundIpRule

Designação Descrição Valor
ação Ação a executar com base na correspondência ou não correspondência da IpMask. 'Permitir'
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

InputSchemaMapping

Designação Descrição Valor
inputSchemaMappingType Defina como 'Json' para o tipo JsonInputSchemaMapping. 'Json' (obrigatório)

JsonField

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

JsonFieldWithDefault

Designação Descrição Valor
defaultValue O valor padrão a ser usado para mapeamento quando um SourceField não é fornecido ou se não há nenhuma propriedade com o nome especificado na carga de evento JSON publicada. string
fonteField Nome de um campo no esquema de eventos de entrada que deve ser usado como a origem de um mapeamento. string

JsonInputSchemaMapping

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

JsonInputSchemaMappingProperties

Designação Descrição Valor
dataVersion As informações de mapeamento para a propriedade DataVersion do evento Event Grid. JsonFieldWithDefault
eventTime As informações de mapeamento para a propriedade EventTime do evento Event Grid. JsonField
eventType As informações de mapeamento para a propriedade EventType do evento Event Grid. JsonFieldWithDefault
ID As informações de mapeamento para a propriedade Id do evento Event Grid. JsonField
Assunto As informações de mapeamento para a propriedade Subject do evento Event Grid. JsonFieldWithDefault
tópico As informações de mapeamento para a propriedade Topic do evento Event Grid. JsonField

Microsoft.EventGrid/topics

Designação Descrição Valor
extendedLocalização Localização estendida do recurso. ExtendedLocation
identidade Informações de identidade para o recurso. IdentityInfo
tipo Tipo de recurso. 'Azure'
'AzureArc'
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do tópico. TopicProperties
SKU O nível de preço de Sku para o tópico. ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

ResourceSku

Designação Descrição Valor
Designação O nome da Sku do recurso. Os valores possíveis são: Básico ou Premium. 'Básico'
'Premium'

TopicProperties

Designação Descrição Valor
disableLocalAuth Este booleano é usado para ativar ou desativar a autenticação local. O valor padrão é false. Quando a propriedade é definida como true, somente o token AAD será usado para autenticar se o usuário tiver permissão para publicar no tópico. Bool
inboundIpRules Isso pode ser usado 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 Isso determina o formato que a Grade de Eventos deve esperar para eventos de entrada publicados no tópico. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Isso permite a publicação usando esquemas de eventos personalizados. Um InputSchemaMapping pode ser especificado para mapear várias propriedades de um esquema de origem para várias propriedades necessárias do esquema EventGridEvent. InputSchemaMapping
publicNetworkAccess Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.
Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />
'Desativado'
'Habilitado'

TrackedResourceTags

Designação Descrição Valor

UserIdentityProperties

Designação Descrição Valor
ID do cliente O ID do cliente da identidade atribuída ao usuário. string
principalId O id principal da identidade atribuída ao usuário. string

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Criar Tópico Personalizado da Grade de Eventos do Azure e de Assinatura de Fila Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila de barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Criar tópico personalizado da grade de eventos do Azure e de assinatura Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.

Definição de recurso de modelo ARM

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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-06-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "publicNetworkAccess": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objetos InputSchemaMapping

Defina a propriedade inputSchemaMappingType para especificar o tipo de objeto.

Para Json, use:

{
  "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

Localização Estendida

Designação Descrição Valor
Designação Nome totalmente qualificado do local estendido. string
tipo Tipo de local estendido. string

IdentityInfo

Designação Descrição Valor
principalId A ID principal da identidade do recurso. string
inquilinoId A ID do locatário do recurso. string
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 'Nenhum' removerá qualquer identidade. 'Nenhuma'
'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 ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propriedade não é usada no momento e está reservada para uso futuro.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Designação Descrição Valor

InboundIpRule

Designação Descrição Valor
ação Ação a executar com base na correspondência ou não correspondência da IpMask. 'Permitir'
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

InputSchemaMapping

Designação Descrição Valor
inputSchemaMappingType Defina como 'Json' para o tipo JsonInputSchemaMapping. 'Json' (obrigatório)

JsonField

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

JsonFieldWithDefault

Designação Descrição Valor
defaultValue O valor padrão a ser usado para mapeamento quando um SourceField não é fornecido ou se não há nenhuma propriedade com o nome especificado na carga de evento JSON publicada. string
fonteField Nome de um campo no esquema de eventos de entrada que deve ser usado como a origem de um mapeamento. string

JsonInputSchemaMapping

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

JsonInputSchemaMappingProperties

Designação Descrição Valor
dataVersion As informações de mapeamento para a propriedade DataVersion do evento Event Grid. JsonFieldWithDefault
eventTime As informações de mapeamento para a propriedade EventTime do evento Event Grid. JsonField
eventType As informações de mapeamento para a propriedade EventType do evento Event Grid. JsonFieldWithDefault
ID As informações de mapeamento para a propriedade Id do evento Event Grid. JsonField
Assunto As informações de mapeamento para a propriedade Subject do evento Event Grid. JsonFieldWithDefault
tópico As informações de mapeamento para a propriedade Topic do evento Event Grid. JsonField

Microsoft.EventGrid/topics

Designação Descrição Valor
apiVersion A versão api '2021-06-01-pré-visualização'
extendedLocalização Localização estendida do recurso. ExtendedLocation
identidade Informações de identidade para o recurso. IdentityInfo
tipo Tipo de recurso. 'Azure'
'AzureArc'
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do tópico. TopicProperties
SKU O nível de preço de Sku para o tópico. ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.EventGrid/topics'

ResourceSku

Designação Descrição Valor
Designação O nome da Sku do recurso. Os valores possíveis são: Básico ou Premium. 'Básico'
'Premium'

TopicProperties

Designação Descrição Valor
disableLocalAuth Este booleano é usado para ativar ou desativar a autenticação local. O valor padrão é false. Quando a propriedade é definida como true, somente o token AAD será usado para autenticar se o usuário tiver permissão para publicar no tópico. Bool
inboundIpRules Isso pode ser usado 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 Isso determina o formato que a Grade de Eventos deve esperar para eventos de entrada publicados no tópico. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Isso permite a publicação usando esquemas de eventos personalizados. Um InputSchemaMapping pode ser especificado para mapear várias propriedades de um esquema de origem para várias propriedades necessárias do esquema EventGridEvent. InputSchemaMapping
publicNetworkAccess Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.
Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />
'Desativado'
'Habilitado'

TrackedResourceTags

Designação Descrição Valor

UserIdentityProperties

Designação Descrição Valor
ID do cliente O ID do cliente da identidade atribuída ao usuário. string
principalId O id principal da identidade atribuída ao usuário. string

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar Tópico Personalizado da Grade de Eventos do Azure e de Assinatura de Fila

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila de barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Criar tópico personalizado da grade de eventos do Azure e de assinatura

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.
Criar de Subscrição de Tópico Personalizado da Grelha de Eventos do Azure

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Criar tópico personalizado da Grade de Eventos e manipulador de hub de eventos

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e um hub de eventos para manipular os eventos.
Tópico/assinatura personalizada da grade de eventos do Azure com o CloudEvents

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure, uma assinatura de webhook com esquema CloudEvents e um Aplicativo Lógico como manipulador de eventos. Modelo originalmente criado por Justin Yoo.

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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-06-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      publicNetworkAccess = "string"
    }
  })
}

Objetos InputSchemaMapping

Defina a propriedade inputSchemaMappingType para especificar o tipo de objeto.

Para Json, use:

{
  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

Localização Estendida

Designação Descrição Valor
Designação Nome totalmente qualificado do local estendido. string
tipo Tipo de local estendido. string

IdentityInfo

Designação Descrição Valor
principalId A ID principal da identidade do recurso. string
inquilinoId A ID do locatário do recurso. string
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 'Nenhum' removerá qualquer identidade. 'Nenhuma'
'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 ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propriedade não é usada no momento e está reservada para uso futuro.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Designação Descrição Valor

InboundIpRule

Designação Descrição Valor
ação Ação a executar com base na correspondência ou não correspondência da IpMask. 'Permitir'
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

InputSchemaMapping

Designação Descrição Valor
inputSchemaMappingType Defina como 'Json' para o tipo JsonInputSchemaMapping. 'Json' (obrigatório)

JsonField

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

JsonFieldWithDefault

Designação Descrição Valor
defaultValue O valor padrão a ser usado para mapeamento quando um SourceField não é fornecido ou se não há nenhuma propriedade com o nome especificado na carga de evento JSON publicada. string
fonteField Nome de um campo no esquema de eventos de entrada que deve ser usado como a origem de um mapeamento. string

JsonInputSchemaMapping

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

JsonInputSchemaMappingProperties

Designação Descrição Valor
dataVersion As informações de mapeamento para a propriedade DataVersion do evento Event Grid. JsonFieldWithDefault
eventTime As informações de mapeamento para a propriedade EventTime do evento Event Grid. JsonField
eventType As informações de mapeamento para a propriedade EventType do evento Event Grid. JsonFieldWithDefault
ID As informações de mapeamento para a propriedade Id do evento Event Grid. JsonField
Assunto As informações de mapeamento para a propriedade Subject do evento Event Grid. JsonFieldWithDefault
tópico As informações de mapeamento para a propriedade Topic do evento Event Grid. JsonField

Microsoft.EventGrid/topics

Designação Descrição Valor
extendedLocalização Localização estendida do recurso. ExtendedLocation
identidade Informações de identidade para o recurso. IdentityInfo
tipo Tipo de recurso. 'Azure'
'AzureArc'
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do tópico. TopicProperties
SKU O nível de preço de Sku para o tópico. ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.EventGrid/topics@2021-06-01-preview"

ResourceSku

Designação Descrição Valor
Designação O nome da Sku do recurso. Os valores possíveis são: Básico ou Premium. 'Básico'
'Premium'

TopicProperties

Designação Descrição Valor
disableLocalAuth Este booleano é usado para ativar ou desativar a autenticação local. O valor padrão é false. Quando a propriedade é definida como true, somente o token AAD será usado para autenticar se o usuário tiver permissão para publicar no tópico. Bool
inboundIpRules Isso pode ser usado 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 Isso determina o formato que a Grade de Eventos deve esperar para eventos de entrada publicados no tópico. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Isso permite a publicação usando esquemas de eventos personalizados. Um InputSchemaMapping pode ser especificado para mapear várias propriedades de um esquema de origem para várias propriedades necessárias do esquema EventGridEvent. InputSchemaMapping
publicNetworkAccess Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.
Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />
'Desativado'
'Habilitado'

TrackedResourceTags

Designação Descrição Valor

UserIdentityProperties

Designação Descrição Valor
ID do cliente O ID do cliente da identidade atribuída ao usuário. string
principalId O id principal da identidade atribuída ao usuário. string