Compartir a través de


Dominios de Microsoft.EventGrid 2020-10-15-preview

Definición de recursos de Bicep

El tipo de recurso domains se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.EventGrid/domains, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.EventGrid/domains@2020-10-15-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
    }
    publicNetworkAccess: 'string'
  }
}

Objetos InputSchemaMapping

Establezca la propiedad inputSchemaMappingType para especificar el 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 propiedad

domains

Nombre Descripción Value
name El nombre del recurso string (obligatorio)

Límite de caracteres: 3-50

Caracteres válidos:
Caracteres alfanuméricos y guiones.
ubicación Ubicación del recurso. string (obligatorio)
etiquetas Etiquetas del recurso. Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku Plan de tarifa de SKU para el dominio. ResourceSku
identidad Información de identidad del recurso. IdentityInfo
properties Propiedades del dominio. DomainProperties

IdentityInfo

Nombre Descripción Valor
principalId Identificador de entidad de seguridad de la identidad de recurso. string
tenantId Identificador de inquilino del recurso. string
type Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad. 'Ninguno'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propiedad no se usa actualmente y está reservada para uso futuro.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} UserIdentityProperties

UserIdentityProperties

Nombre Descripción Valor
clientId Identificador de cliente de la identidad asignada por el usuario. string
principalId Identificador principal de la identidad asignada por el usuario. string

DomainProperties

Nombre Descripción Valor
inboundIpRules Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado. InboundIpRule[]
inputSchema Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el dominio. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Información sobre InputSchemaMapping que especificó la información sobre la carga del evento de asignación. InputSchemaMapping
publicNetworkAccess Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.
Para restringir aún más a direcciones IP específicas, configure {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /}
'Deshabilitado'
'Habilitado'

InboundIpRule

Nombre Descripción Valor
action Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask. 'Permitir'
ipMask Dirección IP en notación CIDR, por ejemplo, 10.0.0.0/8. string

InputSchemaMapping

Nombre Descripción Valor
inputSchemaMappingType Establecimiento del tipo de objeto Json (obligatorio)

JsonInputSchemaMapping

Nombre Descripción Valor
inputSchemaMappingType Tipo de la asignación personalizada 'Json' (obligatorio)
properties Propiedades JSON de la asignación de esquemas de entrada JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nombre Descripción Valor
dataVersion Información de asignación de la propiedad DataVersion del evento de Event Grid. JsonFieldWithDefault
eventTime Información de asignación de la propiedad EventTime del evento de Event Grid. JsonField
eventType Información de asignación de la propiedad EventType del evento de Event Grid. JsonFieldWithDefault
id Información de asignación de la propiedad Id del evento de Event Grid. JsonField
subject Información de asignación de la propiedad Subject del evento de Event Grid. JsonFieldWithDefault
topic Información de asignación de la propiedad Topic del evento de Event Grid. JsonField

JsonFieldWithDefault

Nombre Descripción Valor
defaultValue Valor predeterminado que se va a usar para la asignación cuando no se proporciona un SourceField o si no hay ninguna propiedad con el nombre especificado en la carga del evento JSON publicado. string
sourceField Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación. string

JsonField

Nombre Descripción Valor
sourceField Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación. string

ResourceSku

Nombre Descripción Value
name Nombre de SKU del recurso. Los valores posibles son: Básico o Premium. 'Básico'
'Premium'

Definición de recursos de plantilla de ARM

El tipo de recurso domains se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.EventGrid/domains, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.EventGrid/domains",
  "apiVersion": "2020-10-15-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
    },
    "publicNetworkAccess": "string"
  }
}

Objetos InputSchemaMapping

Establezca la propiedad inputSchemaMappingType para especificar el 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 propiedad

domains

Nombre Descripción Value
type Tipo de recurso 'Microsoft.EventGrid/domains'
apiVersion La versión de la API de recursos "2020-10-15-preview"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 3-50

Caracteres válidos:
Caracteres alfanuméricos y guiones.
ubicación Ubicación del recurso. string (obligatorio)
etiquetas Etiquetas del recurso. Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku Plan de tarifa de SKU para el dominio. ResourceSku
identidad Información de identidad del recurso. IdentityInfo
properties Propiedades del dominio. DomainProperties

IdentityInfo

Nombre Descripción Valor
principalId Identificador de entidad de seguridad de la identidad de recurso. string
tenantId Identificador de inquilino del recurso. string
type Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad. 'Ninguno'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propiedad no se usa actualmente y está reservada para uso futuro.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} UserIdentityProperties

UserIdentityProperties

Nombre Descripción Valor
clientId Identificador de cliente de la identidad asignada por el usuario. string
principalId Identificador principal de la identidad asignada por el usuario. string

DomainProperties

Nombre Descripción Valor
inboundIpRules Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado. InboundIpRule[]
inputSchema Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el dominio. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Información sobre InputSchemaMapping que especificó la información sobre la carga del evento de asignación. InputSchemaMapping
publicNetworkAccess Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.
Para restringir aún más a direcciones IP específicas, configure {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /}
'Deshabilitado'
'Habilitado'

