Partager via

Domaines Microsoft.EventGrid 2020-10-15-preview

  • Article

Définition de ressource Bicep

Le type de ressource de domaines peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.EventGrid/domains, ajoutez le bicep suivant à votre modèle.

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

Objets InputSchemaMapping

Définissez la propriété inputSchemaMappingType pour spécifier le type d’objet.

Pour Json, utilisez :

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

Valeurs de propriété

DomainProperties

Nom Description Valeur
inboundIpRules Cela peut être utilisé pour restreindre le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles ne sont prises en compte que si PublicNetworkAccess est activé. InboundIpRule []
inputSchema Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans le domaine. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informations sur InputSchemaMapping qui a spécifié les informations sur la charge utile de l’événement de mappage. InputSchemaMapping
publicNetworkAccess Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.
Vous pouvez restreindre davantage les adresses IP spécifiques en configurant <seealso cref="P :Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules » />		 'Désactivé'
'Activé'

IdentityInfo

Nom Description Valeur
principalId ID principal de l’identité de ressource. corde
tenantId ID de locataire de la ressource. corde
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM sous la forme suivante :
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Cette propriété n’est actuellement pas utilisée et réservée à une utilisation ultérieure.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nom Description Valeur

InboundIpRule

Nom Description Valeur
action Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’objet IpMask. 'Autoriser'
ipMask Adresse IP dans la notation CIDR, par exemple, 10.0.0.0/8. corde

InputSchemaMapping

Nom Description Valeur
inputSchemaMappingType Défini sur « Json » pour le type JsonInputSchemaMapping. 'Json' (obligatoire)

JsonField

Nom Description Valeur
sourceField Nom d’un champ dans le schéma d’événement d’entrée à utiliser comme source d’un mappage. corde

JsonFieldWithDefault

Nom Description Valeur
defaultValue Valeur par défaut à utiliser pour le mappage lorsqu’un Champ source n’est pas fourni ou s’il n’existe aucune propriété portant le nom spécifié dans la charge utile d’événement JSON publiée. corde
sourceField Nom d’un champ dans le schéma d’événement d’entrée à utiliser comme source d’un mappage. corde

JsonInputSchemaMapping

Nom Description Valeur
inputSchemaMappingType Type du mappage personnalisé 'Json' (obligatoire)
Propriétés Propriétés JSON du mappage de schéma d’entrée JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nom Description Valeur
dataVersion Informations de mappage pour la propriété DataVersion de l’événement Event Grid. JsonFieldWithDefault
eventTime Informations de mappage pour la propriété EventTime de l’événement Event Grid. jsonField
eventType Informations de mappage pour la propriété EventType de l’événement Event Grid. JsonFieldWithDefault
id Informations de mappage pour la propriété ID de l’événement Event Grid. jsonField
Objet Informations de mappage pour la propriété Objet de l’événement Event Grid. JsonFieldWithDefault
sujet Informations de mappage pour la propriété Topic de l’événement Event Grid. jsonField

Microsoft.EventGrid/domains

Nom Description Valeur
identité Informations d’identité pour la ressource. IdentityInfo
emplacement Emplacement de la ressource. chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du domaine. DomainProperties
Sku Niveau tarifaire de référence SKU pour le domaine. ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceSku

Nom Description Valeur
nom Nom de la référence SKU de la ressource. Les valeurs possibles sont : De base ou Premium. 'De base'
'Premium'

TrackedResourceTags

Nom Description Valeur

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. corde
principalId ID principal de l’identité affectée par l’utilisateur. corde

Définition de ressource de modèle ARM

Le type de ressource de domaines peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.EventGrid/domains, ajoutez le code JSON suivant à votre modèle.

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

Objets InputSchemaMapping

Définissez la propriété inputSchemaMappingType pour spécifier le type d’objet.

Pour Json, utilisez :

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

Valeurs de propriété

DomainProperties

Nom Description Valeur
inboundIpRules Cela peut être utilisé pour restreindre le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles ne sont prises en compte que si PublicNetworkAccess est activé. InboundIpRule []
inputSchema Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans le domaine. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informations sur InputSchemaMapping qui a spécifié les informations sur la charge utile de l’événement de mappage. InputSchemaMapping
publicNetworkAccess Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.
Vous pouvez restreindre davantage les adresses IP spécifiques en configurant <seealso cref="P :Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules » />		 'Désactivé'
'Activé'

IdentityInfo

Nom Description Valeur
principalId ID principal de l’identité de ressource. corde
tenantId ID de locataire de la ressource. corde
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM sous la forme suivante :
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Cette propriété n’est actuellement pas utilisée et réservée à une utilisation ultérieure.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nom Description Valeur

InboundIpRule

Nom Description Valeur
action Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’objet IpMask. 'Autoriser'
ipMask Adresse IP dans la notation CIDR, par exemple, 10.0.0.0/8. corde

InputSchemaMapping

Nom Description Valeur
inputSchemaMappingType Défini sur « Json » pour le type JsonInputSchemaMapping. 'Json' (obligatoire)

JsonField

Nom Description Valeur
sourceField Nom d’un champ dans le schéma d’événement d’entrée à utiliser comme source d’un mappage. corde

JsonFieldWithDefault

