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=2022-06-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 samodzielnej (w przypadku wartości false). Wartość domyślna tej właściwości to true. Jeśli ta właściwość ma wartość null lub ma 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 tworzeniem tematu domeny, a tryb zarządzany automatycznie 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 tworzenia automatycznego 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 samodzielnej (w przypadku wartości false). 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 mniejszej liczby operacji i zarządzania mniejszą liczbą zasobów przez użytkownika.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency granicę zasobu.

properties.disableLocalAuth

boolean

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

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 brane pod uwagę tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.

properties.inputSchema

InputSchema

Określa to format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących publikowanych 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.publicNetworkAccess

PublicNetworkAccess

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

tags

object

Tagi zasobu.

Odpowiedzi

Nazwa Typ Opis
201 Created

Domain

Utworzone

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

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 stanie połączenia.

createdByType

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

DataResidencyBoundary

Data Residency granicę zasobu.

Domain

Domena EventGrid.

DomainProvisioningState

Stan aprowizacji zasobu domeny usługi Event Grid.

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 "Brak" spowoduje usunięcie dowolnej tożsamości.

InboundIpRule
InputSchema

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

IpActionType

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

JsonField

Służy to 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 to 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 na schemat 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 ona włączona. 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.

UserIdentityProperties

Informacje o tożsamości użytkownika.

ConnectionState

Informacje o stanie połączenia.

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.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency granicę zasobu.

Nazwa Typ Opis
WithinGeopair

string

WithinRegion

string

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 samodzielnej (w przypadku wartości false). Wartość domyślna tej właściwości to true. Jeśli ta właściwość ma wartość null lub ma 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 tworzeniem tematu domeny, a tryb zarządzany automatycznie 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 tworzenia automatycznego 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 samodzielnej (w przypadku wartości false). 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 mniejszej liczby operacji i zarządzania mniejszą liczbą zasobów przez użytkownika.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency granicę zasobu.

properties.disableLocalAuth

boolean

False

Ta wartość logiczna służy do włączania lub wyłączania uwierzytelniania lokalnego. Wartość domyślna to false. Jeśli właściwość jest ustawiona na wartość 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, który jest używany do publikowania 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 brane pod uwagę tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.

properties.inputSchema

InputSchema

EventGridSchema

Określa to format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących publikowanych 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.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 ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

systemData

systemData

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

tags

object

Tagi zasobu.

type

string

Typ zasobu.

DomainProvisioningState

Stan aprowizacji zasobu domeny usługi Event Grid.

Nazwa Typ Opis
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

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 "Brak" spowoduje usunięcie dowolnej tożsamości.

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 usługi 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 "Brak" spowoduje usunięcie dowolnej tożsamości.

Nazwa Typ Opis
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

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.

InputSchema

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

Nazwa Typ Opis
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

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

Nazwa Typ Opis
Allow

string

JsonField

Służy to 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 to 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 zdarzenia 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 na schemat 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 Topic zdarzenia usługi Event Grid.

PersistedConnectionStatus

Stan połączenia.

Nazwa Typ Opis
Approved

string

Disconnected

string

Pending

string

Rejected

string

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 ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

Nazwa Typ Opis
Disabled

string

Enabled

string

ResourceProvisioningState

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

Nazwa Typ Opis
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (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

Sygnatura czasowa 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.

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.