Udostępnij za pośrednictwem


Domains - Create Or Update

Tworzenie lub aktualizowanie domeny.
Asynchronicznie tworzy lub aktualizuje nową domenę przy użyciu określonych parametrów.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
domainName
path True

string

Nazwa domeny.

resourceGroupName
path True

string

Nazwa grupy zasobów w ramach subskrypcji użytkownika.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True

string

Wersja interfejsu API do użycia z żądaniem klienta.

Treść żądania

Nazwa Wymagane Typ Opis
location True

string

Lokalizacja zasobu.

identity

IdentityInfo

Informacje o tożsamości zasobu domeny usługi Event Grid.

properties.autoCreateTopicWithFirstSubscription

boolean

Ta wartość logiczna służy do określania mechanizmu tworzenia dla "wszystkich" tematów domeny usługi Event Grid skojarzonych z tym zasobem domeny usługi Event Grid. W tym kontekście tworzenie tematu domeny może być zarządzane automatycznie (w przypadku wartości true) lub samodzielnego zarządzania (gdy jest to fałsz). Wartość domyślna tej właściwości to true. Jeśli ta właściwość ma wartość null lub jest ustawiona na wartość true, usługa Event Grid jest odpowiedzialna za automatyczne tworzenie tematu domeny po utworzeniu pierwszej subskrypcji zdarzeń w zakresie tematu domeny. Jeśli ta właściwość ma wartość false, utworzenie pierwszej subskrypcji zdarzeń będzie wymagać utworzenia tematu domeny przez użytkownika. Tryb samodzielnego zarządzania może być używany, jeśli użytkownik chce mieć pełną kontrolę nad utworzeniem tematu domeny, podczas gdy tryb automatycznego zarządzania zapewnia elastyczność wykonywania mniejszej liczby operacji i zarządzania mniejszą liczbą zasobów przez użytkownika. Należy również pamiętać, że w trybie automatycznego tworzenia zarządzanego użytkownik może w razie potrzeby utworzyć temat domeny na żądanie.

properties.autoDeleteTopicWithLastSubscription

boolean

Ta wartość logiczna służy do określania mechanizmu usuwania dla "wszystkich" tematów domeny usługi Event Grid skojarzonych z tym zasobem domeny usługi Event Grid. W tym kontekście usunięcie tematu domeny może być zarządzane automatycznie (w przypadku wartości true) lub samodzielnego zarządzania (gdy jest to fałsz). Wartość domyślna tej właściwości to true. Gdy ta właściwość ma wartość true, usługa Event Grid jest odpowiedzialna za automatyczne usuwanie tematu domeny po usunięciu ostatniej subskrypcji zdarzeń w zakresie tematu domeny. Jeśli ta właściwość ma wartość false, użytkownik musi ręcznie usunąć temat domeny, gdy nie jest już potrzebny (np. gdy ostatnia subskrypcja zdarzeń zostanie usunięta, a zasób musi zostać wyczyszczony). Tryb samodzielnego zarządzania może być używany, jeśli użytkownik chce mieć pełną kontrolę nad tym, kiedy należy usunąć temat domeny, podczas gdy tryb automatycznego zarządzania zapewnia elastyczność wykonywania mniejszych operacji i zarządzania mniejszą liczbą zasobów przez użytkownika.

properties.dataResidencyBoundary

DataResidencyBoundary

Granica rezydencji danych zasobu.

properties.disableLocalAuth

boolean

Ta wartość logiczna służy do włączania lub wyłączania uwierzytelniania lokalnego. Wartość domyślna to false. Gdy właściwość jest ustawiona na true, tylko token usługi AAD będzie używany do uwierzytelniania, jeśli użytkownik może publikować w domenie.

properties.eventTypeInfo

EventTypeInfo

Informacje o typie zdarzenia dla domeny. Te informacje są udostępniane przez wydawcę i mogą być używane przez subskrybenta do wyświetlania różnych typów opublikowanych zdarzeń.

properties.inboundIpRules

InboundIpRule[]

Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: Są one traktowane tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.

properties.inputSchema

InputSchema

Określa format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych w zasobie domeny usługi Event Grid.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Informacje o inputSchemaMapping, które określiły informacje o ładunku zdarzenia mapowania.

