Share via


Domains - Create Or Update

Tartomány létrehozása vagy frissítése.
Aszinkron módon létrehoz vagy frissít egy új tartományt a megadott paraméterekkel.

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

URI-paraméterek

Name In Kötelező Típus Description
domainName
path True

string

A tartomány neve.

resourceGroupName
path True

string

A felhasználó előfizetésén belüli erőforráscsoport neve.

subscriptionId
path True

string

Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.

api-version
query True

string

Az ügyfélkéréshez használandó API verziója.

Kérelem törzse

Name Kötelező Típus Description
location True

string

Az erőforrás helye.

identity

IdentityInfo

Az Event Grid-tartomány erőforrás identitásadatai.

properties.autoCreateTopicWithFirstSubscription

boolean

Ez a logikai érték határozza meg az Event Grid-tartomány erőforráshoz társított "összes" Event Grid-tartománytémakörök létrehozási mechanizmusát. Ebben az összefüggésben a tartománytémakör létrehozása automatikusan felügyelhető (ha igaz) vagy önkiszolgáló (ha hamis). A tulajdonság alapértelmezett értéke igaz. Ha ez a tulajdonság null értékű vagy igaz értékre van állítva, az Event Grid feladata, hogy automatikusan létrehozza a tartományi témakört, amikor az első esemény-előfizetés létrejön a tartományi témakör hatókörében. Ha ez a tulajdonság false (hamis) értékre van állítva, akkor az első esemény-előfizetés létrehozásához tartományi témakört kell létrehoznia a felhasználónak. Az önfelügyeleti mód akkor használható, ha a felhasználó teljes mértékben szabályozni szeretné a tartománytémakör létrehozásakor, az automatikusan felügyelt mód pedig rugalmasságot biztosít kevesebb művelet végrehajtásához és kevesebb erőforrás kezeléséhez a felhasználó számára. Azt is vegye figyelembe, hogy az automatikusan felügyelt létrehozási módban a felhasználó igény szerint létrehozhatja a tartományi témakört.

properties.autoDeleteTopicWithLastSubscription

boolean

Ez a logikai érték határozza meg az Event Grid-tartomány erőforráshoz társított "összes" Event Grid-tartománytémakörök törlési mechanizmusát. Ebben az összefüggésben a tartománytémakör törlése automatikusan kezelhető (ha igaz) vagy önkiszolgáló (ha hamis). A tulajdonság alapértelmezett értéke igaz. Ha ez a tulajdonság igaz értékre van állítva, az Event Grid felelős a tartománytémakör automatikus törléséért, amikor a tartománytémakör utolsó esemény-előfizetését törlik. Ha ez a tulajdonság false (hamis) értékre van állítva, akkor a felhasználónak manuálisan kell törölnie a tartománytémakört, amikor már nincs rá szükség (például az utolsó esemény-előfizetés törlésekor és az erőforrást törölni kell). Az önfelügyeleti mód akkor használható, ha a felhasználó teljes körűen szabályozni szeretné, hogy mikor kell törölni a tartományi témakört, míg az automatikusan felügyelt mód rugalmasságot biztosít kevesebb művelet végrehajtásához és kevesebb erőforrás felhasználó általi kezeléséhez.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency erőforrás határa.

properties.disableLocalAuth

boolean

Ez a logikai érték a helyi hitelesítés engedélyezésére vagy letiltására szolgál. Az alapértelmezett érték hamis. Ha a tulajdonság értéke igaz, a rendszer csak az AAD-jogkivonatot használja a hitelesítéshez, ha a felhasználó közzéteheti a tartományt.

properties.inboundIpRules

InboundIpRule[]

Ez az összes IP-cím helyett adott IP-címekről érkező forgalom korlátozására használható. Megjegyzés: Ezek csak akkor tekinthetők meg, ha a PublicNetworkAccess engedélyezve van.

properties.inputSchema

InputSchema

Ez határozza meg az Event Grid által az Event Grid tartományi erőforrásban közzétett bejövő események formátumát.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Információk az InputSchemaMapping elemről, amely az esemény hasznos adatainak leképezésével kapcsolatos adatokat adta meg.

