Freigeben über


Domains - Create Or Update

Erstellen oder Aktualisieren einer Domäne.
Erstellt oder aktualisiert asynchron eine neue Domäne mit den angegebenen Parametern.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
domainName
path True

string

Name der Domäne.

resourceGroupName
path True

string

Der Name der Ressourcengruppe im Abonnement des Benutzers.

subscriptionId
path True

string

Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Speicherort der Ressource.

identity

IdentityInfo

Identitätsinformationen für die Event Grid-Domänenressource.

properties.autoCreateTopicWithFirstSubscription

boolean

Dieser boolesche Wert wird verwendet, um den Erstellungsmechanismus für "alle" Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann die Erstellung eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft null oder auf true festgelegt ist, ist Event Grid für die automatische Erstellung des Domänenthemas verantwortlich, wenn das erste Ereignisabonnement im Bereich des Domänenthemas erstellt wird. Wenn diese Eigenschaft auf false festgelegt ist, muss zum Erstellen des ersten Ereignisabonnements ein Domänenthema durch den Benutzer erstellt werden. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema erstellt wird, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus bei Bedarf das Domänenthema bei Bedarf erstellen kann.

properties.autoDeleteTopicWithLastSubscription

boolean

Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann das Löschen des Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft auf true festgelegt ist, ist Event Grid dafür verantwortlich, das Domänenthema automatisch zu löschen, wenn das letzte Ereignisabonnement im Bereich des Domänenthemas gelöscht wird. Wenn diese Eigenschaft auf false festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn es nicht mehr benötigt wird (z. B. wenn das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema gelöscht werden muss, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency Grenze der Ressource.

properties.disableLocalAuth

boolean

Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist false. Wenn die Eigenschaft auf true festgelegt ist, wird nur das AAD-Token für die Authentifizierung verwendet, wenn der Benutzer in der Domäne veröffentlichen darf.

properties.inboundIpRules

InboundIpRule[]

Dies kann verwendet werden, um den Datenverkehr von bestimmten IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.

properties.inputSchema

InputSchema

Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat.

properties.publicNetworkAccess

PublicNetworkAccess

Dadurch wird bestimmt, ob Datenverkehr über ein öffentliches Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können auf bestimmte IP-Adressen weiter einschränken, indem Sie konfigurieren.

tags

object

Tags der Ressource.

Antworten

Name Typ Beschreibung
201 Created

Domain

Erstellt

Other Status Codes

Fehlerantworten: ***

  • 400 Ungültige Anforderung.

  • 500 Interner Serverfehler.

Beispiele

Domains_CreateOrUpdate

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ConnectionState

ConnectionState-Informationen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DataResidencyBoundary

Data Residency Grenze der Ressource.

Domain

EventGrid-Domäne.

DomainProvisioningState

Bereitstellungsstatus der Event Grid-Domänenressource.

IdentityInfo

Die Identitätsinformationen für die Ressource.

IdentityType

Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten.

InboundIpRule
InputSchema

Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden.

IpActionType

Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll.

JsonField

Dies wird verwendet, um die Quelle einer Eingabeschemazuordnung für ein einzelnes Zielfeld im Event Grid-Ereignisschema auszudrücken. Dies wird derzeit in den Zuordnungen für die Eigenschaften "id", "topic" und "eventtime" verwendet. Dies stellt ein Feld im Eingabeereignisschema dar.

JsonFieldWithDefault

Dies wird verwendet, um die Quelle einer Eingabeschemazuordnung für ein einzelnes Zielfeld im Event Grid-Ereignisschema auszudrücken. Dies wird derzeit in den Zuordnungen für die Eigenschaften "subject", "eventtype" und "dataversion" verwendet. Dies stellt ein Feld im Eingabeereignisschema zusammen mit einem zu verwendenden Standardwert dar, und es sollte mindestens eine dieser beiden Eigenschaften bereitgestellt werden.

JsonInputSchemaMapping

Dies ermöglicht die Veröffentlichung in Event Grid mithilfe eines benutzerdefinierten Eingabeschemas. Dies kann verwendet werden, um Eigenschaften aus einem benutzerdefinierten JSON-Eingabeschema dem Event Grid-Ereignisschema zuzuordnen.

PersistedConnectionStatus

Status der Verbindung.

PrivateEndpoint

PrivateEndpoint-Informationen.

PrivateEndpointConnection
PublicNetworkAccess

Dadurch wird bestimmt, ob Datenverkehr über ein öffentliches Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können auf bestimmte IP-Adressen weiter einschränken, indem Sie konfigurieren.

ResourceProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

UserIdentityProperties

Die Informationen zur Benutzeridentität.

ConnectionState

ConnectionState-Informationen.

Name Typ Beschreibung
actionsRequired

string

Erforderliche Aktionen (falls vorhanden).

description

string

Beschreibung des Verbindungsstatus.

status

PersistedConnectionStatus

Status der Verbindung.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency Grenze der Ressource.

Name Typ Beschreibung
WithinGeopair

string

WithinRegion

string

Domain

EventGrid-Domäne.

Name Typ Standardwert Beschreibung
id

string

Vollqualifizierter Bezeichner der Ressource.

identity

IdentityInfo

Identitätsinformationen für die Event Grid-Domänenressource.

location

string

Speicherort der Ressource.

name

string

Der Name der Ressource.

properties.autoCreateTopicWithFirstSubscription

boolean

True

Dieser boolesche Wert wird verwendet, um den Erstellungsmechanismus für "alle" Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann die Erstellung eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft null oder auf true festgelegt ist, ist Event Grid für die automatische Erstellung des Domänenthemas verantwortlich, wenn das erste Ereignisabonnement im Bereich des Domänenthemas erstellt wird. Wenn diese Eigenschaft auf false festgelegt ist, muss zum Erstellen des ersten Ereignisabonnements ein Domänenthema durch den Benutzer erstellt werden. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema erstellt wird, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus bei Bedarf das Domänenthema bei Bedarf erstellen kann.

properties.autoDeleteTopicWithLastSubscription

boolean

True

Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann das Löschen des Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft auf true festgelegt ist, ist Event Grid dafür verantwortlich, das Domänenthema automatisch zu löschen, wenn das letzte Ereignisabonnement im Bereich des Domänenthemas gelöscht wird. Wenn diese Eigenschaft auf false festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn es nicht mehr benötigt wird (z. B. wenn das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema gelöscht werden muss, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency Grenze der Ressource.

properties.disableLocalAuth

boolean

False

Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist false. Wenn die Eigenschaft auf true festgelegt ist, wird nur das AAD-Token für die Authentifizierung verwendet, wenn der Benutzer in der Domäne veröffentlichen darf.

properties.endpoint

string

Endpunkt für die Event Grid-Domänenressource, die zum Veröffentlichen der Ereignisse verwendet wird.

properties.inboundIpRules

InboundIpRule[]

Dies kann verwendet werden, um den Datenverkehr von bestimmten IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.

properties.inputSchema

InputSchema

EventGridSchema

Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat.

properties.metricResourceId

string

Metrikressourcen-ID für die Event Grid-Domänenressource.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Liste der Verbindungen mit privaten Endpunkten.

properties.provisioningState

DomainProvisioningState

Bereitstellungsstatus der Event Grid-Domänenressource.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Dadurch wird bestimmt, ob Datenverkehr über ein öffentliches Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können auf bestimmte IP-Adressen weiter einschränken, indem Sie konfigurieren.

systemData

systemData

Die Systemmetadaten im Zusammenhang mit der Event Grid-Domänenressource.

tags

object

Tags der Ressource.

type

string

Der Typ der Ressource.

DomainProvisioningState

Bereitstellungsstatus der Event Grid-Domänenressource.

Name Typ Beschreibung
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

IdentityInfo

Die Identitätsinformationen für die Ressource.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der Ressourcenidentität.

tenantId

string

Die Mandanten-ID der Ressource.

type

IdentityType

Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten.

userAssignedIdentities

<string,  UserIdentityProperties>

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Diese Eigenschaft wird derzeit nicht verwendet und für die zukünftige Verwendung reserviert.

IdentityType

Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten.

Name Typ Beschreibung
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

Name Typ Beschreibung
action

IpActionType

Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll.

ipMask

string

IP-Adresse in CIDR-Notation, z. B. 10.0.0.0/8.

InputSchema

Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden.

Name Typ Beschreibung
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll.

Name Typ Beschreibung
Allow

string

JsonField

Dies wird verwendet, um die Quelle einer Eingabeschemazuordnung für ein einzelnes Zielfeld im Event Grid-Ereignisschema auszudrücken. Dies wird derzeit in den Zuordnungen für die Eigenschaften "id", "topic" und "eventtime" verwendet. Dies stellt ein Feld im Eingabeereignisschema dar.

Name Typ Beschreibung
sourceField

string

Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll.

JsonFieldWithDefault

Dies wird verwendet, um die Quelle einer Eingabeschemazuordnung für ein einzelnes Zielfeld im Event Grid-Ereignisschema auszudrücken. Dies wird derzeit in den Zuordnungen für die Eigenschaften "subject", "eventtype" und "dataversion" verwendet. Dies stellt ein Feld im Eingabeereignisschema zusammen mit einem zu verwendenden Standardwert dar, und es sollte mindestens eine dieser beiden Eigenschaften bereitgestellt werden.

Name Typ Beschreibung
defaultValue

string

Der Standardwert, der für die Zuordnung verwendet werden soll, wenn kein SourceField bereitgestellt wird oder wenn keine Eigenschaft mit dem angegebenen Namen in der veröffentlichten JSON-Ereignisnutzlast vorhanden ist.

sourceField

string

Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll.

JsonInputSchemaMapping

Dies ermöglicht die Veröffentlichung in Event Grid mithilfe eines benutzerdefinierten Eingabeschemas. Dies kann verwendet werden, um Eigenschaften aus einem benutzerdefinierten JSON-Eingabeschema dem Event Grid-Ereignisschema zuzuordnen.

Name Typ Beschreibung
inputSchemaMappingType string:

Json

Typ der benutzerdefinierten Zuordnung

properties.dataVersion

JsonFieldWithDefault

Die Zuordnungsinformationen für die DataVersion-Eigenschaft des Event Grid-Ereignisses.

properties.eventTime

JsonField

Die Zuordnungsinformationen für die EventTime-Eigenschaft des Event Grid-Ereignisses.

properties.eventType

JsonFieldWithDefault

Die Zuordnungsinformationen für die EventType-Eigenschaft des Event Grid-Ereignisses.

properties.id

JsonField

Die Zuordnungsinformationen für die Id-Eigenschaft des Event Grid-Ereignisses.

properties.subject

JsonFieldWithDefault

Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses.

properties.topic

JsonField

Die Zuordnungsinformationen für die Topic-Eigenschaft des Event Grid-Ereignisses.

PersistedConnectionStatus

Status der Verbindung.

Name Typ Beschreibung
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

PrivateEndpoint-Informationen.

Name Typ Beschreibung
id

string

Der ARM-Bezeichner für den privaten Endpunkt.

PrivateEndpointConnection

Name Typ Beschreibung
id

string

Vollqualifizierter Bezeichner der Ressource.

name

string

Der Name der Ressource.

properties.groupIds

string[]

GroupIds aus der Private Link-Dienstressource.

properties.privateEndpoint

PrivateEndpoint

Die Ressource "Privater Endpunkt" für diese Verbindung.

properties.privateLinkServiceConnectionState

ConnectionState

Details zum Status der Verbindung.

properties.provisioningState

ResourceProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

type

string

Der Typ der Ressource.

PublicNetworkAccess

Dadurch wird bestimmt, ob Datenverkehr über ein öffentliches Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können auf bestimmte IP-Adressen weiter einschränken, indem Sie konfigurieren.

Name Typ Beschreibung
Disabled

string

Enabled

string

ResourceProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

Name Typ Beschreibung
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserIdentityProperties

Die Informationen zur Benutzeridentität.

Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.

principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.