Topics - Update
Aktualisieren sie ein Thema.
Aktualisiert asynchron ein Thema mit den angegebenen Parametern.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2022-06-15
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe im Abonnement des Benutzers. |
subscription
|
path | True |
string |
Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf. |
topic
|
path | True |
string |
Name des Themas. |
api-version
|
query | True |
string |
Version der API, die mit der Clientanforderung verwendet werden soll. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
identity |
Informationen zur Identität von Themenressourcen. |
|
properties.dataResidencyBoundary |
Die Datenresidenzgrenze für das Thema. |
|
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 die Veröffentlichung im Thema zulassen kann. |
properties.inboundIpRules |
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.publicNetworkAccess |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren |
|
tags |
object |
Tags der Topic-Ressource. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
201 Created |
Anforderung zum Themaupdate wurde akzeptiert. |
|
Other Status Codes |
Fehlerantworten: ***
|
Beispiele
Topics_Update
Beispielanforderung
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"
}
]
}
}
Beispiel für eine Antwort
{
"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"
}
Definitionen
Name | Beschreibung |
---|---|
Connection |
ConnectionState-Informationen. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Data |
Data Residency Begrenzung der Ressource. |
Identity |
Die Identitätsinformationen für die Ressource. |
Identity |
Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt jede Identität. |
Inbound |
|
Input |
Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden. |
Ip |
Aktion, die basierend auf der Übereinstimmung oder keine Übereinstimmung der IpMask ausgeführt werden soll. |
Json |
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. |
Json |
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 mindestens eine dieser beiden Eigenschaften sollte bereitgestellt werden. |
Json |
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. |
Persisted |
Status der Verbindung. |
Private |
PrivateEndpoint-Informationen. |
Private |
|
Public |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren |
Resource |
Bereitstellungsstatus der Verbindung mit privatem Endpunkt. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
Topic |
EventGrid-Thema |
Topic |
Bereitstellungsstatus des Themas. |
Topic |
Eigenschaften des Themaupdates |
User |
Die Informationen zur Benutzeridentität. |
ConnectionState
ConnectionState-Informationen.
Name | Typ | Beschreibung |
---|---|---|
actionsRequired |
string |
Aktionen erforderlich (falls vorhanden). |
description |
string |
Beschreibung des Verbindungsstatus. |
status |
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 Begrenzung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
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 |
Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt jede Identität. |
|
userAssignedIdentities |
<string,
User |
Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{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" enthält sowohl eine implizit erstellte Identität als auch eine Reihe benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt jede Identität.
Name | Typ | Beschreibung |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Name | Typ | Beschreibung |
---|---|---|
action |
Aktion, die basierend auf der Übereinstimmung oder keine Ü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 keine Ü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 mindestens eine dieser beiden Eigenschaften sollte bereitgestellt werden.
Name | Typ | Beschreibung |
---|---|---|
defaultValue |
string |
Der Standardwert, der für die Zuordnung verwendet werden soll, wenn kein SourceField-Objekt angegeben 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 |
Die Zuordnungsinformationen für die DataVersion-Eigenschaft des Event Grid-Ereignisses. |
|
properties.eventTime |
Die Zuordnungsinformationen für die EventTime-Eigenschaft des Event Grid-Ereignisses. |
|
properties.eventType |
Die Zuordnungsinformationen für die EventType-Eigenschaft des Event Grid-Ereignisses. |
|
properties.id |
Die Zuordnungsinformationen für die Id-Eigenschaft des Event Grid-Ereignisses. |
|
properties.subject |
Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses. |
|
properties.topic |
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 private Endpunkte. |
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 |
Die Ressource "Privater Endpunkt" für diese Verbindung. |
|
properties.privateLinkServiceConnectionState |
Details zum Status der Verbindung. |
|
properties.provisioningState |
Bereitstellungsstatus der Verbindung mit privatem Endpunkt. |
|
type |
string |
Der Typ der Ressource. |
PublicNetworkAccess
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
Bereitstellungsstatus der Verbindung mit privatem 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 |
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 |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
Topic
EventGrid-Thema
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
id |
string |
Vollqualifizierter Bezeichner der Ressource. |
|
identity |
Identitätsinformationen für die Ressource. |
||
location |
string |
Speicherort der Ressource. |
|
name |
string |
Der Name der Ressource. |
|
properties.dataResidencyBoundary |
Data Residency Begrenzung 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 die Veröffentlichung im Thema zulassen kann. |
properties.endpoint |
string |
Endpunkt für das Thema. |
|
properties.inboundIpRules |
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 | EventGridSchema |
Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die im Thema veröffentlicht werden. |
|
properties.inputSchemaMapping | InputSchemaMapping: |
Dies ermöglicht die Veröffentlichung mithilfe benutzerdefinierter Ereignisschemas. Ein InputSchemaMapping kann angegeben werden, um verschiedene Eigenschaften eines Quellschemas verschiedenen erforderlichen Eigenschaften des EventGridEvent-Schemas zuzuordnen. |
|
properties.metricResourceId |
string |
Metrikressourcen-ID für das Thema. |
|
properties.privateEndpointConnections | |||
properties.provisioningState |
Bereitstellungsstatus des Themas. |
||
properties.publicNetworkAccess | Enabled |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren |
|
systemData |
Die Systemmetadaten im Zusammenhang mit der Themenressource. |
||
tags |
object |
Tags der Ressource. |
|
type |
string |
Der Typ der Ressource. |
TopicProvisioningState
Bereitstellungsstatus des Themas.
Name | Typ | Beschreibung |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
TopicUpdateParameters
Eigenschaften des Themaupdates
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
identity |
Informationen zur Identität von Themenressourcen. |
||
properties.dataResidencyBoundary |
Die Datenresidenzgrenze für das Thema. |
||
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 die Veröffentlichung im Thema zulassen kann. |
|
properties.inboundIpRules |
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.publicNetworkAccess | Enabled |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren |
|
tags |
object |
Tags der Topic-Ressource. |
UserIdentityProperties
Die Informationen zur Benutzeridentität.
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
Die Client-ID der benutzerseitig zugewiesenen Identität. |
principalId |
string |
Die Prinzipal-ID der benutzerseitig zugewiesenen Identität. |