Condividi tramite


Domini Microsoft.EventGrid 2020-04-01-preview

Definizione di risorsa Bicep

Il tipo di risorsa domini può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.EventGrid/domini, aggiungere il modello Bicep seguente.

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'
  }
}

Oggetti InputSchemaMapping

Impostare la proprietà inputSchemaMappingType per specificare il tipo di oggetto.

Per Json, usare:

  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'
    }
  }

Valori delle proprietà

domains

Nome Descrizione valore
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 3-50

Caratteri validi:
Caratteri alfanumerici e trattini.
posizione Posizione della risorsa. stringa (obbligatoria)
tags Tag della risorsa. Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
sku Piano tariffario sku per il dominio. ResourceSku
identity Informazioni sull'identità per la risorsa. IdentityInfo
properties Proprietà del dominio. DomainProperties

IdentityInfo

Nome Descrizione Valore
principalId ID principale dell'identità della risorsa. string
TenantId ID tenant della risorsa. string
type Tipo di identità gestita usata. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà qualsiasi identità. 'Nessuno'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno id risorsa ARM nel formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Questa proprietà attualmente non viene usata e riservata per l'utilizzo futuro.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} UserIdentityProperties

UserIdentityProperties

Nome Descrizione Valore
clientId ID client dell'identità assegnata dall'utente. string
principalId ID principale dell'identità assegnata dall'utente. string

DomainProperties

Nome Descrizione Valore
inboundIpRules Questa operazione può essere usata per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato. InboundIpRule[]
inputSchema Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nel dominio. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informazioni su InputSchemaMapping che ha specificato le informazioni sul payload dell'evento di mapping. InputSchemaMapping
privateEndpointConnections Elenco di connessioni di endpoint privato. PrivateEndpointConnection[]
publicNetworkAccess Ciò determina se il traffico è consentito sulla rete pubblica. Per impostazione predefinita, è abilitata.
È possibile limitare ulteriormente gli indirizzi IP specifici configurando {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /}
'Disabilitato'
'Enabled'

InboundIpRule

Nome Descrizione Valore
azione Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask. 'Consenti'
ipMask Indirizzo IP nella notazione CIDR, ad esempio 10.0.0.0/8. string

InputSchemaMapping

Nome Descrizione Valore
inputSchemaMappingType Impostare il tipo di oggetto Json (obbligatorio)

JsonInputSchemaMapping

Nome Descrizione Valore
inputSchemaMappingType Tipo di mapping personalizzato 'Json' (obbligatorio)
properties Proprietà JSON del mapping dello schema di input JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nome Descrizione Valore
dataVersion Informazioni di mapping per la proprietà DataVersion dell'evento di Griglia di eventi. JsonFieldWithDefault
eventTime Informazioni di mapping per la proprietà EventTime dell'evento di Griglia di eventi. JsonField
eventType Informazioni di mapping per la proprietà EventType dell'evento di Griglia di eventi. JsonFieldWithDefault
id Informazioni di mapping per la proprietà Id dell'evento di Griglia di eventi. JsonField
subject Informazioni di mapping per la proprietà Subject dell'evento di Griglia di eventi. JsonFieldWithDefault
argomento Informazioni di mapping per la proprietà Topic dell'evento di Griglia di eventi. JsonField

JsonFieldWithDefault

Nome Descrizione Valore
defaultValue Valore predefinito da usare per il mapping quando un oggetto SourceField non viene specificato o se non è presente alcuna proprietà con il nome specificato nel payload dell'evento JSON pubblicato. string
sourceField Nome di un campo nello schema degli eventi di input da usare come origine di un mapping. string

JsonField

Nome Descrizione Valore
sourceField Nome di un campo nello schema degli eventi di input da usare come origine di un mapping. string

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrizione Valore
groupIds GroupIds dalla risorsa del servizio di collegamento privato. string[]
privateEndpoint Risorsa endpoint privato per la connessione. PrivateEndpoint
privateLinkServiceConnectionState Dettagli sullo stato della connessione. ConnectionState
provisioningState Stato di provisioning della connessione dell'endpoint privato. 'Annullata'
'Creating'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'

PrivateEndpoint

Nome Descrizione Valore
id Identificatore arm per endpoint privato. string

ConnectionState

Nome Descrizione Valore
actionsRequired Azioni necessarie (se presenti). string
description Descrizione dello stato della connessione. string
status Stato della connessione. 'Approvato'
'Disconnesso'
'In sospeso'
'Rifiutato'

ResourceSku

Nome Descrizione valore
name Nome sku della risorsa. I valori possibili sono: Basic o Premium. 'Basic'
'Premium'

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa dei domini può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.EventGrid/domains, aggiungere il codice JSON seguente al modello.

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

