Domains - Create Or Update
Créer ou mettre à jour un domaine.
Crée ou met à jour de manière asynchrone un nouveau domaine avec les paramètres spécifiés.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2022-06-15
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
domain
|
path | True |
string |
Nom du domaine. |
resource
|
path | True |
string |
Nom du groupe de ressources dans l’abonnement de l’utilisateur. |
subscription
|
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 pour 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 |
Informations d’identité pour la ressource de domaine Event Grid. |
||
properties.autoCreateTopicWithFirstSubscription |
boolean |
Ce booléen est utilisé pour spécifier le mécanisme de création pour « toutes » les 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 true) ou autogéré (quand false). La valeur par défaut de cette propriété est True. Lorsque cette propriété est null ou définie sur true, Event Grid est responsable de la création automatique de la rubrique de domaine lorsque le premier abonnement aux événements est créé dans l’étendue de la rubrique de domaine. Si cette propriété a la valeur false, la création du premier abonnement aux événements nécessite la création d’une rubrique de domaine par l’utilisateur. Le mode autogestion peut être utilisé si l’utilisateur souhaite contrôler entièrement le moment de création de la rubrique de domaine, 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 géré automatiquement, l’utilisateur est autorisé à créer la rubrique de domaine à la demande si nécessaire. |
|
properties.autoDeleteTopicWithLastSubscription |
boolean |
Ce booléen est utilisé pour spécifier le mécanisme de suppression pour « toutes » les 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 (quand true) ou autogéré (quand 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 aux événements dans 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 quand elle n’est plus nécessaire (par exemple, lorsque le dernier abonnement aux événements est supprimé et que la ressource doit être nettoyée). Le mode autogestion 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 flexibilité nécessaire pour effectuer moins d’opérations et gérer moins de ressources par l’utilisateur. |
|
properties.dataResidencyBoundary |
Data Residency limite 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 dans le domaine. |
|
properties.inboundIpRules |
Cela peut être utilisé pour limiter le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles sont prises en compte uniquement si PublicNetworkAccess est activé. |
||
properties.inputSchema |
Cela détermine le format attendu par Event Grid pour les événements entrants publiés sur la ressource de domaine Event Grid. |
||
properties.inputSchemaMapping | InputSchemaMapping: |
Informations sur l’inputSchemaMapping qui a spécifié les informations sur la charge utile de l’événement de mappage. |
|
properties.publicNetworkAccess |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant |
||
tags |
object |
Balises de la ressource. |
Réponses
Nom | Type | Description |
---|---|---|
201 Created |
Date de création |
|
Other Status Codes |
Réponses d’erreur : ***
|
Exemples
Domains_CreateOrUpdate
Exemple de requête
PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1?api-version=2022-06-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
{
"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 |
---|---|
Connection |
Informations ConnectionState. |
created |
Type d’identité qui a créé la ressource. |
Data |
Data Residency limite de la ressource. |
Domain |
Domaine EventGrid. |
Domain |
État d’approvisionnement de la ressource de domaine Event Grid. |
Identity |
Informations d’identité pour la ressource. |
Identity |
Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité implicitement créée et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. |
Inbound |
|
Input |
Cela détermine le format attendu par Event Grid pour les événements entrants publiés sur la ressource de domaine Event Grid. |
Ip |
Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’IpMask. |
Json |
Il est utilisé pour 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. Il est actuellement utilisé dans les mappages pour les propriétés « id », « topic » et « eventtime ». Cela représente un champ dans le schéma d’événement d’entrée. |
Json |
Il est utilisé pour 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. Il 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 avec une valeur par défaut à utiliser, et au moins une de ces deux propriétés doit être fournie. |
Json |
Cela permet la publication dans 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ée au schéma d’événements Event Grid. |
Persisted |
État de la connexion. |
Private |
Informations PrivateEndpoint. |
Private |
|
Public |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant |
Resource |
État d’approvisionnement de la connexion de point de terminaison privé. |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
User |
Informations sur l’identité de l’utilisateur. |
ConnectionState
Informations ConnectionState.
Nom | Type | Description |
---|---|---|
actionsRequired |
string |
Actions requises (le cas échéant). |
description |
string |
Description de l’état de la connexion. |
status |
État de la connexion. |
createdByType
Type d’identité qui a créé la ressource.
Nom | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency limite de la ressource.
Nom | Type | Description |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
Domain
Domaine EventGrid.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
id |
string |
Identificateur complet de la ressource. |
|
identity |
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 |
Ce booléen est utilisé pour spécifier le mécanisme de création pour « toutes » les 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 true) ou autogéré (quand false). La valeur par défaut de cette propriété est True. Lorsque cette propriété est null ou définie sur true, Event Grid est responsable de la création automatique de la rubrique de domaine lorsque le premier abonnement aux événements est créé dans l’étendue de la rubrique de domaine. Si cette propriété a la valeur false, la création du premier abonnement aux événements nécessite la création d’une rubrique de domaine par l’utilisateur. Le mode autogestion peut être utilisé si l’utilisateur souhaite contrôler entièrement le moment de création de la rubrique de domaine, 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 géré automatiquement, l’utilisateur est autorisé à créer la rubrique de domaine à la demande si nécessaire. |
properties.autoDeleteTopicWithLastSubscription |
boolean |
True |
Ce booléen est utilisé pour spécifier le mécanisme de suppression pour « toutes » les 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 (quand true) ou autogéré (quand 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 aux événements dans 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 quand elle n’est plus nécessaire (par exemple, lorsque le dernier abonnement aux événements est supprimé et que la ressource doit être nettoyée). Le mode autogestion 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 flexibilité nécessaire pour effectuer moins d’opérations et gérer moins de ressources par l’utilisateur. |
properties.dataResidencyBoundary |
Data Residency limite 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 dans le domaine. |
properties.endpoint |
string |
Point de terminaison de la ressource de domaine Event Grid qui est utilisée pour la publication des événements. |
|
properties.inboundIpRules |
Cela peut être utilisé pour limiter le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles sont prises en compte uniquement si PublicNetworkAccess est activé. |
||
properties.inputSchema | EventGridSchema |
Cela détermine le format attendu par Event Grid pour les événements entrants publiés sur la ressource de domaine Event Grid. |
|
properties.inputSchemaMapping | InputSchemaMapping: |
Informations sur l’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.privateEndpointConnections |
Liste des connexions de point de terminaison privé. |
||
properties.provisioningState |
État d’approvisionnement de la ressource de domaine Event Grid. |
||
properties.publicNetworkAccess | Enabled |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant |
|
systemData |
Métadonnées système relatives à la ressource de domaine Event Grid. |
||
tags |
object |
Balises de la ressource. |
|
type |
string |
Type de la ressource. |
DomainProvisioningState
État d’approvisionnement de la ressource de domaine Event Grid.
Nom | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
IdentityInfo
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 |
Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité implicitement créée et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. |
|
userAssignedIdentities |
<string,
User |
Liste des identités d’utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». Cette propriété n’est actuellement pas utilisée et réservée pour une utilisation ultérieure. |
IdentityType
Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité implicitement créée et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité.
Nom | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Nom | Type | Description |
---|---|---|
action |
Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’IpMask. |
|
ipMask |
string |
Adresse IP dans la notation CIDR, par exemple, 10.0.0.0/8. |
InputSchema
Cela détermine le format attendu par Event Grid pour les événements entrants publiés sur la ressource de domaine Event Grid.
Nom | Type | Description |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’IpMask.
Nom | Type | Description |
---|---|---|
Allow |
string |
JsonField
Il est utilisé pour 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. Il est actuellement utilisé dans les mappages pour les propriétés « id », « topic » et « eventtime ». Cela représente 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 qui doit être utilisé comme source d’un mappage. |
JsonFieldWithDefault
Il est utilisé pour 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. Il 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 avec une valeur par défaut à utiliser, et au moins 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é avec le nom spécifié dans la charge utile de l’événement JSON publié. |
sourceField |
string |
Nom d’un champ dans le schéma d’événement d’entrée qui doit être utilisé comme source d’un mappage. |
JsonInputSchemaMapping
Cela permet la publication dans 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ée au schéma d’événements Event Grid.
Nom | Type | Description |
---|---|---|
inputSchemaMappingType |
string:
Json |
Type du mappage personnalisé |
properties.dataVersion |
Informations de mappage pour la propriété DataVersion de l’événement Event Grid. |
|
properties.eventTime |
Informations de mappage pour la propriété EventTime de l’événement Event Grid. |
|
properties.eventType |
Informations de mappage pour la propriété EventType de l’événement Event Grid. |
|
properties.id |
Informations de mappage pour la propriété Id de l’événement Event Grid. |
|
properties.subject |
Informations de mappage pour la propriété Subject de l’événement Event Grid. |
|
properties.topic |
Informations de mappage pour la propriété Topic de l’événement Event Grid. |
PersistedConnectionStatus
État de la connexion.
Nom | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
Informations PrivateEndpoint.
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur ARM pour le point de terminaison privé. |
PrivateEndpointConnection
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 |
Ressource de point de terminaison privé pour cette connexion. |
|
properties.privateLinkServiceConnectionState |
Détails sur l’état de la connexion. |
|
properties.provisioningState |
État d’approvisionnement de la connexion de point de terminaison privé. |
|
type |
string |
Type de la ressource. |
PublicNetworkAccess
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
État d’approvisionnement de la connexion de point de terminaison privé.
Nom | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
systemData
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 |
Type d’identité qui a créé la ressource. |
|
lastModifiedAt |
string |
Horodatage de la dernière modification de la ressource (UTC) |
lastModifiedBy |
string |
Identité qui a modifié la dernière ressource. |
lastModifiedByType |
Type d’identité qui a modifié la dernière ressource. |
UserIdentityProperties
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. |