Domains - Create Or Update

Riferimento

Servizio:: Event Grid

Versione API:: 2025-02-15

Creare o aggiornare un dominio.
Crea o aggiorna in modo asincrono un nuovo dominio con i parametri specificati.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
domainName	path	True	string	Nome del dominio.
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione dell'utente.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione della risorsa.
identity		IdentityInfo	Informazioni sull'identità per la risorsa dominio di Griglia di eventi.
properties.autoCreateTopicWithFirstSubscription		boolean	Questo valore booleano viene usato per specificare il meccanismo di creazione per 'all' argomenti del dominio di Griglia di eventi associato a questa risorsa di dominio di Griglia di eventi. In questo contesto, la creazione di un argomento di dominio può essere gestita automaticamente (se true) o autogestito (se false). Il valore predefinito per questa proprietà è true. Quando questa proprietà è null o impostata su true, Griglia di eventi è responsabile della creazione automatica dell'argomento di dominio quando viene creata la prima sottoscrizione di eventi nell'ambito dell'argomento del dominio. Se questa proprietà è impostata su false, la creazione della prima sottoscrizione di eventi richiederà la creazione di un argomento di dominio da parte dell'utente. La modalità di gestione automatica può essere usata se l'utente vuole il controllo completo di quando viene creato l'argomento del dominio, mentre la modalità gestita automaticamente offre la flessibilità necessaria per eseguire meno operazioni e gestire meno risorse da parte dell'utente. Si noti inoltre che in modalità di creazione gestita automaticamente, l'utente può creare l'argomento del dominio su richiesta, se necessario.
properties.autoDeleteTopicWithLastSubscription		boolean	Questo valore booleano viene usato per specificare il meccanismo di eliminazione per 'all' argomenti del dominio di Griglia di eventi associato a questa risorsa di dominio di Griglia di eventi. In questo contesto, l'eliminazione dell'argomento del dominio può essere gestita automaticamente (se true) o autogestito (se false). Il valore predefinito per questa proprietà è true. Quando questa proprietà è impostata su true, Griglia di eventi è responsabile dell'eliminazione automatica dell'argomento del dominio quando viene eliminata l'ultima sottoscrizione di eventi nell'ambito dell'argomento del dominio. Se questa proprietà è impostata su false, l'utente deve eliminare manualmente l'argomento del dominio quando non è più necessario ( ad esempio, quando viene eliminata l'ultima sottoscrizione di eventi e la risorsa deve essere pulita). La modalità di gestione automatica può essere usata se l'utente vuole il controllo completo di quando l'argomento del dominio deve essere eliminato, mentre la modalità gestita automaticamente offre la flessibilità necessaria per eseguire meno operazioni e gestire meno risorse da parte dell'utente.
properties.dataResidencyBoundary		DataResidencyBoundary	Limite di residenza dei dati della risorsa.
properties.disableLocalAuth		boolean	Questo valore booleano viene usato per abilitare o disabilitare l'autenticazione locale. Il valore predefinito è false. Quando la proprietà è impostata su true, verrà usato solo il token AAD per l'autenticazione se l'utente è autorizzato a pubblicare nel dominio.
properties.eventTypeInfo		EventTypeInfo	Informazioni sul tipo di evento per il dominio. Queste informazioni vengono fornite dal server di pubblicazione e possono essere utilizzate dal sottoscrittore per visualizzare diversi tipi di eventi pubblicati.
properties.inboundIpRules		InboundIpRule[]	Può essere usato per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato.
properties.inputSchema		InputSchema	Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nella risorsa di dominio griglia di eventi.
properties.inputSchemaMapping		InputSchemaMapping: JsonInputSchemaMapping	Informazioni su InputSchemaMapping che ha specificato le informazioni sul payload dell'evento di mapping.
properties.minimumTlsVersionAllowed		TlsVersion	Versione minima TLS del server di pubblicazione consentita per la pubblicazione in questo dominio
properties.publicNetworkAccess		PublicNetworkAccess	Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando
tags		object	Tag della risorsa.

Risposte

