Domains - Create Or Update
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=2022-06-15
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
domain
|
path | True |
string |
Nome del dominio. |
resource
|
path | True |
string |
Nome del gruppo di risorse all'interno della sottoscrizione dell'utente. |
subscription
|
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 di 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 |
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 "tutti" gli argomenti del dominio di Griglia di eventi associati 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 di 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 anche che, in modalità di creazione gestita automaticamente, l'utente può creare l'argomento di dominio su richiesta, se necessario. |
|
properties.autoDeleteTopicWithLastSubscription |
boolean |
Questo valore booleano viene usato per specificare il meccanismo di eliminazione per "tutti" gli argomenti del dominio di Griglia di eventi associati a questa risorsa di dominio di Griglia di eventi. In questo contesto, l'eliminazione dell'argomento di dominio può essere gestita automaticamente (se true) o autogestito (se false). Il valore predefinito di 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 di 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 auto-gestione può essere usata se l'utente vuole controllare completamente 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 |
Data Residency Limite 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.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. |
||
properties.inputSchema |
Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nella risorsa di dominio di Griglia di eventi. |
||
properties.inputSchemaMapping | InputSchemaMapping: |
Informazioni su InputSchemaMapping che ha specificato le informazioni sul payload dell'evento di mapping. |
|
properties.publicNetworkAccess |
Ciò determina se il traffico è consentito sulla 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 |
Data di creazione |
|
Other Status Codes |
Risposte di errore:
|
Esempio
Domains_CreateOrUpdate
Esempio di richiesta
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"
}
]
}
}
Risposta di esempio
{
"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 |
---|---|
Connection |
Informazioni di ConnectionState. |
created |
Tipo di identità che ha creato la risorsa. |
Data |
Data Residency Limite della risorsa. |
Domain |
Dominio EventGrid. |
Domain |
Stato di provisioning della risorsa di dominio griglia di eventi. |
Identity |
Informazioni sull'identità per la risorsa. |
Identity |
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à. |
Inbound |
|
Input |
Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nella risorsa di dominio griglia di eventi. |
Ip |
Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask. |
Json |
Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema eventi griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'id', 'topic' e 'eventtime'. Questo rappresenta un campo nello schema dell'evento di input. |
Json |
Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema eventi griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'subject', 'eventtype' e 'dataversion'. Questo rappresenta un campo nello schema dell'evento di input insieme a un valore predefinito da usare e almeno una di queste due proprietà deve essere fornita. |
Json |
Ciò consente la pubblicazione in Griglia di eventi usando uno schema di input personalizzato. Questa operazione può essere usata per eseguire il mapping delle proprietà da uno schema JSON di input personalizzato allo schema di eventi griglia di eventi. |
Persisted |
Stato della connessione. |
Private |
Informazioni privateEndpoint. |
Private |
|
Public |
Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli INDIRIZZI IP specifici configurando |
Resource |
Stato di provisioning della connessione endpoint privato. |
system |
Metadati relativi alla creazione e all'ultima modifica della risorsa. |
User |
Informazioni sull'identità utente. |
ConnectionState
Informazioni di ConnectionState.
Nome | Tipo | Descrizione |
---|---|---|
actionsRequired |
string |
Azioni necessarie (se presenti). |
description |
string |
Descrizione dello stato della connessione. |
status |
Stato della connessione. |
createdByType
Tipo di identità che ha creato la risorsa.
Nome | Tipo | Descrizione |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency Limite della risorsa.
Nome | Tipo | Descrizione |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
Domain
Dominio EventGrid.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
id |
string |
Identificatore completo della risorsa. |
|
identity |
Informazioni sull'identità per la risorsa dominio 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 "tutti" gli argomenti del dominio griglia di eventi associati a questa risorsa di dominio griglia di eventi. In questo contesto, la creazione di un argomento di dominio può essere gestita automaticamente (quando true) o self-managed (quando false). Il valore predefinito di 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 evento nell'ambito dell'argomento di dominio. Se questa proprietà è impostata su false, la creazione della prima sottoscrizione evento richiederà la creazione di un argomento di dominio da parte dell'utente. La modalità self-management può essere usata se l'utente vuole controllare completamente quando viene creato l'argomento del dominio, mentre la modalità gestita automaticamente offre la flessibilità per eseguire meno operazioni e gestire meno risorse dall'utente. Si noti anche che in modalità di creazione gestita automaticamente, l'utente può creare l'argomento di dominio su richiesta se necessario. |
properties.autoDeleteTopicWithLastSubscription |
boolean |
True |
Questo valore booleano viene usato per specificare il meccanismo di eliminazione per "tutti" gli argomenti del dominio griglia di eventi associati a questa risorsa di dominio griglia di eventi. In questo contesto, l'eliminazione dell'argomento di dominio può essere gestita automaticamente (quando true) o self-managed (quando false). Il valore predefinito di questa proprietà è True. Quando questa proprietà è impostata su true, Griglia di eventi è responsabile dell'eliminazione automatica dell'argomento di dominio quando l'ultima sottoscrizione evento nell'ambito dell'argomento di dominio viene eliminata. Se questa proprietà è impostata su false, l'utente deve eliminare manualmente l'argomento del dominio quando non è più necessario , ad esempio quando l'ultima sottoscrizione evento viene eliminata e la risorsa deve essere pulita. La modalità di gestione automatica può essere usata se l'utente vuole controllare completamente quando l'argomento del dominio deve essere eliminato, mentre la modalità gestita automaticamente offre la flessibilità per eseguire meno operazioni e gestire meno risorse dall'utente. |
properties.dataResidencyBoundary |
Data Residency Limite 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 griglia di eventi usata per la pubblicazione degli eventi. |
|
properties.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. |
||
properties.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: |
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 griglia di eventi. |
|
properties.privateEndpointConnections |
Elenco delle connessioni endpoint private. |
||
properties.provisioningState |
Stato di provisioning della risorsa di dominio griglia di eventi. |
||
properties.publicNetworkAccess | Enabled |
Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli INDIRIZZI IP specifici configurando |
|
systemData |
Metadati di sistema relativi alla risorsa dominio griglia di eventi. |
||
tags |
object |
Tag della risorsa. |
|
type |
string |
Tipo di risorsa. |
DomainProvisioningState
Stato di provisioning della risorsa di dominio griglia di eventi.
Nome | Tipo | Descrizione |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
IdentityInfo
Informazioni sull'identità per la risorsa.
Nome | Tipo | Descrizione |
---|---|---|
principalId |
string |
ID principale dell'identità della risorsa. |
tenantId |
string |
ID tenant della risorsa. |
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à. |
|
userAssignedIdentities |
<string,
User |
Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel modulo: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Questa proprietà attualmente non viene usata e riservata per l'utilizzo futuro. |
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à.
Nome | Tipo | Descrizione |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Nome | Tipo | Descrizione |
---|---|---|
action |
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.0/8. |
InputSchema
Questo determina il formato previsto da Griglia di eventi per gli eventi in ingresso pubblicati nella risorsa di dominio griglia di eventi.
Nome | Tipo | Descrizione |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.
Nome | Tipo | Descrizione |
---|---|---|
Allow |
string |
JsonField
Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema eventi griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'id', 'topic' e 'eventtime'. Questo rappresenta un campo nello schema dell'evento di input.
Nome | Tipo | Descrizione |
---|---|---|
sourceField |
string |
Nome di un campo nello schema dell'evento di input da usare come origine di un mapping. |
JsonFieldWithDefault
Viene usato per esprimere l'origine di un mapping dello schema di input per un singolo campo di destinazione nello schema eventi griglia di eventi. Attualmente viene usato nei mapping per le proprietà 'subject', 'eventtype' e 'dataversion'. Questo rappresenta un campo nello schema dell'evento di input insieme a un valore predefinito da usare e almeno una di queste due proprietà deve essere fornita.
Nome | Tipo | Descrizione |
---|---|---|
defaultValue |
string |
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. |
sourceField |
string |
Nome di un campo nello schema degli eventi di input da usare come origine di un mapping. |
JsonInputSchemaMapping
Ciò consente la pubblicazione in Griglia di eventi usando uno schema di input personalizzato. Questa operazione può essere usata per eseguire il mapping delle proprietà da uno schema JSON di input personalizzato allo schema di eventi griglia di eventi.
Nome | Tipo | Descrizione |
---|---|---|
inputSchemaMappingType |
string:
Json |
Tipo del mapping personalizzato |
properties.dataVersion |
Informazioni di mapping per la proprietà DataVersion dell'evento Griglia di eventi. |
|
properties.eventTime |
Informazioni di mapping per la proprietà EventTime dell'evento Griglia di eventi. |
|
properties.eventType |
Informazioni di mapping per la proprietà EventType dell'evento Griglia di eventi. |
|
properties.id |
Informazioni di mapping per la proprietà Id dell'evento Griglia di eventi. |
|
properties.subject |
Informazioni di mapping per la proprietà Subject dell'evento Griglia di eventi. |
|
properties.topic |
Informazioni di mapping per la proprietà Topic dell'evento Griglia di eventi. |
PersistedConnectionStatus
Stato della connessione.
Nome | Tipo | Descrizione |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
Informazioni privateEndpoint.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore arm per endpoint privato. |
PrivateEndpointConnection
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 |
Risorsa endpoint privato per questa connessione. |
|
properties.privateLinkServiceConnectionState |
Dettagli sullo stato della connessione. |
|
properties.provisioningState |
Stato di provisioning della connessione endpoint privato. |
|
type |
string |
Tipo di risorsa. |
PublicNetworkAccess
Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli INDIRIZZI IP specifici configurando
Nome | Tipo | Descrizione |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
Stato di provisioning della connessione endpoint privato.
Nome | Tipo | Descrizione |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
systemData
Metadati relativi alla creazione e all'ultima modifica della risorsa.
Nome | Tipo | Descrizione |
---|---|---|
createdAt |
string |
Timestamp della creazione di risorse (UTC). |
createdBy |
string |
Identità che ha creato la risorsa. |
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 risorsa. |
lastModifiedByType |
Tipo di identità che ha modificato l'ultima risorsa. |
UserIdentityProperties
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. |