Topics - Update
Een onderwerp bijwerken.
Een onderwerp wordt asynchroon bijgewerkt met de opgegeven parameters.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2022-06-15
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep in het abonnement van de gebruiker. |
subscription
|
path | True |
string |
Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep. |
topic
|
path | True |
string |
Naam van het onderwerp. |
api-version
|
query | True |
string |
Versie van de API die moet worden gebruikt met de clientaanvraag. |
Aanvraagbody
Name | Type | Description |
---|---|---|
identity |
Informatie over de id van de onderwerpresource. |
|
properties.dataResidencyBoundary |
De grens van de gegevenslocatie voor het onderwerp. |
|
properties.disableLocalAuth |
boolean |
Deze booleaanse waarde wordt gebruikt om lokale verificatie in of uit te schakelen. De standaardwaarde is false. Wanneer de eigenschap is ingesteld op true, wordt alleen het AAD-token gebruikt om te verifiëren of de gebruiker mag publiceren naar het onderwerp. |
properties.inboundIpRules |
Dit kan worden gebruikt om verkeer van specifieke IP-adressen te beperken in plaats van alle IP-adressen. Opmerking: deze worden alleen in overweging genomen als PublicNetworkAccess is ingeschakeld. |
|
properties.publicNetworkAccess |
Hiermee wordt bepaald of verkeer is toegestaan via een openbaar netwerk. Dit is standaard ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door |
|
tags |
object |
Tags van de onderwerpresource. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
201 Created |
Aanvraag voor het bijwerken van onderwerp is geaccepteerd. |
|
Other Status Codes |
Foutreacties: ***
|
Voorbeelden
Topics_Update
Voorbeeldaanvraag
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"
}
]
}
}
Voorbeeldrespons
{
"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"
}
Definities
Name | Description |
---|---|
Connection |
ConnectionState-informatie. |
created |
Het type identiteit waarmee de resource is gemaakt. |
Data |
Data Residency grens van de resource. |
Identity |
De identiteitsgegevens voor de resource. |
Identity |
Het type beheerde identiteit dat wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' wordt elke identiteit verwijderd. |
Inbound |
|
Input |
Hiermee bepaalt u de indeling die Event Grid mag verwachten voor binnenkomende gebeurtenissen die zijn gepubliceerd naar de Event Grid-domeinresource. |
Ip |
Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het IpMask. |
Json |
Dit wordt gebruikt om de bron van een invoerschematoewijzing uit te drukken voor één doelveld in het Event Grid-gebeurtenisschema. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'id', 'topic' en 'eventtime'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema. |
Json |
Dit wordt gebruikt om de bron van een invoerschematoewijzing uit te drukken voor één doelveld in het Event Grid-gebeurtenisschema. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'subject', 'eventtype' en 'dataversion'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema samen met een standaardwaarde die moet worden gebruikt, en ten minste een van deze twee eigenschappen moet worden opgegeven. |
Json |
Hierdoor kunt u publiceren naar Event Grid met behulp van een aangepast invoerschema. Dit kan worden gebruikt om eigenschappen van een aangepast JSON-schema toe te wijzen aan het Event Grid-gebeurtenisschema. |
Persisted |
Status van de verbinding. |
Private |
PrivateEndpoint-informatie. |
Private |
|
Public |
Hiermee wordt bepaald of verkeer is toegestaan via een openbaar netwerk. Dit is standaard ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door |
Resource |
Inrichtingsstatus van de privé-eindpuntverbinding. |
system |
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource. |
Topic |
EventGrid-onderwerp |
Topic |
Inrichtingsstatus van het onderwerp. |
Topic |
Eigenschappen van de onderwerpupdate |
User |
De informatie over de gebruikersidentiteit. |
ConnectionState
ConnectionState-informatie.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
Acties vereist (indien aanwezig). |
description |
string |
Beschrijving van de verbindingsstatus. |
status |
Status van de verbinding. |
createdByType
Het type identiteit waarmee de resource is gemaakt.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency grens van de resource.
Name | Type | Description |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
IdentityInfo
De identiteitsgegevens voor de resource.
Name | Type | Description |
---|---|---|
principalId |
string |
De principal-id van resource-id. |
tenantId |
string |
De tenant-id van de resource. |
type |
Het type beheerde identiteit dat wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' wordt elke identiteit verwijderd. |
|
userAssignedIdentities |
<string,
User |
De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Deze eigenschap wordt momenteel niet gebruikt en gereserveerd voor toekomstig gebruik. |
IdentityType
Het type beheerde identiteit dat wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' wordt elke identiteit verwijderd.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Name | Type | Description |
---|---|---|
action |
Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het IpMask. |
|
ipMask |
string |
IP-adres in CIDR-notatie, bijvoorbeeld 10.0.0.0/8. |
InputSchema
Hiermee bepaalt u de indeling die Event Grid mag verwachten voor binnenkomende gebeurtenissen die zijn gepubliceerd naar de Event Grid-domeinresource.
Name | Type | Description |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het IpMask.
Name | Type | Description |
---|---|---|
Allow |
string |
JsonField
Dit wordt gebruikt om de bron van een invoerschematoewijzing uit te drukken voor één doelveld in het Event Grid-gebeurtenisschema. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'id', 'topic' en 'eventtime'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema.
Name | Type | Description |
---|---|---|
sourceField |
string |
Naam van een veld in het invoer gebeurtenisschema dat moet worden gebruikt als de bron van een toewijzing. |
JsonFieldWithDefault
Dit wordt gebruikt om de bron van een invoerschematoewijzing uit te drukken voor één doelveld in het Event Grid-gebeurtenisschema. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'subject', 'eventtype' en 'dataversion'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema samen met een standaardwaarde die moet worden gebruikt, en ten minste een van deze twee eigenschappen moet worden opgegeven.
Name | Type | Description |
---|---|---|
defaultValue |
string |
De standaardwaarde die moet worden gebruikt voor toewijzing wanneer er geen SourceField is opgegeven of als er geen eigenschap met de opgegeven naam is in de nettolading van de gepubliceerde JSON-gebeurtenis. |
sourceField |
string |
Naam van een veld in het invoer gebeurtenisschema dat moet worden gebruikt als de bron van een toewijzing. |
JsonInputSchemaMapping
Hierdoor kunt u publiceren naar Event Grid met behulp van een aangepast invoerschema. Dit kan worden gebruikt om eigenschappen van een aangepast JSON-schema toe te wijzen aan het Event Grid-gebeurtenisschema.
Name | Type | Description |
---|---|---|
inputSchemaMappingType |
string:
Json |
Type van de aangepaste toewijzing |
properties.dataVersion |
De toewijzingsgegevens voor de eigenschap DataVersion van de Event Grid-gebeurtenis. |
|
properties.eventTime |
De toewijzingsgegevens voor de eigenschap EventTime van de Event Grid-gebeurtenis. |
|
properties.eventType |
De toewijzingsgegevens voor de eigenschap EventType van de Event Grid-gebeurtenis. |
|
properties.id |
De toewijzingsgegevens voor de eigenschap Id van de Event Grid-gebeurtenis. |
|
properties.subject |
De toewijzingsgegevens voor de eigenschap Onderwerp van de Event Grid-gebeurtenis. |
|
properties.topic |
De toewijzingsgegevens voor de eigenschap Onderwerp van de Event Grid-gebeurtenis. |
PersistedConnectionStatus
Status van de verbinding.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
PrivateEndpoint-informatie.
Name | Type | Description |
---|---|---|
id |
string |
De ARM-id voor privé-eindpunt. |
PrivateEndpointConnection
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde id van de resource. |
name |
string |
De naam van de resource. |
properties.groupIds |
string[] |
GroupIds van de private link-serviceresource. |
properties.privateEndpoint |
De privé-eindpuntresource voor deze verbinding. |
|
properties.privateLinkServiceConnectionState |
Details over de status van de verbinding. |
|
properties.provisioningState |
Inrichtingsstatus van de privé-eindpuntverbinding. |
|
type |
string |
Type van de resource. |
PublicNetworkAccess
Hiermee wordt bepaald of verkeer is toegestaan via een openbaar netwerk. Dit is standaard ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
Inrichtingsstatus van de privé-eindpuntverbinding.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
systemData
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
De tijdstempel van het maken van resources (UTC). |
createdBy |
string |
De identiteit die de resource heeft gemaakt. |
createdByType |
Het type identiteit waarmee de resource is gemaakt. |
|
lastModifiedAt |
string |
Het tijdstempel van de laatste wijziging van de resource (UTC) |
lastModifiedBy |
string |
De identiteit die de resource het laatst heeft gewijzigd. |
lastModifiedByType |
Het type identiteit dat de resource het laatst heeft gewijzigd. |
Topic
EventGrid-onderwerp
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
Volledig gekwalificeerde id van de resource. |
|
identity |
Identiteitsgegevens voor de resource. |
||
location |
string |
Locatie van de resource. |
|
name |
string |
De naam van de resource. |
|
properties.dataResidencyBoundary |
Data Residency grens van de resource. |
||
properties.disableLocalAuth |
boolean |
False |
Deze booleaanse waarde wordt gebruikt om lokale verificatie in of uit te schakelen. De standaardwaarde is false. Wanneer de eigenschap is ingesteld op true, wordt alleen het AAD-token gebruikt om te verifiëren of de gebruiker mag publiceren naar het onderwerp. |
properties.endpoint |
string |
Eindpunt voor het onderwerp. |
|
properties.inboundIpRules |
Dit kan worden gebruikt om verkeer van specifieke IP-adressen te beperken in plaats van alle IP-adressen. Opmerking: deze worden alleen in overweging genomen als PublicNetworkAccess is ingeschakeld. |
||
properties.inputSchema | EventGridSchema |
Hiermee bepaalt u de indeling die Event Grid moet verwachten voor binnenkomende gebeurtenissen die in het onderwerp worden gepubliceerd. |
|
properties.inputSchemaMapping | InputSchemaMapping: |
Hierdoor kunt u publiceren met behulp van aangepaste gebeurtenisschema's. Een InputSchemaMapping kan worden opgegeven om verschillende eigenschappen van een bronschema toe te wijzen aan verschillende vereiste eigenschappen van het EventGridEvent-schema. |
|
properties.metricResourceId |
string |
Metrische resource-id voor het onderwerp. |
|
properties.privateEndpointConnections | |||
properties.provisioningState |
Inrichtingsstatus van het onderwerp. |
||
properties.publicNetworkAccess | Enabled |
Hiermee wordt bepaald of verkeer is toegestaan via een openbaar netwerk. Dit is standaard ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door |
|
systemData |
De systeemmetagegevens met betrekking tot de onderwerpresource. |
||
tags |
object |
Tags van de resource. |
|
type |
string |
Type van de resource. |
TopicProvisioningState
Inrichtingsstatus van het onderwerp.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
TopicUpdateParameters
Eigenschappen van de onderwerpupdate
Name | Type | Default value | Description |
---|---|---|---|
identity |
Informatie over de id van de onderwerpresource. |
||
properties.dataResidencyBoundary |
De grens van de gegevenslocatie voor het onderwerp. |
||
properties.disableLocalAuth |
boolean |
Deze booleaanse waarde wordt gebruikt om lokale verificatie in of uit te schakelen. De standaardwaarde is false. Wanneer de eigenschap is ingesteld op true, wordt alleen het AAD-token gebruikt om te verifiëren of de gebruiker mag publiceren naar het onderwerp. |
|
properties.inboundIpRules |
Dit kan worden gebruikt om verkeer van specifieke IP-adressen te beperken in plaats van alle IP-adressen. Opmerking: deze worden alleen in overweging genomen als PublicNetworkAccess is ingeschakeld. |
||
properties.publicNetworkAccess | Enabled |
Hiermee wordt bepaald of verkeer is toegestaan via een openbaar netwerk. Dit is standaard ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door |
|
tags |
object |
Tags van de onderwerpresource. |
UserIdentityProperties
De informatie over de gebruikersidentiteit.
Name | Type | Description |
---|---|---|
clientId |
string |
De client-id van de door de gebruiker toegewezen identiteit. |
principalId |
string |
De principal-id van de door de gebruiker toegewezen identiteit. |