Domains - Create Or Update
Vytvoření nebo aktualizace domény
Asynchronně vytvoří nebo aktualizuje novou doménu se zadanými parametry.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2022-06-15
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
domain
|
path | True |
string |
Název domény. |
resource
|
path | True |
string |
Název skupiny prostředků v rámci předplatného uživatele. |
subscription
|
path | True |
string |
Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít s požadavkem klienta. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
location | True |
string |
Umístění prostředku. |
identity |
Informace o identitě prostředku domény Event Gridu |
||
properties.autoCreateTopicWithFirstSubscription |
boolean |
Tato logická hodnota se používá k určení mechanismu vytváření pro všechna témata domény Event Gridu přidružená k tomuto prostředku domény Event Gridu. V tomto kontextu může být vytváření tématu domény spravováno automaticky (pokud je pravda) nebo samospravované (pokud je false). Výchozí hodnota této vlastnosti je true. Pokud je tato vlastnost null nebo je nastavená na hodnotu true, event Grid zodpovídá za automatické vytvoření tématu domény při vytvoření prvního odběru události v oboru tématu domény. Pokud je tato vlastnost nastavená na hodnotu false, bude vytvoření prvního odběru události vyžadovat vytvoření tématu domény uživatelem. Režim samoobslužné správy lze použít, pokud uživatel chce mít úplnou kontrolu nad tím, kdy se téma domény vytvoří, zatímco režim automatické správy poskytuje flexibilitu pro provádění méně operací a správu méně prostředků uživatelem. Všimněte si také, že v režimu automatického spravovaného vytváření může uživatel v případě potřeby vytvořit téma domény na vyžádání. |
|
properties.autoDeleteTopicWithLastSubscription |
boolean |
Tato logická hodnota se používá k určení mechanismu odstranění pro všechna témata domény Event Gridu přidružená k tomuto prostředku domény Event Gridu. V tomto kontextu se odstranění tématu domény může spravovat automaticky (pokud je pravda) nebo samospravované (pokud je false). Výchozí hodnota této vlastnosti je true. Pokud je tato vlastnost nastavená na hodnotu true, zodpovídá Event Grid za automatické odstranění tématu domény při odstranění posledního odběru události v oboru tématu domény. Pokud je tato vlastnost nastavená na false, uživatel musí téma domény odstranit ručně, když už není potřeba (například když se odstraní poslední odběr události a prostředek je potřeba vyčistit). Režim samoobslužné správy lze použít, pokud uživatel chce mít úplnou kontrolu nad tím, kdy je potřeba odstranit téma domény, zatímco režim automatické správy poskytuje flexibilitu pro provádění méně operací a správu méně prostředků uživatelem. |
|
properties.dataResidencyBoundary |
Data Residency hranice prostředku. |
||
properties.disableLocalAuth |
boolean |
Tato logická hodnota se používá k povolení nebo zakázání místního ověřování. Výchozí hodnota je false. Pokud je vlastnost nastavená na hodnotu true, použije se k ověření pouze token AAD, pokud má uživatel povoleno publikovat do domény. |
|
properties.inboundIpRules |
Můžete ho použít k omezení provozu z konkrétních IP adres místo všech IP adres. Poznámka: Tyto možnosti jsou považovány pouze v případě, že je povolená technologie PublicNetworkAccess. |
||
properties.inputSchema |
Tím se určí formát, který má Event Grid očekávat u příchozích událostí publikovaných do prostředku domény event gridu. |
||
properties.inputSchemaMapping | InputSchemaMapping: |
Informace o objektu InputSchemaMapping, který určil informace o datové části události mapování. |
|
properties.publicNetworkAccess |
Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací |
||
tags |
object |
Značky prostředku. |
Odpovědi
Name | Typ | Description |
---|---|---|
201 Created |
Vytvořeno |
|
Other Status Codes |
Chybové odpovědi: ***
|
Příklady
Domains_CreateOrUpdate
Ukázkový požadavek
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"
}
]
}
}
Ukázková odpověď
{
"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"
}
Definice
Name | Description |
---|---|
Connection |
ConnectionState informace. |
created |
Typ identity, která prostředek vytvořila. |
Data |
Data Residency hranice prostředku. |
Domain |
Doména EventGrid. |
Domain |
Stav zřizování prostředku domény Event Gridu |
Identity |
Informace o identitě prostředku. |
Identity |
Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu. |
Inbound |
|
Input |
Určuje formát, který má Event Grid očekávat u příchozích událostí publikovaných do prostředku domény Event Gridu. |
Ip |
Akce, která se má provést na základě shody nebo žádné shody IpMask. |
Json |
Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností id, topic a eventtime. Představuje pole ve schématu vstupní události. |
Json |
Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností subject, eventtype a dataversion. Představuje pole ve schématu vstupní události spolu s výchozí hodnotou, která se má použít, a měla by být k dispozici alespoň jedna z těchto dvou vlastností. |
Json |
To umožňuje publikování do Event Gridu pomocí vlastního vstupního schématu. To se dá použít k mapování vlastností z vlastního vstupního schématu JSON na schéma událostí Event Gridu. |
Persisted |
Stav připojení. |
Private |
Informace o privátním koncovém bodu |
Private |
|
Public |
Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací |
Resource |
Stav zřizování připojení privátního koncového bodu. |
system |
Metadata týkající se vytvoření a poslední změny prostředku. |
User |
Informace o identitě uživatele. |
ConnectionState
ConnectionState informace.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Požadované akce (pokud nějaké jsou) |
description |
string |
Popis stavu připojení |
status |
Stav připojení. |
createdByType
Typ identity, která prostředek vytvořila.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency hranice prostředku.
Name | Typ | Description |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
Domain
Doména EventGrid.
Name | Typ | Default value | Description |
---|---|---|---|
id |
string |
Plně kvalifikovaný identifikátor prostředku. |
|
identity |
Informace o identitě prostředku domény Event Gridu |
||
location |
string |
Umístění prostředku. |
|
name |
string |
Název prostředku. |
|
properties.autoCreateTopicWithFirstSubscription |
boolean |
True |
Tato logická hodnota slouží k určení mechanismu vytváření pro všechna témata domény Event Gridu přidružená k tomuto prostředku domény Event Gridu. V tomto kontextu může být vytváření tématu domény spravováno automaticky (pokud je true) nebo samospravované (pokud je false). Výchozí hodnota této vlastnosti je true. Pokud má tato vlastnost hodnotu null nebo je nastavená na hodnotu true, služba Event Grid zodpovídá za automatické vytvoření tématu domény při vytvoření prvního odběru události v oboru tématu domény. Pokud je tato vlastnost nastavená na false, bude vytvoření prvního odběru události vyžadovat vytvoření tématu domény uživatelem. Režim samoobslužné správy lze použít, pokud uživatel chce mít plnou kontrolu nad tím, kdy se téma domény vytvoří, zatímco režim automatické správy poskytuje flexibilitu pro provádění menšího počtu operací a správu méně prostředků uživatelem. Upozorňujeme také, že v režimu automatického spravovaného vytváření může uživatel v případě potřeby vytvořit téma domény na vyžádání. |
properties.autoDeleteTopicWithLastSubscription |
boolean |
True |
Tato logická hodnota slouží k určení mechanismu odstranění pro všechna témata domény Event Gridu přidružená k tomuto prostředku domény Event Gridu. V tomto kontextu se odstranění tématu domény může spravovat automaticky (pokud je true) nebo samoobslužné (pokud je false). Výchozí hodnota této vlastnosti je true. Pokud je tato vlastnost nastavená na hodnotu true, služba Event Grid zodpovídá za automatické odstranění tématu domény při odstranění posledního odběru události v oboru tématu domény. Pokud je tato vlastnost nastavená na false, musí uživatel téma domény ručně odstranit, když už ho nepotřebujete (např. když se odstraní poslední odběr události a prostředek je potřeba vyčistit). Režim samoobslužné správy lze použít, pokud uživatel chce mít úplnou kontrolu nad tím, kdy je potřeba odstranit téma domény, zatímco režim automatické správy poskytuje flexibilitu pro provádění menšího počtu operací a správu menšího počtu prostředků uživatelem. |
properties.dataResidencyBoundary |
Data Residency hranice prostředku. |
||
properties.disableLocalAuth |
boolean |
False |
Tato logická hodnota se používá k povolení nebo zakázání místního ověřování. Výchozí hodnota je false. Pokud je vlastnost nastavená na hodnotu true, použije se k ověření pouze token AAD, pokud má uživatel povoleno publikovat do domény. |
properties.endpoint |
string |
Koncový bod pro prostředek domény Event Gridu, který se používá k publikování událostí. |
|
properties.inboundIpRules |
Můžete ho použít k omezení provozu z konkrétních IP adres místo ze všech IP adres. Poznámka: Tyto možnosti se považují pouze v případě, že je povolená technologie PublicNetworkAccess. |
||
properties.inputSchema | EventGridSchema |
Určuje formát, který má Event Grid očekávat u příchozích událostí publikovaných do prostředku domény Event Gridu. |
|
properties.inputSchemaMapping | InputSchemaMapping: |
Informace o InputSchemaMapping, která určila informace o datové části události mapování. |
|
properties.metricResourceId |
string |
ID prostředku metriky pro prostředek domény Event Gridu |
|
properties.privateEndpointConnections |
Seznam připojení privátních koncových bodů |
||
properties.provisioningState |
Stav zřizování prostředku domény Event Gridu |
||
properties.publicNetworkAccess | Enabled |
Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací |
|
systemData |
Systémová metadata související s prostředkem domény Event Gridu. |
||
tags |
object |
Značky prostředku. |
|
type |
string |
Typ prostředku. |
DomainProvisioningState
Stav zřizování prostředku domény Event Gridu
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
IdentityInfo
Informace o identitě prostředku.
Name | Typ | Description |
---|---|---|
principalId |
string |
ID objektu zabezpečení identity prostředku. |
tenantId |
string |
ID tenanta prostředku. |
type |
Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu. |
|
userAssignedIdentities |
<string,
User |
Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Tato vlastnost není aktuálně používána a rezervována pro budoucí použití. |
IdentityType
Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu.
Name | Typ | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Name | Typ | Description |
---|---|---|
action |
Akce, která se má provést na základě shody nebo žádné shody IpMask. |
|
ipMask |
string |
IP adresa v zápisu CIDR, například 10.0.0.0/8. |
InputSchema
Určuje formát, který má Event Grid očekávat u příchozích událostí publikovaných do prostředku domény Event Gridu.
Name | Typ | Description |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
Akce, která se má provést na základě shody nebo žádné shody IpMask.
Name | Typ | Description |
---|---|---|
Allow |
string |
JsonField
Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností id, topic a eventtime. Představuje pole ve schématu vstupní události.
Name | Typ | Description |
---|---|---|
sourceField |
string |
Název pole ve schématu vstupní události, které se má použít jako zdroj mapování. |
JsonFieldWithDefault
Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností subject, eventtype a dataversion. Představuje pole ve schématu vstupní události spolu s výchozí hodnotou, která se má použít, a měla by být k dispozici alespoň jedna z těchto dvou vlastností.
Name | Typ | Description |
---|---|---|
defaultValue |
string |
Výchozí hodnota, která se má použít pro mapování, když není k dispozici pole SourceField nebo pokud v datové části publikované události JSON není žádná vlastnost se zadaným názvem. |
sourceField |
string |
Název pole ve schématu vstupní události, které se má použít jako zdroj mapování. |
JsonInputSchemaMapping
To umožňuje publikování do Event Gridu pomocí vlastního vstupního schématu. To se dá použít k mapování vlastností z vlastního vstupního schématu JSON na schéma událostí Event Gridu.
Name | Typ | Description |
---|---|---|
inputSchemaMappingType |
string:
Json |
Typ vlastního mapování |
properties.dataVersion |
Informace o mapování pro vlastnost DataVersion události Event Grid. |
|
properties.eventTime |
Informace o mapování pro vlastnost EventTime události Event Gridu. |
|
properties.eventType |
Informace o mapování pro vlastnost EventType události event gridu. |
|
properties.id |
Informace o mapování pro vlastnost Id události Event Gridu. |
|
properties.subject |
Informace o mapování pro vlastnost Subject události Event Gridu. |
|
properties.topic |
Informace o mapování pro vlastnost Téma události Event Gridu. |
PersistedConnectionStatus
Stav připojení.
Name | Typ | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
Informace o privátním koncovém bodu
Name | Typ | Description |
---|---|---|
id |
string |
Identifikátor ARM pro privátní koncový bod. |
PrivateEndpointConnection
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikovaný identifikátor prostředku. |
name |
string |
Název prostředku. |
properties.groupIds |
string[] |
GroupIds z prostředku služby private link. |
properties.privateEndpoint |
Prostředek privátního koncového bodu pro toto připojení. |
|
properties.privateLinkServiceConnectionState |
Podrobnosti o stavu připojení. |
|
properties.provisioningState |
Stav zřizování připojení privátního koncového bodu. |
|
type |
string |
Typ prostředku. |
PublicNetworkAccess
Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
Stav zřizování připojení privátního koncového bodu.
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
systemData
Metadata týkající se vytvoření a poslední změny prostředku.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Časové razítko vytvoření prostředku (UTC) |
createdBy |
string |
Identita, která vytvořila prostředek. |
createdByType |
Typ identity, která prostředek vytvořila. |
|
lastModifiedAt |
string |
Časové razítko poslední změny prostředku (UTC) |
lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |
UserIdentityProperties
Informace o identitě uživatele.
Name | Typ | Description |
---|---|---|
clientId |
string |
ID klienta identity přiřazené uživatelem. |
principalId |
string |
ID objektu zabezpečení identity přiřazené uživatelem. |