properties.minimumTlsVersionAllowed

TlsVersion

Minimalna wersja protokołu TLS wydawcy dozwolona do opublikowania w tej domenie

properties.publicNetworkAccess

PublicNetworkAccess

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

tags

object

Tagi zasobu.

Odpowiedzi

Nazwa Typ Opis
201 Created

Domain

Utworzono

Other Status Codes

Odpowiedzi na błędy: ***

  • 400 Nieprawidłowe żądanie.

  • 500 Wewnętrzny błąd serwera.

Przykłady

Domains_CreateOrUpdate

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ConnectionState

Informacje o parametrze ConnectionState.

createdByType

Typ tożsamości, która utworzyła zasób.

DataResidencyBoundary

Granica rezydencji danych zasobu.

Domain

Domena EventGrid.

DomainProvisioningState

Stan aprowizacji zasobu domeny usługi Event Grid.

EventDefinitionKind

Rodzaj używanego typu zdarzenia.

EventTypeInfo

Informacje o typie zdarzenia dla kanałów.

IdentityInfo

Informacje o tożsamości zasobu.

IdentityType

Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość.

InboundIpRule
InlineEventProperties

Dodatkowe informacje o każdym zdarzeniu wbudowanym.

InputSchema

Określa format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych w zasobie domeny usługi Event Grid.

IpActionType

Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.

JsonField

Służy do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "id", "topic" i "eventtime". Reprezentuje to pole w schemacie zdarzeń wejściowych.

JsonFieldWithDefault

Służy do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "subject", "eventtype" i "dataversion". Reprezentuje to pole w schemacie zdarzeń wejściowych wraz z wartością domyślną, która ma być używana, i należy podać co najmniej jedną z tych dwóch właściwości.

JsonInputSchemaMapping

Umożliwia to publikowanie w usłudze Event Grid przy użyciu niestandardowego schematu wejściowego. Może to służyć do mapowania właściwości z niestandardowego schematu wejściowego JSON do schematu zdarzeń usługi Event Grid.

PersistedConnectionStatus

Stan połączenia.

PrivateEndpoint

Informacje dotyczące prywatnego punktu końcowego.

PrivateEndpointConnection
PublicNetworkAccess

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

ResourceProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TlsVersion

Minimalna wersja protokołu TLS wydawcy dozwolona do opublikowania w tej domenie

UserIdentityProperties

Informacje o tożsamości użytkownika.

ConnectionState

Informacje o parametrze ConnectionState.

Nazwa Typ Opis
actionsRequired

string

Wymagane akcje (jeśli istnieją).

description

string

Opis stanu połączenia.

status

PersistedConnectionStatus

Stan połączenia.

createdByType

Typ tożsamości, która utworzyła zasób.

Wartość Opis
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Granica rezydencji danych zasobu.

Wartość Opis
WithinGeopair
WithinRegion

Domain

Domena EventGrid.

Nazwa Typ Domyślna wartość Opis
id

string

W pełni kwalifikowany identyfikator zasobu.

identity

IdentityInfo

Informacje o tożsamości zasobu domeny usługi Event Grid.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.autoCreateTopicWithFirstSubscription

boolean

True

Ta wartość logiczna służy do określania mechanizmu tworzenia dla "wszystkich" tematów domeny usługi Event Grid skojarzonych z tym zasobem domeny usługi Event Grid. W tym kontekście tworzenie tematu domeny może być zarządzane automatycznie (w przypadku wartości true) lub samodzielnego zarządzania (gdy jest to fałsz). Wartość domyślna tej właściwości to true. Jeśli ta właściwość ma wartość null lub jest ustawiona na wartość true, usługa Event Grid jest odpowiedzialna za automatyczne tworzenie tematu domeny po utworzeniu pierwszej subskrypcji zdarzeń w zakresie tematu domeny. Jeśli ta właściwość ma wartość false, utworzenie pierwszej subskrypcji zdarzeń będzie wymagać utworzenia tematu domeny przez użytkownika. Tryb samodzielnego zarządzania może być używany, jeśli użytkownik chce mieć pełną kontrolę nad utworzeniem tematu domeny, podczas gdy tryb automatycznego zarządzania zapewnia elastyczność wykonywania mniejszej liczby operacji i zarządzania mniejszą liczbą zasobów przez użytkownika. Należy również pamiętać, że w trybie automatycznego tworzenia zarządzanego użytkownik może w razie potrzeby utworzyć temat domeny na żądanie.