Nome	Tipo	Descrizione
201 Created	Domain	Creato
Other Status Codes		Risposte di errore: 400 Richiesta non valida. 500 Errore interno del server.

Nome

Tipo

Descrizione

201 Created

Domain

Creato

Other Status Codes

Risposte di errore:

400 Richiesta non valida.
500 Errore interno del server.

Esempio

Domains_CreateOrUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Definizioni

Nome	Descrizione
ConnectionState	Informazioni di ConnectionState.
createdByType	Tipo di identità che ha creato la risorsa.
DataResidencyBoundary	Limite di residenza dei dati della risorsa.
Domain	Dominio EventGrid.
DomainProvisioningState	Stato di provisioning della risorsa di dominio di Griglia di eventi.
EventDefinitionKind	Tipo di evento utilizzato.
EventTypeInfo	Informazioni sul tipo di evento per Canali.
IdentityInfo	Informazioni sull'identità per la risorsa.
IdentityType	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à.
InboundIpRule
InlineEventProperties	Informazioni aggiuntive su ogni evento inline.
InputSchema	Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nella risorsa di dominio griglia di eventi.
IpActionType	Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.
JsonField	Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema di eventi di Griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'id', 'topic' e 'eventtime'. Rappresenta un campo nello schema dell'evento di input.
JsonFieldWithDefault	Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema di eventi di Griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'subject', 'eventtype' e 'dataversion'. Rappresenta un campo nello schema dell'evento di input insieme a un valore predefinito da usare e deve essere fornita almeno una di queste due proprietà.
JsonInputSchemaMapping	Ciò consente la pubblicazione in Griglia di eventi usando uno schema di input personalizzato. Può essere usato per eseguire il mapping delle proprietà da uno schema JSON di input personalizzato allo schema di eventi di Griglia di eventi.
PersistedConnectionStatus	Stato della connessione.
PrivateEndpoint	Informazioni privateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando
ResourceProvisioningState	Stato di provisioning della connessione endpoint privato.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TlsVersion	Versione minima TLS del server di pubblicazione consentita per la pubblicazione in questo dominio
UserIdentityProperties	Informazioni sull'identità utente.

ConnectionState

Object

Informazioni di ConnectionState.

Nome	Tipo	Descrizione
actionsRequired	string	Azioni necessarie (se presenti).
description	string	Descrizione dello stato della connessione.
status	PersistedConnectionStatus	Stato della connessione.

createdByType

Enumeration

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Enumeration

Limite di residenza dei dati della risorsa.

Valore	Descrizione
WithinGeopair
WithinRegion

Domain

Object

Dominio EventGrid.