properties.publicNetworkAccess

PublicNetworkAccess

Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. További korlátozást végezhet adott IP-címekre a következő konfigurálásával:

tags

object

Az erőforrás címkéi.

Válaszok

Name Típus Description
201 Created

Domain

Létrehozva

Other Status Codes

Hibaválaszok: ***

  • 400 Hibás kérés.

  • 500 belső kiszolgálóhiba.

Példák

Domains_CreateOrUpdate

Sample Request

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

Sample Response

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

Definíciók

Name Description
ConnectionState

ConnectionState-adatok.

createdByType

Az erőforrást létrehozó identitás típusa.

DataResidencyBoundary

Data Residency erőforrás határa.

Domain

EventGrid tartomány.

DomainProvisioningState

Az Event Grid tartományi erőforrás kiépítési állapota.

IdentityInfo

Az erőforrás identitásadatai.

IdentityType

A használt felügyelt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolít minden identitást.

InboundIpRule
InputSchema

Ez határozza meg, hogy az Event Grid milyen formátumot várjon az Event Grid tartományi erőforrásban közzétett bejövő eseményekhez.

IpActionType

Az IpMask egyezése vagy nem egyezése alapján végrehajtandó művelet.

JsonField

Ez az Event Grid eseményséma egyetlen célmezőjének bemeneti sémaleképezésének forrását fejezi ki. Ez jelenleg az "id", a "topic" és az "eventtime" tulajdonságok leképezéseiben használatos. Ez a bemeneti eseményséma egy mezőjét jelöli.

JsonFieldWithDefault

Ez az Event Grid eseményséma egyetlen célmezőjének bemeneti sémaleképezésének forrását fejezi ki. Ezt jelenleg a "subject", "eventtype" és "dataversion" tulajdonságok leképezései használják. Ez a bemeneti eseményséma egy mezőjét és egy alapértelmezett használandó értéket jelöl, és a két tulajdonság közül legalább egyet meg kell adni.

JsonInputSchemaMapping

Ez lehetővé teszi a közzétételt az Event Gridben egyéni bemeneti sémával. Ez az egyéni bemeneti JSON-sémából az Event Grid eseménysémába való leképezésére használható.

PersistedConnectionStatus

A kapcsolat állapota.

PrivateEndpoint

PrivateEndpoint-információk.

PrivateEndpointConnection
PublicNetworkAccess

Ez határozza meg, hogy a forgalom engedélyezve van-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. Az adott IP-címekre további korlátozást a konfigurálással

ResourceProvisioningState

A privát végpontkapcsolat kiépítési állapota.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

UserIdentityProperties

A felhasználói identitással kapcsolatos információk.

ConnectionState

ConnectionState-adatok.

Name Típus Description
actionsRequired

string

Szükséges műveletek (ha vannak ilyenek).

description

string

A kapcsolat állapotának leírása.

status

PersistedConnectionStatus

A kapcsolat állapota.

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency erőforrás határa.

Name Típus Description
WithinGeopair

string

WithinRegion

string

Domain

EventGrid tartomány.

Name Típus Alapértelmezett érték Description
id

string

Az erőforrás teljes azonosítója.

identity

IdentityInfo

Az Event Grid-tartomány erőforrás identitásadatai.

location

string

Az erőforrás helye.

name

string

Az erőforrás neve.

properties.autoCreateTopicWithFirstSubscription

boolean

True

Ez a logikai érték az Event Grid-tartomány erőforráshoz társított Event Grid-tartománytémakörök "összes" létrehozási mechanizmusának megadására szolgál. Ebben az összefüggésben a tartománytémakör létrehozása automatikusan kezelhető (igaz esetén) vagy önkiszolgáló (ha hamis). A tulajdonság alapértelmezett értéke igaz. Ha ez a tulajdonság null értékű vagy igaz értékre van állítva, az Event Grid feladata automatikusan létrehozni a tartománytémakört, amikor az első esemény-előfizetés a tartománytémakör hatókörében jön létre. Ha ez a tulajdonság false (hamis) értékre van állítva, akkor az első esemény-előfizetés létrehozásához létre kell hoznia egy tartományi témakört a felhasználótól. Az önkezelési mód akkor használható, ha a felhasználó teljes mértékben ellenőrizni szeretné a tartománytémakör létrehozásakor, míg az automatikusan felügyelt mód rugalmasságot biztosít a kevesebb művelet végrehajtásához és a felhasználó kevesebb erőforrásának kezeléséhez. Azt is vegye figyelembe, hogy az automatikusan felügyelt létrehozási módban a felhasználó igény szerint létrehozhatja a tartományi témakört.