Oggetti InputSchemaMapping

Impostare la proprietà inputSchemaMappingType per specificare il tipo di oggetto.

Per Json, usare:

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

Valori delle proprietà

domains

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.EventGrid/domains'
apiVersion Versione dell'API della risorsa '2020-04-01-preview'
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 3-50

Caratteri validi:
Caratteri alfanumerici e trattini.
posizione Posizione della risorsa. stringa (obbligatorio)
tags Tag della risorsa. Dizionario di nomi e valori di tag. Vedere Tag nei modelli
sku Piano tariffario SKU per il dominio. ResourceSku
identity Informazioni sull'identità per la risorsa. IdentityInfo
properties Proprietà del dominio. DomainProperties

IdentityInfo

Nome Descrizione Valore
principalId ID principale dell'identità della risorsa. string
TenantId ID tenant della risorsa. string
type Tipo di identità gestita usata. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà qualsiasi identità. 'Nessuno'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Questa proprietà non è attualmente utilizzata e riservata per l'utilizzo futuro.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} UserIdentityProperties

UserIdentityProperties

Nome Descrizione Valore
clientId ID client dell'identità assegnata dall'utente. string
principalId ID principale dell'identità assegnata dall'utente. string

DomainProperties

Nome Descrizione Valore
inboundIpRules Questa opzione può essere usata per limitare il traffico da indirizzi IP specifici anziché da tutti gli indirizzi IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato. InboundIpRule[]
inputSchema Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nel dominio. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informazioni su InputSchemaMapping che ha specificato le informazioni sul payload dell'evento di mapping. InputSchemaMapping
privateEndpointConnections Elenco di connessioni di endpoint privato. PrivateEndpointConnection[]
publicNetworkAccess Ciò determina se il traffico è consentito sulla rete pubblica. Per impostazione predefinita, è abilitata.
È possibile limitare ulteriormente gli indirizzi IP specifici configurando {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /}
'Disabilitato'
'Enabled'

InboundIpRule

Nome Descrizione Valore
azione Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask. 'Consenti'
ipMask Indirizzo IP nella notazione CIDR, ad esempio 10.0.0.0/8. string

InputSchemaMapping

Nome Descrizione Valore
inputSchemaMappingType Impostare il tipo di oggetto Json (obbligatorio)

JsonInputSchemaMapping

Nome Descrizione Valore
inputSchemaMappingType Tipo di mapping personalizzato 'Json' (obbligatorio)
properties Proprietà JSON del mapping dello schema di input JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nome Descrizione Valore
dataVersion Informazioni di mapping per la proprietà DataVersion dell'evento di Griglia di eventi. JsonFieldWithDefault
eventTime Informazioni di mapping per la proprietà EventTime dell'evento di Griglia di eventi. JsonField
eventType Informazioni di mapping per la proprietà EventType dell'evento di Griglia di eventi. JsonFieldWithDefault
id Informazioni di mapping per la proprietà Id dell'evento di Griglia di eventi. JsonField
subject Informazioni di mapping per la proprietà Subject dell'evento di Griglia di eventi. JsonFieldWithDefault
argomento Informazioni di mapping per la proprietà Topic dell'evento di Griglia di eventi. JsonField

JsonFieldWithDefault

Nome Descrizione Valore
defaultValue Valore predefinito da usare per il mapping quando un oggetto SourceField non viene specificato o se non è presente alcuna proprietà con il nome specificato nel payload dell'evento JSON pubblicato. string
sourceField Nome di un campo nello schema degli eventi di input da usare come origine di un mapping. string

JsonField

Nome Descrizione Valore
sourceField Nome di un campo nello schema degli eventi di input da usare come origine di un mapping. string

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrizione Valore
groupIds GroupIds dalla risorsa del servizio di collegamento privato. string[]
privateEndpoint Risorsa endpoint privato per la connessione. PrivateEndpoint
privateLinkServiceConnectionState Dettagli sullo stato della connessione. ConnectionState
provisioningState Stato di provisioning della connessione dell'endpoint privato. 'Annullata'
'Creating'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'

PrivateEndpoint

Nome Descrizione Valore
id Identificatore arm per endpoint privato. string

ConnectionState

Nome Descrizione Valore
actionsRequired Azioni necessarie (se presenti). string
description Descrizione dello stato della connessione. string
status Stato della connessione. 'Approvato'
'Disconnesso'
'In sospeso'
'Rifiutato'

ResourceSku