Nome	Tipo	Valore predefinito	Descrizione
id	string		Identificatore completo della risorsa.
identity	IdentityInfo		Informazioni sull'identità per la risorsa dominio di Griglia di eventi.
location	string		Posizione della risorsa.
name	string		Nome della risorsa.
properties.autoCreateTopicWithFirstSubscription	boolean	True	Questo valore booleano viene usato per specificare il meccanismo di creazione per 'all' argomenti del dominio di Griglia di eventi associato a questa risorsa di dominio di Griglia di eventi. In questo contesto, la creazione di un argomento di dominio può essere gestita automaticamente (se true) o autogestito (se false). Il valore predefinito per questa proprietà è true. Quando questa proprietà è null o impostata su true, Griglia di eventi è responsabile della creazione automatica dell'argomento di dominio quando viene creata la prima sottoscrizione di eventi nell'ambito dell'argomento del dominio. Se questa proprietà è impostata su false, la creazione della prima sottoscrizione di eventi richiederà la creazione di un argomento di dominio da parte dell'utente. La modalità di gestione automatica può essere usata se l'utente vuole il controllo completo di quando viene creato l'argomento del dominio, mentre la modalità gestita automaticamente offre la flessibilità necessaria per eseguire meno operazioni e gestire meno risorse da parte dell'utente. Si noti inoltre che in modalità di creazione gestita automaticamente, l'utente può creare l'argomento del dominio su richiesta, se necessario.
properties.autoDeleteTopicWithLastSubscription	boolean	True	Questo valore booleano viene usato per specificare il meccanismo di eliminazione per 'all' argomenti del dominio di Griglia di eventi associato a questa risorsa di dominio di Griglia di eventi. In questo contesto, l'eliminazione dell'argomento del dominio può essere gestita automaticamente (se true) o autogestito (se false). Il valore predefinito per questa proprietà è true. Quando questa proprietà è impostata su true, Griglia di eventi è responsabile dell'eliminazione automatica dell'argomento del dominio quando viene eliminata l'ultima sottoscrizione di eventi nell'ambito dell'argomento del dominio. Se questa proprietà è impostata su false, l'utente deve eliminare manualmente l'argomento del dominio quando non è più necessario ( ad esempio, quando viene eliminata l'ultima sottoscrizione di eventi e la risorsa deve essere pulita). La modalità di gestione automatica può essere usata se l'utente vuole il controllo completo di quando l'argomento del dominio deve essere eliminato, mentre la modalità gestita automaticamente offre la flessibilità necessaria per eseguire meno operazioni e gestire meno risorse da parte dell'utente.
properties.dataResidencyBoundary	DataResidencyBoundary		Limite di residenza dei dati della risorsa.
properties.disableLocalAuth	boolean	False	Questo valore booleano viene usato per abilitare o disabilitare l'autenticazione locale. Il valore predefinito è false. Quando la proprietà è impostata su true, verrà usato solo il token AAD per l'autenticazione se l'utente è autorizzato a pubblicare nel dominio.
properties.endpoint	string		Endpoint per la risorsa di dominio di Griglia di eventi usata per la pubblicazione degli eventi.
properties.eventTypeInfo	EventTypeInfo		Informazioni sul tipo di evento per il dominio. Queste informazioni vengono fornite dal server di pubblicazione e possono essere utilizzate dal sottoscrittore per visualizzare diversi tipi di eventi pubblicati.
properties.inboundIpRules	InboundIpRule[]		Può essere usato per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato.
properties.inputSchema	InputSchema	EventGridSchema	Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nella risorsa di dominio griglia di eventi.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Informazioni su InputSchemaMapping che ha specificato le informazioni sul payload dell'evento di mapping.
properties.metricResourceId	string		ID risorsa metrica per la risorsa di dominio di Griglia di eventi.
properties.minimumTlsVersionAllowed	TlsVersion		Versione minima TLS del server di pubblicazione consentita per la pubblicazione in questo dominio
properties.privateEndpointConnections	PrivateEndpointConnection[]		Elenco delle connessioni endpoint private.
properties.provisioningState	DomainProvisioningState		Stato di provisioning della risorsa di dominio di Griglia di eventi.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando
systemData	systemData		Metadati di sistema relativi alla risorsa griglia di eventi.
tags	object		Tag della risorsa.
type	string		Tipo della risorsa.

DomainProvisioningState

Enumeration

Stato di provisioning della risorsa di dominio di Griglia di eventi.

Valore	Descrizione
Canceled
Creating
Deleting
Failed
Succeeded
Updating

EventDefinitionKind

Enumeration

Tipo di evento utilizzato.

Valore	Descrizione
Inline

EventTypeInfo

Object

Informazioni sul tipo di evento per Canali.

Nome	Tipo	Descrizione
inlineEventTypes	<string, InlineEventProperties>	Raccolta di tipi di evento inline per la risorsa. Le chiavi del tipo di evento inline sono di tipo string che rappresenta il nome dell'evento. Un esempio di nome di evento inline valido è "Contoso.OrderCreated". I valori del tipo di evento inline sono di tipo InlineEventProperties e conterranno informazioni aggiuntive per ogni tipo di evento inline.
kind	EventDefinitionKind	Tipo di evento utilizzato.

IdentityInfo

Object

Informazioni sull'identità per la risorsa.

Nome	Tipo	Descrizione
principalId	string	ID principale dell'identità della risorsa.
tenantId	string	ID tenant della risorsa.
type	IdentityType	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à.
userAssignedIdentities	<string, UserIdentityProperties>	Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle 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.

IdentityType

Enumeration

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

