Domains - Create Or Update

Référence

Service:: Event Grid

Version d'API:: 2025-02-15

Créez ou mettez à jour un domaine.
Crée ou met à jour de façon asynchrone un domaine avec les paramètres spécifiés.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2025-02-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
domainName	path	True	string	Nom du domaine.
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement de l’utilisateur.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement de la ressource.
identity		IdentityInfo	Informations d’identité pour la ressource de domaine Event Grid.
properties.autoCreateTopicWithFirstSubscription		boolean	Cette valeur booléenne permet de spécifier le mécanisme de création pour « all » des rubriques de domaine Event Grid associées à cette ressource de domaine Event Grid. Dans ce contexte, la création d’une rubrique de domaine peut être gérée automatiquement (quand la valeur est true) ou auto-gérée (quand la valeur est false). La valeur par défaut de cette propriété est true. Lorsque cette propriété a la valeur Null ou a la valeur True, Event Grid est responsable de la création automatique de la rubrique de domaine lorsque le premier abonnement d’événement est créé dans l’étendue de la rubrique de domaine. Si cette propriété a la valeur false, la création du premier abonnement d’événements nécessite la création d’une rubrique de domaine par l’utilisateur. Le mode de gestion automatique peut être utilisé si l’utilisateur souhaite contrôler entièrement le moment où la rubrique de domaine est créée, tandis que le mode géré automatiquement offre la possibilité d’effectuer moins d’opérations et de gérer moins de ressources par l’utilisateur. Notez également qu’en mode de création managée automatiquement, l’utilisateur est autorisé à créer la rubrique de domaine à la demande si nécessaire.
properties.autoDeleteTopicWithLastSubscription		boolean	Cette valeur booléenne permet de spécifier le mécanisme de suppression pour « all » des rubriques de domaine Event Grid associées à cette ressource de domaine Event Grid. Dans ce contexte, la suppression d’une rubrique de domaine peut être gérée automatiquement (lorsque la valeur est true) ou auto-gérée (lorsqu’elle est false). La valeur par défaut de cette propriété est true. Lorsque cette propriété a la valeur true, Event Grid est responsable de la suppression automatique de la rubrique de domaine lorsque le dernier abonnement d’événement à l’étendue de la rubrique de domaine est supprimé. Si cette propriété a la valeur false, l’utilisateur doit supprimer manuellement la rubrique de domaine lorsqu’elle n’est plus nécessaire (par exemple, quand l’abonnement à l’événement dernier est supprimé et que la ressource doit être nettoyée). Le mode de gestion automatique peut être utilisé si l’utilisateur souhaite contrôler entièrement le moment où la rubrique de domaine doit être supprimée, tandis que le mode géré automatiquement offre la possibilité d’effectuer moins d’opérations et de gérer moins de ressources par l’utilisateur.
properties.dataResidencyBoundary		DataResidencyBoundary	Limite de résidence des données de la ressource.
properties.disableLocalAuth		boolean	Cette valeur booléenne est utilisée pour activer ou désactiver l’authentification locale. La valeur par défaut est false. Lorsque la propriété a la valeur true, seul le jeton AAD est utilisé pour s’authentifier si l’utilisateur est autorisé à publier sur le domaine.
properties.eventTypeInfo		EventTypeInfo	Informations de type d’événement pour le domaine. Ces informations sont fournies par l’éditeur et peuvent être utilisées par l’abonné pour afficher différents types d’événements publiés.
properties.inboundIpRules		InboundIpRule[]	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é.
properties.inputSchema		InputSchema	Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans la ressource de domaine Event Grid.
properties.inputSchemaMapping		InputSchemaMapping: JsonInputSchemaMapping	Informations sur InputSchemaMapping qui a spécifié les informations sur la charge utile de l’événement de mappage.
properties.minimumTlsVersionAllowed		TlsVersion	Version TLS minimale du serveur de publication autorisée à publier sur ce domaine
properties.publicNetworkAccess		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
tags		object	Balises de la ressource.