InboundIpRule

Nombre Descripción Valor
action Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask. 'Permitir'
ipMask Dirección IP en notación CIDR, por ejemplo, 10.0.0.0/8. string

InputSchemaMapping

Nombre Descripción Valor
inputSchemaMappingType Establecimiento del tipo de objeto Json (obligatorio)

JsonInputSchemaMapping

Nombre Descripción Valor
inputSchemaMappingType Tipo de la asignación personalizada 'Json' (obligatorio)
properties Propiedades JSON de la asignación de esquemas de entrada JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nombre Descripción Valor
dataVersion Información de asignación de la propiedad DataVersion del evento de Event Grid. JsonFieldWithDefault
eventTime Información de asignación de la propiedad EventTime del evento de Event Grid. JsonField
eventType Información de asignación de la propiedad EventType del evento de Event Grid. JsonFieldWithDefault
id Información de asignación de la propiedad Id del evento de Event Grid. JsonField
subject Información de asignación de la propiedad Subject del evento de Event Grid. JsonFieldWithDefault
topic Información de asignación de la propiedad Topic del evento de Event Grid. JsonField

JsonFieldWithDefault

Nombre Descripción Valor
defaultValue Valor predeterminado que se va a usar para la asignación cuando no se proporciona un SourceField o si no hay ninguna propiedad con el nombre especificado en la carga del evento JSON publicado. string
sourceField Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación. string

JsonField

Nombre Descripción Valor
sourceField Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación. string

ResourceSku

Nombre Descripción Value
name Nombre de SKU del recurso. Los valores posibles son: Básico o Premium. 'Básico'
'Premium'

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso domains se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.EventGrid/domains, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-10-15-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
      }
      publicNetworkAccess = "string"
    }
    sku = {
      name = "string"
    }
  })
}

Objetos InputSchemaMapping

Establezca la propiedad inputSchemaMappingType para especificar el 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 propiedad

domains

Nombre Descripción Value
type Tipo de recurso "Microsoft.EventGrid/domains@2020-10-15-preview"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 3-50

Caracteres válidos:
Caracteres alfanuméricos y guiones.
ubicación Ubicación del recurso. string (obligatorio)
parent_id Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos. string (obligatorio)
etiquetas Etiquetas del recurso. Diccionario de nombres y valores de etiqueta.
sku Plan de tarifa de SKU para el dominio. ResourceSku
identidad Información de identidad del recurso. IdentityInfo
properties Propiedades del dominio. DomainProperties

IdentityInfo

Nombre Descripción Value
type Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recursos de ARM con el formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Actualmente, esta propiedad no se usa ni se reserva para su uso futuro.
Matriz de identificadores de identidad de usuario.

IdentityInfoUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} UserIdentityProperties

UserIdentityProperties

Nombre Descripción Valor
clientId Identificador de cliente de la identidad asignada por el usuario. string
principalId Identificador de entidad de seguridad de la identidad asignada por el usuario. string

DomainProperties

Nombre Descripción Valor
inboundIpRules Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado. InboundIpRule[]
inputSchema Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el dominio. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Información sobre inputSchemaMapping que especificó la información sobre la carga del evento de asignación. InputSchemaMapping
publicNetworkAccess Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.
Puede restringir aún más a direcciones IP específicas configurando {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /}
"Deshabilitado"
"Habilitado"

InboundIpRule

Nombre Descripción Valor
action Acción que se va a realizar en función de la coincidencia o de ninguna coincidencia de IpMask. "Permitir"
ipMask Dirección IP en notación CIDR, por ejemplo, 10.0.0.0/8. string

InputSchemaMapping

Nombre Descripción Valor
inputSchemaMappingType Establecimiento del tipo de objeto Json (obligatorio)

JsonInputSchemaMapping

Nombre Descripción Valor
inputSchemaMappingType Tipo de la asignación personalizada "Json" (obligatorio)
properties Propiedades JSON de la asignación de esquemas de entrada JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nombre Descripción Valor
dataVersion La información de asignación de la propiedad DataVersion del evento de Event Grid. JsonFieldWithDefault
eventTime Información de asignación de la propiedad EventTime del evento de Event Grid. JsonField
eventType Información de asignación de la propiedad EventType del evento de Event Grid. JsonFieldWithDefault
id Información de asignación de la propiedad Id del evento de Event Grid. JsonField
subject Información de asignación de la propiedad Subject del evento de Event Grid. JsonFieldWithDefault
topic Información de asignación de la propiedad Topic del evento de Event Grid. JsonField

JsonFieldWithDefault

Nombre Descripción Valor
defaultValue Valor predeterminado que se va a usar para la asignación cuando no se proporciona un SourceField o si no hay ninguna propiedad con el nombre especificado en la carga del evento JSON publicado. string
sourceField Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación. string

JsonField

Nombre Descripción Valor
sourceField Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación. string

ResourceSku

Nombre Descripción Value
name Nombre de SKU del recurso. Los valores posibles son: Básico o Premium. "Básica"
"Premium"