properties.autoDeleteTopicWithLastSubscription

boolean

True

Ta wartość logiczna służy do określania mechanizmu usuwania dla "wszystkich" tematów domeny usługi Event Grid skojarzonych z tym zasobem domeny usługi Event Grid. W tym kontekście usunięcie tematu domeny może być zarządzane automatycznie (w przypadku wartości true) lub samodzielnego zarządzania (gdy jest to fałsz). Wartość domyślna tej właściwości to true. Gdy ta właściwość ma wartość true, usługa Event Grid jest odpowiedzialna za automatyczne usuwanie tematu domeny po usunięciu ostatniej subskrypcji zdarzeń w zakresie tematu domeny. Jeśli ta właściwość ma wartość false, użytkownik musi ręcznie usunąć temat domeny, gdy nie jest już potrzebny (np. gdy ostatnia subskrypcja zdarzeń zostanie usunięta, a zasób musi zostać wyczyszczony). Tryb samodzielnego zarządzania może być używany, jeśli użytkownik chce mieć pełną kontrolę nad tym, kiedy należy usunąć temat domeny, podczas gdy tryb automatycznego zarządzania zapewnia elastyczność wykonywania mniejszych operacji i zarządzania mniejszą liczbą zasobów przez użytkownika.

properties.dataResidencyBoundary

DataResidencyBoundary

Granica rezydencji danych zasobu.

properties.disableLocalAuth

boolean

False

Ta wartość logiczna służy do włączania lub wyłączania uwierzytelniania lokalnego. Wartość domyślna to false. Gdy właściwość jest ustawiona na true, tylko token usługi AAD będzie używany do uwierzytelniania, jeśli użytkownik może publikować w domenie.

properties.endpoint

string

Punkt końcowy zasobu domeny usługi Event Grid używany do publikowania zdarzeń.

properties.eventTypeInfo

EventTypeInfo

Informacje o typie zdarzenia dla domeny. Te informacje są udostępniane przez wydawcę i mogą być używane przez subskrybenta do wyświetlania różnych typów opublikowanych zdarzeń.

properties.inboundIpRules

InboundIpRule[]

Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: Są one traktowane tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.

properties.inputSchema

InputSchema

EventGridSchema

Określa format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych w zasobie domeny usługi Event Grid.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Informacje o inputSchemaMapping, które określiły informacje o ładunku zdarzenia mapowania.

properties.metricResourceId

string

Identyfikator zasobu metryki dla zasobu domeny usługi Event Grid.

properties.minimumTlsVersionAllowed

TlsVersion

Minimalna wersja protokołu TLS wydawcy dozwolona do opublikowania w tej domenie

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista połączeń prywatnych punktów końcowych.

properties.provisioningState

DomainProvisioningState

Stan aprowizacji zasobu domeny usługi Event Grid.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

systemData

systemData

Metadane systemu odnoszące się do zasobu usługi Event Grid.

tags

object

Tagi zasobu.

type

string

Typ zasobu.

DomainProvisioningState

Stan aprowizacji zasobu domeny usługi Event Grid.

Wartość Opis
Canceled
Creating
Deleting
Failed
Succeeded
Updating

EventDefinitionKind

Rodzaj używanego typu zdarzenia.

Wartość Opis
Inline

EventTypeInfo

Informacje o typie zdarzenia dla kanałów.

Nazwa Typ Opis
inlineEventTypes

<string,  InlineEventProperties>

Kolekcja wbudowanych typów zdarzeń dla zasobu. Wbudowane klucze typu zdarzenia są ciągiem typu, który reprezentuje nazwę zdarzenia. Przykładem prawidłowej wbudowanej nazwy zdarzenia jest "Contoso.OrderCreated". Wbudowane wartości typu zdarzenia są typu InlineEventProperties i będą zawierać dodatkowe informacje dla każdego typu zdarzenia wbudowanego.

kind

EventDefinitionKind

Rodzaj używanego typu zdarzenia.

