Partilhar via

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

  • Artigo

Definição de recurso do Bicep

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

resource symbolicname 'Microsoft.EventGrid/domains@2020-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    inboundIpRules: [
      {
        action: 'Allow'
        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'
  }
}

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

domínios

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 domínio. ResourceSku
identidade Informações de identidade do recurso. IdentityInfo
propriedades Propriedades do domínio. DomainProperties

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

DomainProperties

Nome Descrição Valor
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 eventos de entrada publicados no domínio. 'CloudEventSchemaV1_0'
"CustomEventSchema"
'EventGridSchema'
inputSchemaMapping Informações sobre o InputSchemaMapping que especificou as informações sobre o payload de eventos de mapeamento. InputSchemaMapping
privateEndpointConnections Lista de ligações de pontos finais privados. PrivateEndpointConnection[]
publicNetworkAccess Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado.
Pode restringir-se ainda mais a IPs específicos ao configurar {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

Nome Descrição Valor
groupIds GroupIds do recurso do serviço de ligação privada. cadeia[]
privateEndpoint O recurso de Ponto Final Privado para esta Ligação. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da ligação. ConnectionState
provisioningState Estado de aprovisionamento da Ligação de Ponto Final Privado. "Cancelado"
"A criar"
"A eliminar"
"Com falhas"
"Com êxito"
"A atualizar"

PrivateEndpoint

Nome Descrição Valor
ID O identificador arm do Ponto Final Privado. string

ConnectionState

Nome Descrição Valor
actionsRequired Ações necessárias (se existirem). string
descrição Descrição do estado da ligação. string
status Estado da ligação. "Aprovado"
"Desligado"
"Pendente"
"Rejeitado"

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"

Definição de recurso do modelo arm

O tipo de recurso de domínios pode ser implementado com operações que visam:

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

{
  "type": "Microsoft.EventGrid/domains",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "inboundIpRules": [
      {
        "action": "Allow",
        "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, 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

domínios

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/domains"
apiVersion A versão da API de recursos '2020-04-01-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 domínio. ResourceSku
identidade Informações de identidade do recurso. IdentityInfo
propriedades Propriedades do domínio. Propriedades de Domínio

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

Propriedades de Domínio

Nome Descrição Valor
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 eventos recebidos publicados no domínio. 'CloudEventSchemaV1_0'
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Informações sobre InputSchemaMapping que especificaram as informações sobre o payload de eventos de mapeamento. InputSchemaMapping
privateEndpointConnections Lista de ligações de pontos finais privados. PrivateEndpointConnection[]
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.DomainProperties.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. 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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

Nome Descrição Valor
groupIds GroupIds do recurso do serviço de ligação privada. cadeia[]
privateEndpoint O recurso ponto final privado para esta Ligação. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da ligação. ConnectionState
provisioningState Estado de aprovisionamento da Ligação de Ponto Final Privado. "Cancelado"
"A criar"
"A eliminar"
"Falha"
"Bem-sucedido"
"A atualizar"

PrivateEndpoint

Nome Descrição Valor
ID O identificador do ARM para o Ponto Final Privado. string

ConnectionState

Nome Descrição Valor
actionsRequired Ações necessárias (se existirem). string
descrição Descrição do estado da ligação. string
status Estado da ligação. "Aprovado"
"Desligado"
"Pendente"
"Rejeitado"

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"

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-04-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "Allow"
          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"
    }
  })
}

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

domínios

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/domains@2020-04-01-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 domínio. ResourceSku
identidade Informações de identidade do recurso. IdentityInfo
propriedades Propriedades do domínio. DomainProperties

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 reservada para utilização futura.
 Matriz de IDs de identidade de 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

DomainProperties

Nome Descrição Valor
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 eventos de entrada publicados no domínio. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Informações sobre o InputSchemaMapping que especificou as informações sobre o payload de eventos de mapeamento. InputSchemaMapping
privateEndpointConnections Lista de ligações de pontos finais privados. PrivateEndpointConnection[]
publicNetworkAccess Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado.
Pode restringir-se ainda mais a IPs específicos ao configurar {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

Nome Descrição Valor
groupIds GroupIds do recurso do serviço de ligação privada. cadeia[]
privateEndpoint O recurso ponto final privado para esta Ligação. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da ligação. ConnectionState
provisioningState Estado de aprovisionamento da Ligação de Ponto Final Privado. "Cancelado"
"Criar"
"A eliminar"
"Falha"
"Com êxito"
"A atualizar"

PrivateEndpoint

Nome Descrição Valor
ID O identificador do ARM para o Ponto Final Privado. string

ConnectionState

Nome Descrição Valor
actionsRequired Ações necessárias (se existirem). string
descrição Descrição do estado da ligação. string
status Estado da ligação. "Aprovado"
"Desligado"
"Pendente"
"Rejeitado"

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"