Partilhar via

Domínios Microsoft.EventGrid 2020-04-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso de domínios 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/domains, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.EventGrid/domains@2020-04-01-preview' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    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

ConnectionState

Designação Descrição Valor
açõesObrigatório Ações necessárias (se houver). string
Descrição Descrição do estado da conexão. string
Situação Status da conexão. 'Aprovado'
'Desconectado'
'Pendente'
'Rejeitado'

DomainProperties

Designação Descrição Valor
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 domínio. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informações sobre o InputSchemaMapping que especificou as informações sobre o mapeamento da carga útil do evento. InputSchemaMapping
privateEndpointConnections Lista de conexões de ponto de extremidade privadas. PrivateEndpointConnection []
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.DomainProperties.InboundIpRules" />		 'Desativado'
'Habilitado'

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/domínios

Designação Descrição Valor
identidade Informações de identidade para o recurso. IdentityInfo
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do domínio. DomainProperties
SKU A camada de preço de Sku para o domínio. ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

PrivateEndpoint

Designação Descrição Valor
ID O identificador ARM para Private Endpoint. string

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Designação Descrição Valor
groupIds GroupIds do recurso de serviço de link privado. string[]
privateEndpoint O recurso Ponto Final Privado para esta Conexão. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da conexão. ConnectionState
provisionamentoEstado Estado de provisionamento da Private Endpoint Connection. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'

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'

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 uso

Módulos verificados do Azure

Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.

Módulo Descrição
Domínio da Grade de Eventos Módulo de recursos AVM para domínio de grade de eventos

Definição de recurso de modelo ARM

O tipo de recurso de domínios 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/domains, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.EventGrid/domains",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "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

ConnectionState

Designação Descrição Valor
açõesObrigatório Ações necessárias (se houver). string
Descrição Descrição do estado da conexão. string
Situação Status da conexão. 'Aprovado'
'Desconectado'
'Pendente'
'Rejeitado'

DomainProperties

Designação Descrição Valor
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 domínio. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informações sobre o InputSchemaMapping que especificou as informações sobre o mapeamento da carga útil do evento. InputSchemaMapping
privateEndpointConnections Lista de conexões de ponto de extremidade privadas. PrivateEndpointConnection []
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.DomainProperties.InboundIpRules" />		 'Desativado'
'Habilitado'

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/domínios

Designação Descrição Valor
apiVersion A versão api '2020-04-01-pré-visualização'
identidade Informações de identidade para o recurso. IdentityInfo
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do domínio. DomainProperties
SKU A camada de preço de Sku para o domínio. ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.EventGrid/domínios'

PrivateEndpoint

Designação Descrição Valor
ID O identificador ARM para Private Endpoint. string

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Designação Descrição Valor
groupIds GroupIds do recurso de serviço de link privado. string[]
privateEndpoint O recurso Ponto Final Privado para esta Conexão. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da conexão. ConnectionState
provisionamentoEstado Estado de provisionamento da Private Endpoint Connection. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'

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'

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 uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso de domínios 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/domains, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-04-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      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

ConnectionState

Designação Descrição Valor
açõesObrigatório Ações necessárias (se houver). string
Descrição Descrição do estado da conexão. string
Situação Status da conexão. 'Aprovado'
'Desconectado'
'Pendente'
'Rejeitado'

DomainProperties

Designação Descrição Valor
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 domínio. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informações sobre o InputSchemaMapping que especificou as informações sobre o mapeamento da carga útil do evento. InputSchemaMapping
privateEndpointConnections Lista de conexões de ponto de extremidade privadas. PrivateEndpointConnection []
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.DomainProperties.InboundIpRules" />		 'Desativado'
'Habilitado'

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/domínios

Designação Descrição Valor
identidade Informações de identidade para o recurso. IdentityInfo
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do domínio. DomainProperties
SKU A camada de preço de Sku para o domínio. ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.EventGrid/domains@2020-04-01-pré-visualização"

PrivateEndpoint

Designação Descrição Valor
ID O identificador ARM para Private Endpoint. string

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Designação Descrição Valor
groupIds GroupIds do recurso de serviço de link privado. string[]
privateEndpoint O recurso Ponto Final Privado para esta Conexão. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da conexão. ConnectionState
provisionamentoEstado Estado de provisionamento da Private Endpoint Connection. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'

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'

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 uso

Módulos verificados do Azure

Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.

Módulo Descrição
Domínio da Grade de Eventos Módulo de recursos AVM para domínio de grade de eventos