properties.autoDeleteTopicWithLastSubscription

boolean

True

Ez a logikai érték az Event Grid-tartomány erőforráshoz társított Event Grid-tartománytémakörök "összes" törlési mechanizmusának megadására szolgál. Ebben az összefüggésben a tartománytémakör törlése automatikusan felügyelhető (igaz esetben) vagy önkiszolgáló (ha hamis). A tulajdonság alapértelmezett értéke igaz. Ha ez a tulajdonság igaz értékre van állítva, az Event Grid felelős a tartománytéma automatikus törléséért, amikor a tartománytémakör utolsó esemény-előfizetését törlik. Ha ez a tulajdonság hamis értékre van állítva, akkor a felhasználónak manuálisan kell törölnie a tartománytémakört, amikor már nincs rá szükség (például az utolsó esemény-előfizetés törlésekor és az erőforrást törölni kell). Az önfelügyeleti mód akkor használható, ha a felhasználó teljes mértékben ellenőrizni szeretné, hogy mikor kell törölni a tartománytémát, míg az automatikusan felügyelt mód rugalmasságot biztosít a kevesebb művelet végrehajtásához és a felhasználó kevesebb erőforrás kezeléséhez.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency erőforrás határa.

properties.disableLocalAuth

boolean

False

Ez a logikai érték a helyi hitelesítés engedélyezésére vagy letiltására szolgál. Az alapértelmezett érték hamis. Ha a tulajdonság értéke igaz, a rendszer csak az AAD-jogkivonatot használja a hitelesítéshez, ha a felhasználó közzéteheti a tartományt.

properties.endpoint

string

Az események közzétételéhez használt Event Grid tartományi erőforrás végpontja.

properties.inboundIpRules

InboundIpRule[]

Ez az összes IP-cím helyett az adott IP-címekről érkező forgalom korlátozására használható. Megjegyzés: Ezek csak akkor tekinthetők meg, ha a PublicNetworkAccess engedélyezve van.

properties.inputSchema

InputSchema

EventGridSchema

Ez határozza meg, hogy az Event Grid milyen formátumot várjon az Event Grid tartományi erőforrásban közzétett bejövő eseményekhez.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Információk az InputSchemaMapping szolgáltatásról, amely az esemény hasznos adatainak leképezésével kapcsolatos adatokat adta meg.

properties.metricResourceId

string

Az Event Grid tartományi erőforrás metrikaerőforrás-azonosítója.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Privát végpontkapcsolatok listája.

properties.provisioningState

DomainProvisioningState

Az Event Grid tartományi erőforrás kiépítési állapota.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Ez határozza meg, hogy a forgalom engedélyezve van-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. Az adott IP-címekre további korlátozást a konfigurálással

systemData

systemData

Az Event Grid Domain erőforráshoz kapcsolódó rendszer metaadatai.

tags

object

Az erőforrás címkéi.

type

string

Az erőforrás típusa.

DomainProvisioningState

Az Event Grid tartományi erőforrás kiépítési állapota.

Name Típus Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

IdentityInfo

Az erőforrás identitásadatai.

Name Típus Description
principalId

string

Az erőforrás-identitás fő azonosítója.

tenantId

string

Az erőforrás bérlőazonosítója.

type

IdentityType

A használt felügyelt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolít minden identitást.

userAssignedIdentities

<string,  UserIdentityProperties>

Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Ez a tulajdonság jelenleg nincs használatban, és a jövőbeni használatra van fenntartva.

IdentityType

A használt felügyelt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolít minden identitást.

Name Típus Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

Name Típus Description
action

IpActionType

