Topics - Get

Uzyskaj temat.
Pobieranie właściwości tematu.

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

Parametry identyfikatora URI

Name In Required Type Description
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.

topicName
path True
  • string

Nazwa tematu.

api-version
query True
  • string

Wersja interfejsu API do użycia z żądaniem klienta.

Odpowiedzi

Name Type Description
200 OK

OK

Other Status Codes

Odpowiedzi na błędy: ***

  • 400 Nieprawidłowe żądanie.

  • 500 Wewnętrzny błąd serwera.

Przykłady

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

Definicje

ConnectionState

Informacje o stanie połączenia.

createdByType

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

DataResidencyBoundary

Data Residency granicę zasobu.

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.

Topic

EventGrid — temat

TopicProvisioningState

Stan aprowizacji tematu.

UserIdentityProperties

Informacje o tożsamości użytkownika.

ConnectionState

Informacje o stanie połączenia.

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

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

DataResidencyBoundary

Data Residency granicę zasobu.

Name Type Description
WithinGeopair
  • string
WithinRegion
  • string

IdentityInfo

Informacje o tożsamości zasobu.

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

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.

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

InboundIpRule

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

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

IpActionType

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

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

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

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

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

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateEndpoint

Informacje dotyczące prywatnego punktu końcowego.

Name Type Description
id
  • string

Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

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

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceProvisioningState

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

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

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

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

Name Type Default Value Description
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.

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

UserIdentityProperties

Informacje o tożsamości użytkownika.

Name Type Description
clientId
  • string

Identyfikator klienta tożsamości przypisanej przez użytkownika.

principalId
  • string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.