Topics - Get

Erhalten Sie ein Thema.
Abrufen von Eigenschaften eines Themas.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2022-06-15

URI-Parameter

Name In Required Type Description
resourceGroupName
path True
  • string

Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers.

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

topicName
path True
  • string

Name des Themas.

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name Type Description
200 OK

OK

Other Status Codes

Fehlerantworten: ***

  • 400 Schlechte Anforderung.

  • 500 Interner Serverfehler.

Beispiele

Topics_Get

Sample Request

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2?api-version=2022-06-15

Sample Response

{
  "properties": {
    "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
  "location": "westcentralus",
  "name": "exampletopic2",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/topics"
}

Definitionen

ConnectionState

ConnectionState-Informationen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DataResidencyBoundary

Data Residency Grenze der Ressource.

IdentityInfo

Die Identitätsinformationen für die Ressource.

IdentityType

Der Typ der verwalteten Identität, die verwendet wird. Der Typ "SystemAssigned, UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerzuweisungen Identitäten. Der Typ "None" entfernt alle Identitäten.

InboundIpRule
InputSchema

Dadurch wird das Format bestimmt, das ereignisraster für eingehende Ereignisse erwartet werden soll, die in der Ereignisrasterdomänenressource veröffentlicht wurden.

IpActionType

Aktion, die basierend auf der Übereinstimmung oder keine Übereinstimmung der IpMask ausgeführt werden soll.

JsonField

Dies wird verwendet, um die Quelle einer Eingabeschemazuordnung für ein einzelnes Zielfeld im Ereignisrasterereignisschema auszudrücken. Dies wird derzeit in den Zuordnungen für die Eigenschaften "id", "thema" und "eventtime" verwendet. Dies stellt ein Feld im Eingabeereignisschema dar.

JsonFieldWithDefault

Dies wird verwendet, um die Quelle einer Eingabeschemazuordnung für ein einzelnes Zielfeld im Ereignisrasterereignisschema 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.

JsonInputSchemaMapping

Dies ermöglicht die Veröffentlichung im Ereignisraster mithilfe eines benutzerdefinierten Eingabeschemas. Dies kann verwendet werden, um Eigenschaften aus einem benutzerdefinierten Eingabe-JSON-Schema dem Ereignisschema "Event Grid" zuzuordnen.

PersistedConnectionStatus

Status der Verbindung.

PrivateEndpoint

PrivateEndpoint-Informationen.

PrivateEndpointConnection
PublicNetworkAccess

Dies bestimmt, ob der Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IPs beschränken, indem Sie konfigurieren

ResourceProvisioningState

Bereitstellungsstatus der privaten Endpunktverbindung.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Topic

EventGrid-Thema

TopicProvisioningState

Bereitstellungsstatus des Themas.

UserIdentityProperties

Die Informationen zur Benutzeridentität.

ConnectionState

ConnectionState-Informationen.

Name Type Description
actionsRequired
  • string

Erforderliche Aktionen (falls vorhanden).

description
  • string

Beschreibung des Verbindungszustands.

status

Status der Verbindung.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DataResidencyBoundary

Data Residency Grenze der Ressource.

Name Type Description
WithinGeopair
  • string
WithinRegion
  • string

IdentityInfo

Die Identitätsinformationen für die Ressource.

Name Type Description
principalId
  • string

Die Prinzipal-ID der Ressourcenidentität.

tenantId
  • string

Die Mandanten-ID der Ressource.

type

Der Typ der verwalteten Identität, die verwendet wird. Der Typ "SystemAssigned, UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerzuweisungen Identitäten. Der Typ "None" entfernt alle Identitäten.

userAssignedIdentities

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselbezüge sind ARM-Ressourcen-IDs im Formular: '/abonnements/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Diese Eigenschaft wird derzeit nicht verwendet und für zukünftige Nutzung reserviert.

IdentityType

Der Typ der verwalteten Identität, die verwendet wird. Der Typ "SystemAssigned, UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerzuweisungen Identitäten. Der Typ "None" entfernt alle Identitäten.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

InboundIpRule

Name Type Description
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 ereignisraster für eingehende Ereignisse erwartet werden soll, die in der Ereignisrasterdomänenressource veröffentlicht wurden.

Name Type Description
CloudEventSchemaV1_0
  • string
CustomEventSchema
  • string
EventGridSchema
  • string

IpActionType

Aktion, die basierend auf der Übereinstimmung oder keine Übereinstimmung der IpMask ausgeführt werden soll.

Name Type Description
Allow
  • string

JsonField

Dies wird verwendet, um die Quelle einer Eingabeschemazuordnung für ein einzelnes Zielfeld im Ereignisrasterereignisschema auszudrücken. Dies wird derzeit in den Zuordnungen für die Eigenschaften "id", "thema" und "eventtime" verwendet. Dies stellt ein Feld im Eingabeereignisschema dar.

Name Type Description
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 Ereignisrasterereignisschema 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 Type Description
defaultValue
  • string

Der Standardwert, der für die Zuordnung verwendet werden soll, wenn ein SourceField nicht bereitgestellt 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 im Ereignisraster mithilfe eines benutzerdefinierten Eingabeschemas. Dies kann verwendet werden, um Eigenschaften aus einem benutzerdefinierten Eingabe-JSON-Schema dem Ereignisschema "Event Grid" zuzuordnen.

Name Type Description
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 Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateEndpoint

PrivateEndpoint-Informationen.

Name Type Description
id
  • string

Der ARM-Bezeichner für private Endpunkte.

PrivateEndpointConnection

Name Type Description
id
  • string

Vollqualifizierter Bezeichner der Ressource.

name
  • string

Der Name der Ressource.

properties.groupIds
  • string[]

GroupIds aus der Ressource für den privaten Linkdienst.

properties.privateEndpoint

Die Ressource "Privater Endpunkt" für diese Verbindung.

properties.privateLinkServiceConnectionState

Details zum Zustand der Verbindung.

properties.provisioningState

Bereitstellungsstatus der privaten Endpunktverbindung.

type
  • string

Der Typ der Ressource.

PublicNetworkAccess

Dies bestimmt, ob der Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IPs beschränken, indem Sie konfigurieren

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceProvisioningState

Bereitstellungsstatus der privaten Endpunktverbindung.

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Type Description
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

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 Type Default Value Description
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 Grenze der Ressource.

properties.disableLocalAuth
  • boolean
False

Dieser boolesche Wert wird verwendet, um lokale Auth zu aktivieren oder zu deaktivieren. Standardwert ist "false". Wenn die Eigenschaft auf "true" festgelegt ist, wird nur AAD-Token verwendet, um zu authentifizieren, wenn Der Benutzer das Thema veröffentlichen darf.

properties.endpoint
  • string

Endpunkt für das Thema.

properties.inboundIpRules

Dies kann verwendet werden, um den Datenverkehr von bestimmten IPs anstelle aller IPs einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.

properties.inputSchema EventGridSchema

Dadurch wird das Format bestimmt, das ereignisraster für eingehende Ereignisse erwartet werden soll, die im Thema veröffentlicht wurden.

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

Metrische Ressourcen-ID für das Thema.

properties.privateEndpointConnections
properties.provisioningState

Bereitstellungsstatus des Themas.

properties.publicNetworkAccess Enabled

Dies bestimmt, ob der Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IPs beschränken, 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 Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

UserIdentityProperties

Die Informationen zur Benutzeridentität.

Name Type Description
clientId
  • string

Die Client-ID der zugewiesenen Benutzeridentität.

principalId
  • string

Die Prinzipal-ID der zugewiesenen Benutzeridentität.