IdentityInfo

Informacje o tożsamości zasobu.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

tenantId

string

Identyfikator dzierżawy zasobu.

type

IdentityType

Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość.

userAssignedIdentities

<string,  UserIdentityProperties>

Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Ta właściwość nie jest obecnie używana i zarezerwowana do użycia w przyszłości.

IdentityType

Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość.

Wartość Opis
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Nazwa Typ Opis
action

IpActionType

Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.

ipMask

string

Adres IP w notacji CIDR, np. 10.0.0.0/8.

InlineEventProperties

Dodatkowe informacje o każdym zdarzeniu wbudowanym.

Nazwa Typ Opis
dataSchemaUrl

string

DataSchemaUrl dla zdarzenia wbudowanego.

description

string

Opis zdarzenia wbudowanego.

displayName

string

DisplayName dla zdarzenia wbudowanego.

documentationUrl

string

DokumentacjaUrl dla zdarzenia wbudowanego.

InputSchema

Określa format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych w zasobie domeny usługi Event Grid.

Wartość Opis
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.

Wartość Opis
Allow

JsonField

Służy do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "id", "topic" i "eventtime". Reprezentuje to pole w schemacie zdarzeń wejściowych.

Nazwa Typ Opis
sourceField

string

Nazwa pola w schemacie zdarzeń wejściowych, które mają być używane jako źródło mapowania.

JsonFieldWithDefault

Służy do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "subject", "eventtype" i "dataversion". Reprezentuje to pole w schemacie zdarzeń wejściowych wraz z wartością domyślną, która ma być używana, i należy podać co najmniej jedną z tych dwóch właściwości.

Nazwa Typ Opis
defaultValue

string

Wartość domyślna, która ma być używana do mapowania, gdy pole źródłowe nie jest podane lub jeśli nie ma właściwości o określonej nazwie w opublikowanym ładunku zdarzeń JSON.

sourceField

string

Nazwa pola w schemacie zdarzeń wejściowych, które mają być używane jako źródło mapowania.

JsonInputSchemaMapping

Umożliwia to publikowanie w usłudze Event Grid przy użyciu niestandardowego schematu wejściowego. Może to służyć do mapowania właściwości z niestandardowego schematu wejściowego JSON do schematu zdarzeń usługi Event Grid.

Nazwa Typ Opis
inputSchemaMappingType string:

Json

Typ mapowania niestandardowego

properties.dataVersion

JsonFieldWithDefault

Informacje o mapowaniu właściwości DataVersion zdarzenia usługi Event Grid.

properties.eventTime

JsonField

Informacje o mapowaniu właściwości EventTime zdarzenia usługi Event Grid.

properties.eventType

JsonFieldWithDefault

Informacje o mapowaniu właściwości EventType zdarzenia usługi Event Grid.

properties.id

JsonField

Informacje o mapowaniu właściwości Id zdarzenia usługi Event Grid.

properties.subject

JsonFieldWithDefault

Informacje o mapowaniu właściwości Subject zdarzenia usługi Event Grid.

properties.topic

JsonField

Informacje o mapowaniu właściwości Temat zdarzenia usługi Event Grid.

PersistedConnectionStatus

Stan połączenia.

Wartość Opis
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Informacje dotyczące prywatnego punktu końcowego.

Nazwa Typ Opis
id

string

Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu.

name

string

Nazwa zasobu.

properties.groupIds

string[]

GroupIds z zasobu usługi łącza prywatnego.

properties.privateEndpoint

PrivateEndpoint

Zasób prywatnego punktu końcowego dla tego połączenia.

properties.privateLinkServiceConnectionState

ConnectionState

Szczegółowe informacje o stanie połączenia.

properties.provisioningState

ResourceProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

type

string

Typ zasobu.

PublicNetworkAccess

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

Wartość Opis
Disabled
Enabled

ResourceProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Wartość Opis
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

TlsVersion

Minimalna wersja protokołu TLS wydawcy dozwolona do opublikowania w tej domenie

Wartość Opis
1.0
1.1
1.2

UserIdentityProperties

Informacje o tożsamości użytkownika.

Nazwa Typ Opis
clientId

string

Identyfikator klienta tożsamości przypisanej przez użytkownika.

principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.