Az IpMask egyezése vagy nem egyezése alapján végrehajtandó művelet.

ipMask

string

IP-cím CIDR-jelölésben, például: 10.0.0.0/8.

InputSchema

Ez határozza meg, hogy az Event Grid milyen formátumot várjon az Event Grid tartományi erőforrásban közzétett bejövő eseményekhez.

Name Típus Description
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

Az IpMask egyezése vagy nem egyezése alapján végrehajtandó művelet.

Name Típus Description
Allow

string

JsonField

Ez az Event Grid eseményséma egyetlen célmezőjének bemeneti sémaleképezésének forrását fejezi ki. Ez jelenleg az "id", a "topic" és az "eventtime" tulajdonságok leképezéseiben használatos. Ez a bemeneti eseményséma egy mezőjét jelöli.

Name Típus Description
sourceField

string

A bemeneti eseményséma egyik mezőjének neve, amelyet a leképezés forrásaként kell használni.

JsonFieldWithDefault

Ez az Event Grid eseményséma egyetlen célmezőjének bemeneti sémaleképezésének forrását fejezi ki. Ezt jelenleg a "subject", "eventtype" és "dataversion" tulajdonságok leképezései használják. Ez a bemeneti eseményséma egy mezőjét és egy alapértelmezett használandó értéket jelöl, és a két tulajdonság közül legalább egyet meg kell adni.

Name Típus Description
defaultValue

string

A leképezéshez használt alapértelmezett érték, ha a SourceField nincs megadva, vagy ha nincs a megadott nevű tulajdonság a közzétett JSON-esemény hasznos adatában.

sourceField

string

Egy mező neve a bemeneti eseménysémában, amelyet a leképezés forrásaként kell használni.

JsonInputSchemaMapping

Ez lehetővé teszi a közzétételt az Event Gridben egyéni bemeneti sémával. Ez az egyéni bemeneti JSON-sémából az Event Grid eseménysémába való leképezésére használható.

Name Típus Description
inputSchemaMappingType string:

Json

Az egyéni leképezés típusa

properties.dataVersion

JsonFieldWithDefault

Az Event Grid-esemény DataVersion tulajdonságának leképezési információi.

properties.eventTime

JsonField

Az Event Grid-esemény EventTime tulajdonságának leképezési információi.

properties.eventType

JsonFieldWithDefault

Az Event Grid-esemény EventType tulajdonságának leképezési információi.

properties.id

JsonField

Az Event Grid-esemény Id tulajdonságának leképezési információi.

properties.subject

JsonFieldWithDefault

Az Event Grid-esemény Subject tulajdonságának leképezési információi.

properties.topic

JsonField

Az Event Grid-esemény Topic tulajdonságának leképezési információi.

PersistedConnectionStatus

A kapcsolat állapota.

Name Típus Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

PrivateEndpoint-információk.

Name Típus Description
id

string

A privát végpont ARM-azonosítója.

PrivateEndpointConnection

Name Típus Description
id

string

Az erőforrás teljes azonosítója.

name

string

Az erőforrás neve.

properties.groupIds

string[]

GroupIds a private link service erőforrásból.

properties.privateEndpoint

PrivateEndpoint

A kapcsolat privát végpontjának erőforrása.

properties.privateLinkServiceConnectionState

ConnectionState

A kapcsolat állapotának részletei.

properties.provisioningState

ResourceProvisioningState

A privát végpontkapcsolat kiépítési állapota.

type

string

Az erőforrás típusa.

PublicNetworkAccess

Ez határozza meg, hogy a forgalom engedélyezve van-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. Az adott IP-címekre további korlátozást a konfigurálással

Name Típus Description
Disabled

string

Enabled

string

ResourceProvisioningState

A privát végpontkapcsolat kiépítési állapota.

Name Típus Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az az identitás, amely legutóbb módosította az erőforrást.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

UserIdentityProperties

A felhasználói identitással kapcsolatos információk.

Name Típus Description
clientId

string

A felhasználó által hozzárendelt identitás ügyfélazonosítója.

principalId

string

A felhasználó által hozzárendelt identitás egyszerű azonosítója.