Nome Descrizione valore
name Nome sku della risorsa. I valori possibili sono: Basic o Premium. 'Basic'
'Premium'

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa dei domini può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.EventGrid/domains, aggiungere il codice Terraform seguente al modello.

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"
    }
  })
}

Oggetti InputSchemaMapping

Impostare la proprietà inputSchemaMappingType per specificare il tipo di oggetto.

Per Json, usare:

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

Valori delle proprietà

domains

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.EventGrid/domains@2020-04-01-preview"
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 3-50

Caratteri validi:
Caratteri alfanumerici e trattini.
posizione Posizione della risorsa. stringa (obbligatoria)
parent_id Per distribuire in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatoria)
tags Tag della risorsa. Dizionario dei nomi e dei valori dei tag.
sku Piano tariffario sku per il dominio. ResourceSku
identity Informazioni sull'identità per la risorsa. IdentityInfo
properties Proprietà del dominio. DomainProperties

IdentityInfo

Nome Descrizione Valore
tipo Tipo di identità gestita usata. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà qualsiasi identità. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno id risorsa ARM nel formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Questa proprietà attualmente non viene usata e riservata per l'utilizzo futuro.
Matrice di ID identità utente.

IdentityInfoUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} UserIdentityProperties

UserIdentityProperties

Nome Descrizione Valore
clientId ID client dell'identità assegnata dall'utente. string
principalId ID principale dell'identità assegnata dall'utente. string

DomainProperties

Nome Descrizione Valore
inboundIpRules Questa operazione può essere usata per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato. InboundIpRule[]
inputSchema Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nel dominio. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Informazioni su InputSchemaMapping che ha specificato le informazioni sul payload dell'evento di mapping. InputSchemaMapping
privateEndpointConnections Elenco delle connessioni endpoint private. PrivateEndpointConnection[]
publicNetworkAccess Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata.
È possibile limitare ulteriormente gli INDIRIZZI IP specifici configurando {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /}
"Disabilitato"
"Abilitato"

InboundIpRule

Nome Descrizione Valore
azione Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask. "Consenti"
ipMask Indirizzo IP nella notazione CIDR, ad esempio 10.0.0.0.0/8. string

InputSchemaMapping

Nome Descrizione Valore
inputSchemaMappingType Impostare il tipo di oggetto Json (obbligatorio)

JsonInputSchemaMapping

Nome Descrizione Valore
inputSchemaMappingType Tipo del mapping personalizzato "Json" (obbligatorio)
properties Proprietà JSON del mapping dello schema di input JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nome Descrizione Valore
dataVersion Informazioni di mapping per la proprietà DataVersion dell'evento Griglia di eventi. JsonFieldWithDefault
eventTime Informazioni di mapping per la proprietà EventTime dell'evento Griglia di eventi. JsonField
eventType Informazioni di mapping per la proprietà EventType dell'evento Griglia di eventi. JsonFieldWithDefault
id Informazioni di mapping per la proprietà Id dell'evento Griglia di eventi. JsonField
subject Informazioni di mapping per la proprietà Subject dell'evento Griglia di eventi. JsonFieldWithDefault
argomento Informazioni di mapping per la proprietà Topic dell'evento Griglia di eventi. JsonField

JsonFieldWithDefault

Nome Descrizione Valore
defaultValue Valore predefinito da utilizzare per il mapping quando un oggetto SourceField non viene fornito o se non è presente alcuna proprietà con il nome specificato nel payload dell'evento JSON pubblicato. string
sourceField Nome di un campo nello schema dell'evento di input da usare come origine di un mapping. string

JsonField

Nome Descrizione Valore
sourceField Nome di un campo nello schema dell'evento di input da usare come origine di un mapping. string

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà dell'oggetto PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrizione Valore
groupIds GroupIds dalla risorsa del servizio di collegamento privato. string[]
privateEndpoint Risorsa endpoint privato per questa connessione. PrivateEndpoint
privateLinkServiceConnectionState Dettagli sullo stato della connessione. ConnectionState
provisioningState Stato di provisioning della connessione endpoint privato. "Annullata"
"Creazione"
"Eliminazione"
"Non riuscito"
"Riuscito"
"Aggiornamento"

PrivateEndpoint

Nome Descrizione Valore
id Identificatore arm per endpoint privato. string

ConnectionState

Nome Descrizione Valore
actionsRequired Azioni necessarie (se presenti). string
description Descrizione dello stato della connessione. string
status Stato della connessione. "Approvato"
"Disconnesso"
"In sospeso"
"Rifiutato"

ResourceSku

Nome Descrizione valore
name Nome sku della risorsa. I valori possibili sono: Basic o Premium. "Basic"
"Premium"