Topics - Update
Aktualizowanie tematu.
Asynchronicznie aktualizuje temat przy użyciu określonych parametrów.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2022-06-15
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
resource
|
path | True |
string |
Nazwa grupy zasobów w ramach subskrypcji użytkownika. |
subscription
|
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. |
topic
|
path | True |
string |
Nazwa tematu. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia z żądaniem klienta. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
identity |
Informacje o tożsamości zasobu tematu. |
|
properties.dataResidencyBoundary |
Granica miejsca przechowywania danych dla tematu. |
|
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 temacie. |
properties.inboundIpRules |
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.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 Temat. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
201 Created |
Zaakceptowano żądanie aktualizacji tematu. |
|
Other Status Codes |
Odpowiedzi na błędy: ***
|
Przykłady
Topics_Update
Przykładowe żądanie
PATCH https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1?api-version=2022-06-15
{
"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://exampletopic1.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/topics/exampletopic1",
"location": "westus2",
"name": "exampletopic1",
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
}
Definicje
Nazwa | Opis |
---|---|
Connection |
Informacje o stanie połączenia. |
created |
Typ tożsamości, która utworzyła zasób. |
Data |
Data Residency granicę zasobu. |
Identity |
Informacje o tożsamości zasobu. |
Identity |
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. |
Inbound |
|
Input |
Określa to format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących publikowanych w zasobie domeny usługi Event Grid. |
Ip |
Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask. |
Json |
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. |
Json |
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. |
Json |
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. |
Persisted |
Stan połączenia. |
Private |
Informacje dotyczące prywatnego punktu końcowego. |
Private |
|
Public |
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 |
Resource |
Stan aprowizacji połączenia prywatnego punktu końcowego. |
system |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
Topic |
EventGrid — temat |
Topic |
Stan aprowizacji tematu. |
Topic |
Właściwości aktualizacji tematu |
User |
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 |
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 |
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 |
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,
User |
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 |
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 |
Informacje o mapowaniu właściwości DataVersion zdarzenia usługi Event Grid. |
|
properties.eventTime |
Informacje o mapowaniu właściwości EventTime zdarzenia usługi Event Grid. |
|
properties.eventType |
Informacje o mapowaniu właściwości EventType zdarzenia usługi Event Grid. |
|
properties.id |
Informacje o mapowaniu właściwości Id zdarzenia usługi Event Grid. |
|
properties.subject |
Informacje o mapowaniu właściwości Subject zdarzenia usługi Event Grid. |
|
properties.topic |
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 |
Zasób prywatnego punktu końcowego dla tego połączenia. |
|
properties.privateLinkServiceConnectionState |
Szczegółowe informacje o stanie połączenia. |
|
properties.provisioningState |
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 |
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 |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |
Topic
EventGrid — temat
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu. |
|
identity |
Informacje o tożsamości zasobu. |
||
location |
string |
Lokalizacja zasobu. |
|
name |
string |
Nazwa zasobu. |
|
properties.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 temacie. |
properties.endpoint |
string |
Punkt końcowy tematu. |
|
properties.inboundIpRules |
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 | EventGridSchema |
Określa format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych w temacie. |
|
properties.inputSchemaMapping | InputSchemaMapping: |
Umożliwia to publikowanie przy użyciu niestandardowych schematów zdarzeń. Można określić element InputSchemaMapping w celu mapowania różnych właściwości schematu źródłowego na różne wymagane właściwości schematu EventGridEvent. |
|
properties.metricResourceId |
string |
Identyfikator zasobu metryki dla tematu. |
|
properties.privateEndpointConnections | |||
properties.provisioningState |
Stan aprowizacji tematu. |
||
properties.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 |
Metadane systemowe odnoszące się do zasobu tematu. |
||
tags |
object |
Tagi zasobu. |
|
type |
string |
Typ zasobu. |
TopicProvisioningState
Stan aprowizacji tematu.
Nazwa | Typ | Opis |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
TopicUpdateParameters
Właściwości aktualizacji tematu
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
identity |
Informacje o tożsamości zasobu tematu. |
||
properties.dataResidencyBoundary |
Granica miejsca przechowywania danych dla tematu. |
||
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 temacie. |
|
properties.inboundIpRules |
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.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 |
|
tags |
object |
Tagi zasobu Temat. |
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. |