Nom Description Valeur
defaultValue Valeur par défaut à utiliser pour le mappage lorsqu’un Champ source n’est pas fourni ou s’il n’existe aucune propriété portant le nom spécifié dans la charge utile d’événement JSON publiée. corde
sourceField Nom d’un champ dans le schéma d’événement d’entrée à utiliser comme source d’un mappage. corde

JsonInputSchemaMapping

Nom Description Valeur
inputSchemaMappingType Type du mappage personnalisé 'Json' (obligatoire)
Propriétés Propriétés JSON du mappage de schéma d’entrée JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nom Description Valeur
dataVersion Informations de mappage pour la propriété DataVersion de l’événement Event Grid. JsonFieldWithDefault
eventTime Informations de mappage pour la propriété EventTime de l’événement Event Grid. jsonField
eventType Informations de mappage pour la propriété EventType de l’événement Event Grid. JsonFieldWithDefault
id Informations de mappage pour la propriété ID de l’événement Event Grid. jsonField
Objet Informations de mappage pour la propriété Objet de l’événement Event Grid. JsonFieldWithDefault
sujet Informations de mappage pour la propriété Topic de l’événement Event Grid. jsonField

Microsoft.EventGrid/domains

Nom Description Valeur
apiVersion Version de l’API '2020-10-15-preview'
identité Informations d’identité pour la ressource. IdentityInfo
emplacement Emplacement de la ressource. chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du domaine. DomainProperties
Sku Niveau tarifaire de référence SKU pour le domaine. ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.EventGrid/domains'

ResourceSku

Nom Description Valeur
nom Nom de la référence SKU de la ressource. Les valeurs possibles sont : De base ou Premium. 'De base'
'Premium'

TrackedResourceTags

Nom Description Valeur

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. corde
principalId ID principal de l’identité affectée par l’utilisateur. corde

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource de domaines peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.EventGrid/domains, ajoutez terraform suivant à votre modèle.

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

Objets InputSchemaMapping

Définissez la propriété inputSchemaMappingType pour spécifier le type d’objet.

Pour Json, utilisez :

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

Valeurs de propriété

DomainProperties

Nom Description Valeur
inboundIpRules Cela peut être utilisé pour restreindre le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles ne sont prises en compte que si PublicNetworkAccess est activé. InboundIpRule []
inputSchema Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans le domaine. 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informations sur InputSchemaMapping qui a spécifié les informations sur la charge utile de l’événement de mappage. InputSchemaMapping
publicNetworkAccess Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.
Vous pouvez restreindre davantage les adresses IP spécifiques en configurant <seealso cref="P :Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules » />		 'Désactivé'
'Activé'

IdentityInfo

Nom Description Valeur
principalId ID principal de l’identité de ressource. corde
tenantId ID de locataire de la ressource. corde
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM sous la forme suivante :
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Cette propriété n’est actuellement pas utilisée et réservée à une utilisation ultérieure.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nom Description Valeur

InboundIpRule

Nom Description Valeur
action Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’objet IpMask. 'Autoriser'
ipMask Adresse IP dans la notation CIDR, par exemple, 10.0.0.0/8. corde

InputSchemaMapping

Nom Description Valeur
inputSchemaMappingType Défini sur « Json » pour le type JsonInputSchemaMapping. 'Json' (obligatoire)

JsonField

Nom Description Valeur
sourceField Nom d’un champ dans le schéma d’événement d’entrée à utiliser comme source d’un mappage. corde

JsonFieldWithDefault

Nom Description Valeur
defaultValue Valeur par défaut à utiliser pour le mappage lorsqu’un Champ source n’est pas fourni ou s’il n’existe aucune propriété portant le nom spécifié dans la charge utile d’événement JSON publiée. corde
sourceField Nom d’un champ dans le schéma d’événement d’entrée à utiliser comme source d’un mappage. corde

JsonInputSchemaMapping

Nom Description Valeur
inputSchemaMappingType Type du mappage personnalisé 'Json' (obligatoire)
Propriétés Propriétés JSON du mappage de schéma d’entrée JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Nom Description Valeur
dataVersion Informations de mappage pour la propriété DataVersion de l’événement Event Grid. JsonFieldWithDefault
eventTime Informations de mappage pour la propriété EventTime de l’événement Event Grid. jsonField
eventType Informations de mappage pour la propriété EventType de l’événement Event Grid. JsonFieldWithDefault
id Informations de mappage pour la propriété ID de l’événement Event Grid. jsonField
Objet Informations de mappage pour la propriété Objet de l’événement Event Grid. JsonFieldWithDefault
sujet Informations de mappage pour la propriété Topic de l’événement Event Grid. jsonField

Microsoft.EventGrid/domains

Nom Description Valeur
identité Informations d’identité pour la ressource. IdentityInfo
emplacement Emplacement de la ressource. chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du domaine. DomainProperties
Sku Niveau tarifaire de référence SKU pour le domaine. ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.EventGrid/domains@2020-10-15-preview »

ResourceSku

Nom Description Valeur
nom Nom de la référence SKU de la ressource. Les valeurs possibles sont : De base ou Premium. 'De base'
'Premium'

TrackedResourceTags

Nom Description Valeur

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. corde
principalId ID principal de l’identité affectée par l’utilisateur. corde