Réponses

Nom	Type	Description
201 Created	Domain	Créé
Other Status Codes		Réponses d’erreur : *** 400 Demande incorrecte. Erreur de serveur interne 500.

Nom

Type

Description

201 Created

Domain

Créé

Other Status Codes

Réponses d’erreur : ***

400 Demande incorrecte.
Erreur de serveur interne 500.

Exemples

Domains_CreateOrUpdate

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1?api-version=2025-02-15

{
  "location": "westus2",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 201

{
  "properties": {
    "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1",
  "location": "westus2",
  "name": "exampledomain1",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/domains"
}

Définitions

Nom	Description
ConnectionState	Informations ConnectionState.
createdByType	Type d’identité qui a créé la ressource.
DataResidencyBoundary	Limite de résidence des données de la ressource.
Domain	Domaine EventGrid.
DomainProvisioningState	État d’approvisionnement de la ressource de domaine Event Grid.
EventDefinitionKind	Type d’événement utilisé.
EventTypeInfo	Informations sur le type d’événement pour les canaux.
IdentityInfo	Informations d’identité pour la ressource.
IdentityType	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é.
InboundIpRule
InlineEventProperties	Informations supplémentaires sur chaque événement inline.
InputSchema	Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans la ressource de domaine Event Grid.
IpActionType	Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’objet IpMask.
JsonField	Cela permet d’exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « id », « topic » et « eventtime ». Il s’agit d’un champ dans le schéma d’événement d’entrée.
JsonFieldWithDefault	Cela permet d’exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « subject », « eventtype » et « dataversion ». Cela représente un champ dans le schéma d’événement d’entrée, ainsi qu’une valeur par défaut à utiliser, et au moins l’une de ces deux propriétés doit être fournie.
JsonInputSchemaMapping	Cela permet de publier sur Event Grid à l’aide d’un schéma d’entrée personnalisé. Cela peut être utilisé pour mapper les propriétés d’un schéma JSON d’entrée personnalisé au schéma d’événement Event Grid.
PersistedConnectionStatus	État de la connexion.
PrivateEndpoint	Informations PrivateEndpoint.
PrivateEndpointConnection
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
ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TlsVersion	Version TLS minimale du serveur de publication autorisée à publier sur ce domaine
UserIdentityProperties	Informations sur l’identité de l’utilisateur.

ConnectionState

Object

Informations ConnectionState.

Nom	Type	Description
actionsRequired	string	Actions requises (le cas échéant).
description	string	Description de l’état de connexion.
status	PersistedConnectionStatus	État de la connexion.

createdByType

Enumeration

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Enumeration

Limite de résidence des données de la ressource.

Valeur	Description
WithinGeopair
WithinRegion

Domain

Object

Domaine EventGrid.

Nom	Type	Valeur par défaut	Description
id	string		Identificateur complet de la ressource.
identity	IdentityInfo		Informations d’identité pour la ressource de domaine Event Grid.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.autoCreateTopicWithFirstSubscription	boolean	True	Cette valeur booléenne permet de spécifier le mécanisme de création pour « all » des rubriques de domaine Event Grid associées à cette ressource de domaine Event Grid. Dans ce contexte, la création d’une rubrique de domaine peut être gérée automatiquement (quand la valeur est true) ou auto-gérée (quand la valeur est false). La valeur par défaut de cette propriété est true. Lorsque cette propriété a la valeur Null ou a la valeur True, Event Grid est responsable de la création automatique de la rubrique de domaine lorsque le premier abonnement d’événement est créé dans l’étendue de la rubrique de domaine. Si cette propriété a la valeur false, la création du premier abonnement d’événements nécessite la création d’une rubrique de domaine par l’utilisateur. Le mode de gestion automatique peut être utilisé si l’utilisateur souhaite contrôler entièrement le moment où la rubrique de domaine est créée, tandis que le mode géré automatiquement offre la possibilité d’effectuer moins d’opérations et de gérer moins de ressources par l’utilisateur. Notez également qu’en mode de création managée automatiquement, l’utilisateur est autorisé à créer la rubrique de domaine à la demande si nécessaire.
properties.autoDeleteTopicWithLastSubscription	boolean	True	Cette valeur booléenne permet de spécifier le mécanisme de suppression pour « all » des rubriques de domaine Event Grid associées à cette ressource de domaine Event Grid. Dans ce contexte, la suppression d’une rubrique de domaine peut être gérée automatiquement (lorsque la valeur est true) ou auto-gérée (lorsqu’elle est false). La valeur par défaut de cette propriété est true. Lorsque cette propriété a la valeur true, Event Grid est responsable de la suppression automatique de la rubrique de domaine lorsque le dernier abonnement d’événement à l’étendue de la rubrique de domaine est supprimé. Si cette propriété a la valeur false, l’utilisateur doit supprimer manuellement la rubrique de domaine lorsqu’elle n’est plus nécessaire (par exemple, quand l’abonnement à l’événement dernier est supprimé et que la ressource doit être nettoyée). Le mode de gestion automatique peut être utilisé si l’utilisateur souhaite contrôler entièrement le moment où la rubrique de domaine doit être supprimée, tandis que le mode géré automatiquement offre la possibilité d’effectuer moins d’opérations et de gérer moins de ressources par l’utilisateur.
properties.dataResidencyBoundary	DataResidencyBoundary		Limite de résidence des données de la ressource.
properties.disableLocalAuth	boolean	False	Cette valeur booléenne est utilisée pour activer ou désactiver l’authentification locale. La valeur par défaut est false. Lorsque la propriété a la valeur true, seul le jeton AAD est utilisé pour s’authentifier si l’utilisateur est autorisé à publier sur le domaine.
properties.endpoint	string		Point de terminaison pour la ressource de domaine Event Grid utilisée pour la publication des événements.
properties.eventTypeInfo	EventTypeInfo		Informations de type d’événement pour le domaine. Ces informations sont fournies par l’éditeur et peuvent être utilisées par l’abonné pour afficher différents types d’événements publiés.
properties.inboundIpRules	InboundIpRule[]		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é.
properties.inputSchema	InputSchema	EventGridSchema	Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans la ressource de domaine Event Grid.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Informations sur InputSchemaMapping qui a spécifié les informations sur la charge utile de l’événement de mappage.
properties.metricResourceId	string		ID de ressource de métrique pour la ressource de domaine Event Grid.
properties.minimumTlsVersionAllowed	TlsVersion		Version TLS minimale du serveur de publication autorisée à publier sur ce domaine
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste des connexions de point de terminaison privé.
properties.provisioningState	DomainProvisioningState		État d’approvisionnement de la ressource de domaine Event Grid.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	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
systemData	systemData		Métadonnées système relatives à la ressource Event Grid.
tags	object		Balises de la ressource.
type	string		Type de la ressource.

DomainProvisioningState

Enumeration

État d’approvisionnement de la ressource de domaine Event Grid.

Valeur	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

EventDefinitionKind

Enumeration

Type d’événement utilisé.

Valeur	Description
Inline

EventTypeInfo

Object

Informations sur le type d’événement pour les canaux.

Nom	Type	Description
inlineEventTypes	<string, InlineEventProperties>	Collection de types d’événements inline pour la ressource. Les clés de type d’événement inline sont de type chaîne qui représente le nom de l’événement. Un exemple de nom d’événement inline valide est « Contoso.OrderCreated ». Les valeurs de type d’événement inline sont de type InlineEventProperties et contiennent des informations supplémentaires pour chaque type d’événement inline.
kind	EventDefinitionKind	Type d’événement utilisé.

IdentityInfo

Object

Informations d’identité pour la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité de ressource.
tenantId	string	ID de locataire de la ressource.
type	IdentityType	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é.
userAssignedIdentities	<string, UserIdentityProperties>	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /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.

IdentityType

Enumeration

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é.

Valeur	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

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

InlineEventProperties

Object

Informations supplémentaires sur chaque événement inline.

Nom	Type	Description
dataSchemaUrl	string	DataSchemaUrl pour l’événement inline.
description	string	Description de l’événement inline.
displayName	string	DisplayName pour l’événement inline.
documentationUrl	string	DocumentationUrl de l’événement inline.

InputSchema

Enumeration

Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans la ressource de domaine Event Grid.

Valeur	Description
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Enumeration

Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’objet IpMask.

Valeur	Description
Allow

JsonField

Object

Cela permet d’exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « id », « topic » et « eventtime ». Il s’agit d’un champ dans le schéma d’événement d’entrée.

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

JsonFieldWithDefault

Object

Cela permet d’exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « subject », « eventtype » et « dataversion ». Cela représente un champ dans le schéma d’événement d’entrée, ainsi qu’une valeur par défaut à utiliser, et au moins l’une de ces deux propriétés doit être fournie.

Nom	Type	Description
defaultValue	string	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.
sourceField	string	Nom d’un champ dans le schéma d’événement d’entrée à utiliser comme source d’un mappage.

JsonInputSchemaMapping

Object

Cela permet de publier sur Event Grid à l’aide d’un schéma d’entrée personnalisé. Cela peut être utilisé pour mapper les propriétés d’un schéma JSON d’entrée personnalisé au schéma d’événement Event Grid.

Nom	Type	Description
inputSchemaMappingType	string: Json	Type du mappage personnalisé
properties.dataVersion	JsonFieldWithDefault	Informations de mappage pour la propriété DataVersion de l’événement Event Grid.
properties.eventTime	JsonField	Informations de mappage pour la propriété EventTime de l’événement Event Grid.
properties.eventType	JsonFieldWithDefault	Informations de mappage pour la propriété EventType de l’événement Event Grid.
properties.id	JsonField	Informations de mappage pour la propriété ID de l’événement Event Grid.
properties.subject	JsonFieldWithDefault	Informations de mappage pour la propriété Objet de l’événement Event Grid.
properties.topic	JsonField	Informations de mappage pour la propriété Topic de l’événement Event Grid.

PersistedConnectionStatus

Enumeration

État de la connexion.

Valeur	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

Informations PrivateEndpoint.

Nom	Type	Description
id	string	Identificateur ARM pour point de terminaison privé.

PrivateEndpointConnection

Object

Nom	Type	Description
id	string	Identificateur complet de la ressource.
name	string	Nom de la ressource.
properties.groupIds	string[]	GroupIds de la ressource de service private link.
properties.privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé pour cette connexion.
properties.privateLinkServiceConnectionState	ConnectionState	Détails sur l’état de la connexion.
properties.provisioningState	ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
type	string	Type de la ressource.

PublicNetworkAccess

Enumeration

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

Valeur	Description
Disabled
Enabled

ResourceProvisioningState

Enumeration

État d’approvisionnement de la connexion de point de terminaison privé.

Valeur	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TlsVersion

Enumeration

Version TLS minimale du serveur de publication autorisée à publier sur ce domaine

Valeur	Description
1.0
1.1
1.2

UserIdentityProperties

Object

Informations sur l’identité de l’utilisateur.

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

Partager via

Domains - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

Domains_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

ConnectionState

createdByType

DataResidencyBoundary

Domain

DomainProvisioningState

EventDefinitionKind

EventTypeInfo

IdentityInfo

IdentityType

InboundIpRule

InlineEventProperties

InputSchema

IpActionType

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

PersistedConnectionStatus

PrivateEndpoint

PrivateEndpointConnection

PublicNetworkAccess

ResourceProvisioningState

systemData

TlsVersion

UserIdentityProperties

Ressources supplémentaires