Valore	Descrizione
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

Nome	Tipo	Descrizione
action	IpActionType	Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.
ipMask	string	Indirizzo IP nella notazione CIDR, ad esempio 10.0.0.0/8.

InlineEventProperties

Object

Informazioni aggiuntive su ogni evento inline.

Nome	Tipo	Descrizione
dataSchemaUrl	string	DataSchemaUrl per l'evento inline.
description	string	Descrizione dell'evento inline.
displayName	string	DisplayName per l'evento inline.
documentationUrl	string	DocumentazioneUrl per l'evento inline.

InputSchema

Enumeration

Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nella risorsa di dominio griglia di eventi.

Valore	Descrizione
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Enumeration

Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.

Valore	Descrizione
Allow

JsonField

Object

Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema di eventi di Griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'id', 'topic' e 'eventtime'. Rappresenta un campo nello schema dell'evento di input.

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

JsonFieldWithDefault

Object

Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema di eventi di Griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'subject', 'eventtype' e 'dataversion'. Rappresenta un campo nello schema dell'evento di input insieme a un valore predefinito da usare e deve essere fornita almeno una di queste due proprietà.

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

JsonInputSchemaMapping

Object

Ciò consente la pubblicazione in Griglia di eventi usando uno schema di input personalizzato. Può essere usato per eseguire il mapping delle proprietà da uno schema JSON di input personalizzato allo schema di eventi di Griglia di eventi.

Nome	Tipo	Descrizione
inputSchemaMappingType	string: Json	Tipo del mapping personalizzato
properties.dataVersion	JsonFieldWithDefault	Informazioni di mapping per la proprietà DataVersion dell'evento di Griglia di eventi.
properties.eventTime	JsonField	Informazioni di mapping per la proprietà EventTime dell'evento di Griglia di eventi.
properties.eventType	JsonFieldWithDefault	Informazioni di mapping per la proprietà EventType dell'evento di Griglia di eventi.
properties.id	JsonField	Informazioni di mapping per la proprietà Id dell'evento di Griglia di eventi.
properties.subject	JsonFieldWithDefault	Informazioni di mapping per la proprietà Subject dell'evento di Griglia di eventi.
properties.topic	JsonField	Informazioni di mapping per la proprietà Topic dell'evento di Griglia di eventi.

PersistedConnectionStatus

Enumeration

Stato della connessione.

Valore	Descrizione
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

Informazioni privateEndpoint.

Nome	Tipo	Descrizione
id	string	Identificatore arm per endpoint privato.

PrivateEndpointConnection

Object

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa.
name	string	Nome della risorsa.
properties.groupIds	string[]	GroupIds dalla risorsa del servizio di collegamento privato.
properties.privateEndpoint	PrivateEndpoint	Risorsa endpoint privato per questa connessione.
properties.privateLinkServiceConnectionState	ConnectionState	Dettagli sullo stato della connessione.
properties.provisioningState	ResourceProvisioningState	Stato di provisioning della connessione endpoint privato.
type	string	Tipo della risorsa.

PublicNetworkAccess

Enumeration

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando

Valore	Descrizione
Disabled
Enabled

ResourceProvisioningState

Enumeration

Stato di provisioning della connessione endpoint privato.

Valore	Descrizione
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

TlsVersion

Enumeration

Versione minima TLS del server di pubblicazione consentita per la pubblicazione in questo dominio

Valore	Descrizione
1.0
1.1
1.2

UserIdentityProperties

Object

Informazioni sull'identità utente.

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

Condividi tramite

Domains - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Domains_CreateOrUpdate

Esempio di richiesta

Risposta di esempio

Definizioni

ConnectionState

createdByType

DataResidencyBoundary

Domain

DomainProvisioningState

EventDefinitionKind

EventTypeInfo

IdentityInfo

IdentityType

InboundIpRule

InlineEventProperties

InputSchema

IpActionType

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

PersistedConnectionStatus

PrivateEndpoint

PrivateEndpointConnection

PublicNetworkAccess

ResourceProvisioningState

systemData

TlsVersion

UserIdentityProperties

Risorse aggiuntive