Topics - List By Subscription
Wyświetl listę tematów w ramach subskrypcji platformy Azure.
Wyświetl listę wszystkich tematów w ramach subskrypcji platformy Azure.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics?api-version=2022-06-15
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics?api-version=2022-06-15&$filter={$filter}&$top={$top}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
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. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia z żądaniem klienta. |
$filter
|
query |
string |
Zapytanie używane do filtrowania wyników wyszukiwania przy użyciu składni OData. Filtrowanie jest dozwolone tylko dla właściwości "name" i z ograniczoną liczbą operacji OData. Te operacje to: funkcja "contains" oraz następujące operacje logiczne: nie i, lub, eq (dla równej) i ne (dla nie równej). Nie są obsługiwane żadne operacje arytmetyczne. Poniżej przedstawiono prawidłowy przykład filtru: $filter=contains(namE, 'PATTERN') i name ne 'PATTERN-1'. Poniższy przykład nie jest prawidłowym przykładem filtru: $filter=location eq "westus". |
|
$top
|
query |
integer int32 |
Liczba wyników, które mają być zwracane na stronę dla operacji listy. Prawidłowy zakres dla najwyższego parametru to od 1 do 100. Jeśli nie zostanie określona, domyślna liczba zwracanych wyników to 20 elementów na stronę. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Odpowiedzi na błędy: ***
|
Przykłady
Topics_ListBySubscription
Sample Request
Sample Response
{
"value": [
{
"properties": {
"endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"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"
},
{
"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
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 niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość. |
Inbound |
|
Input |
Określa format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych w zasobie domeny usługi Event Grid. |
Ip |
Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask. |
Json |
Służy 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 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 o prywatnym punkcie końcowym. |
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 |
Temat EventGrid |
Topic |
Stan aprowizacji tematu. |
Topics |
Wynik operacji List Topics (Lista tematów) |
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 niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość. |
|
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 przyszłego użycia. |
IdentityType
Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość.
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 format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych 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 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 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 zdarzeń 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 Identyfikator zdarzenia usługi Event Grid. |
|
properties.subject |
Informacje o mapowaniu właściwości Temat zdarzenia usługi Event Grid. |
|
properties.topic |
Informacje o mapowaniu właściwości Temat zdarzenia usługi Event Grid. |
PersistedConnectionStatus
Stan połączenia.
Nazwa | Typ | Opis |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
Informacje o prywatnym punkcie końcowym.
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óły dotyczące stanu 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 zasobu (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
Temat EventGrid
Nazwa | Typ | Wartość domyślna | 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 |
Ten wartość logiczna służy do włączania lub wyłączania lokalnego uwierzytelniania. Wartość domyślna to false. Gdy właściwość ma wartość true, do uwierzytelniania będzie używany tylko token usługi AAD, 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 traktowane 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ń. Element InputSchemaMapping można określić, aby mapować różne 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 dotyczące 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 |
TopicsListResult
Wynik operacji List Topics (Lista tematów)
Nazwa | Typ | Opis |
---|---|---|
nextLink |
string |
Link do następnej strony tematów |
value |
Topic[] |
Kolekcja tematów |
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. |