Namespace Topic Event Subscriptions - Get
Rufen Sie ein Ereignisabonnement eines Namespacethemas ab.
Ruft Eigenschaften eines Ereignisabonnements eines Namespacethemas ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}?api-version=2023-06-01-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
event
|
path | True |
string |
Name des Ereignisabonnements. Ereignisabonnementnamen dürfen zwischen 3 und 100 Zeichen lang sein und nur alphanumerische Buchstaben verwenden. Regex pattern: |
namespace
|
path | True |
string |
Name des Namespace. Regex pattern: |
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 Namespacethemas. Regex pattern: |
api-version
|
query | True |
string |
Version der API, die mit der Clientanforderung verwendet werden soll. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Fehlerantwort zurückgegeben, wenn die Anforderung nicht erfolgreich war. |
Beispiele
NamespaceTopicEventSubscriptions_Get
Sample Request
GET https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/examplenamespace2/topics/examplenamespacetopic2/eventSubscriptions/examplenamespacetopicEventSub1?api-version=2023-06-01-preview
Sample Response
{
"properties": {
"provisioningState": "Succeeded",
"deliveryConfiguration": {
"deliveryMode": "Queue",
"queue": {
"receiveLockDurationInSeconds": 60,
"maxDeliveryCount": 4,
"eventTimeToLive": "P1D"
}
},
"eventDeliverySchema": "CloudEventSchemaV1_0"
},
"id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/examplenamespace2/topics/examplenamespacetopic2/eventSubscriptions/examplenamespacetopicEventSub2",
"name": "examplenamespacetopicEventSub2",
"type": "Microsoft.EventGrid/namespaces/topics/eventsubscriptions",
"systemData": null
}
Definitionen
Name | Beschreibung |
---|---|
Bool |
BoolEquals-Filter. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Dead |
Informationen zum Deadletterziel mit Ressourcenidentität. |
Delivery |
Eigenschaften der Übermittlungskonfigurationsinformationen des Ereignisabonnements. |
Delivery |
Übermittlungsmodus des Ereignisabonnements. |
Delivery |
Das Ereignisübermittlungsschema für das Ereignisabonnement. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Fehlerdetails. |
Error |
Fehlerantwort |
Event |
Die Identitätsinformationen mit dem Ereignisabonnement. |
Event |
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. |
Filters |
Filterkonfiguration für das Ereignisabonnement. |
Is |
IsNotNull-Filter. |
Is |
IsNullOrUndefined-Filter. |
Number |
NumberGreaterThan Filter. |
Number |
NumberGreaterThanOrEquals-Filter. |
Number |
NumberIn-Filter. |
Number |
NumberInRange-Filter. |
Number |
NumberLessThan-Filter. |
Number |
NumberLessThanOrEquals-Filter. |
Number |
NumberNotIn-Filter. |
Number |
NumberNotInRange-Filter. |
Queue |
Eigenschaften der Warteschlangeninformationen für das Ereignisabonnement. |
Storage |
Informationen zum Speicherblob-basierten Ziel für unzustellbare Buchstaben. |
String |
StringBeginsWith Filter. |
String |
StringContains-Filter. |
String |
StringEndsWith Filter. |
String |
StringIn-Filter. |
String |
StringNotBeginsWith Filter. |
String |
StringNotContains-Filter. |
String |
StringNotEndsWith Filter. |
String |
StringNotIn-Filter. |
Subscription |
Ereignisabonnement. |
Subscription |
Bereitstellungsstatus des Ereignisabonnements. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
BoolEqualsFilter
BoolEquals-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Bool |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
value |
boolean |
Der boolesche Filterwert. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DeadLetterWithResourceIdentity
Informationen zum Deadletterziel mit Ressourcenidentität.
Name | Typ | Beschreibung |
---|---|---|
deadLetterDestination | DeadLetterDestination: |
Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. das Thema oder die Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
identity |
Die Identität, die bei Ereignissen mit unzustellbaren Buchstaben verwendet werden soll. |
DeliveryConfiguration
Eigenschaften der Übermittlungskonfigurationsinformationen des Ereignisabonnements.
Name | Typ | Beschreibung |
---|---|---|
deliveryMode |
Übermittlungsmodus des Ereignisabonnements. |
|
queue |
Diese Eigenschaft sollte aufgefüllt werden, wenn deliveryMode eine Warteschlange ist und Informationen zum Warteschlangenabonnement darstellt. |
DeliveryMode
Übermittlungsmodus des Ereignisabonnements.
Name | Typ | Beschreibung |
---|---|---|
Queue |
string |
DeliverySchema
Das Ereignisübermittlungsschema für das Ereignisabonnement.
Name | Typ | Beschreibung |
---|---|---|
CloudEventSchemaV1_0 |
string |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Infotyp. |
ErrorDetail
Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen zum Fehler. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
EventSubscriptionIdentity
Die Identitätsinformationen mit dem Ereignisabonnement.
Name | Typ | Beschreibung |
---|---|---|
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. |
|
userAssignedIdentity |
string |
Die der Ressource zugeordnete Benutzeridentität. |
EventSubscriptionIdentityType
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 |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
FiltersConfiguration
Filterkonfiguration für das Ereignisabonnement.
Name | Typ | Beschreibung |
---|---|---|
filters |
Filter[]:
|
Ein Array von Filtern, die zum Filtern von Ereignisabonnements verwendet werden. |
includedEventTypes |
string[] |
Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn sie alle Standardereignistypen abonnieren möchten, legen Sie die IncludedEventTypes auf NULL fest. |
IsNotNullFilter
IsNotNull-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Is |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
IsNullOrUndefinedFilter
IsNullOrUndefined-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Is |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
NumberGreaterThanFilter
NumberGreaterThan Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
value |
number |
Der Filterwert. |
NumberGreaterThanOrEqualsFilter
NumberGreaterThanOrEquals-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
value |
number |
Der Filterwert. |
NumberInFilter
NumberIn-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
number[] |
Der Satz von Filterwerten. |
NumberInRangeFilter
NumberInRange-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
number[] |
Der Satz von Filterwerten. |
NumberLessThanFilter
NumberLessThan-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
value |
number |
Der Filterwert. |
NumberLessThanOrEqualsFilter
NumberLessThanOrEquals-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
value |
number |
Der Filterwert. |
NumberNotInFilter
NumberNotIn-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
number[] |
Der Satz von Filterwerten. |
NumberNotInRangeFilter
NumberNotInRange-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
Number |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
number[] |
Der Satz von Filterwerten. |
QueueInfo
Eigenschaften der Warteschlangeninformationen für das Ereignisabonnement.
Name | Typ | Beschreibung |
---|---|---|
deadLetterDestinationWithResourceIdentity |
Das Ziel für unzustellbare Nachrichten des Ereignisabonnements. Jedes Ereignis, das nicht an sein Ziel übermittelt werden kann, wird an das Ziel für unzustellbare Nachrichten gesendet. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. Thema), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
|
eventTimeToLive |
string |
Dauer der Zeitspanne im ISO 8601-Format, die bestimmt, wie lange Nachrichten ab dem Zeitpunkt der Veröffentlichung der Nachricht für das Abonnement verfügbar sind. Dieser Dauerwert wird im folgenden Format ausgedrückt: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", wobei: - (n) durch den Wert jedes Zeitelements ersetzt wird, das auf (n) folgt. - P ist der Bezeichner für die Dauer (oder Periode) und wird immer am Anfang der Dauer platziert. - Y ist der Jahresentwurf und folgt dem Wert für die Anzahl der Jahre. - M ist der Monatsentwurf und folgt dem Wert für die Anzahl der Monate. - W ist der Wochenentwurf und folgt dem Wert für die Anzahl der Wochen. - D ist der Tag-Designator und folgt dem Wert für die Anzahl der Tage. - T ist der Zeitentwurfsator und geht den Zeitkomponenten voran. - H ist der Stundenentwurf und folgt dem Wert für die Anzahl der Stunden. - M ist der Minutenentwurf und folgt dem Wert für die Anzahl der Minuten. - S ist der zweite Bezeichner und folgt dem Wert für die Anzahl der Sekunden. Dieser Dauerwert kann nicht größer als eventRetentionInDays des Themas festgelegt werden. Es handelt sich um ein optionales Feld, dessen Mindestwert 1 Minute und sein Maximum durch den EventRetentionInDays-Wert des Themas bestimmt wird. Die folgenden Beispiele sind gültige Werte: "P0DT23H12M" oder "PT23H12M": für eine Dauer von 23 Stunden und 12 Minuten. - "P1D" oder "P1DT0H0M0S": für die Dauer von 1 Tag. |
maxDeliveryCount |
integer |
Die maximale Übermittlungsanzahl der Ereignisse. |
receiveLockDurationInSeconds |
integer |
Maximaler Zeitraum in Sekunden, in dem die Nachricht in empfangenem Zustand (vom Client) und darauf wartet, akzeptiert, freigegeben oder abgelehnt zu werden. Wenn diese Zeit verstrichen ist, nachdem eine Nachricht vom Client empfangen wurde und nicht in akzeptiert (nicht verarbeitet), freigegeben oder abgelehnt wurde, ist die Nachricht für die Erneutes Senden verfügbar. Dies ist ein optionales Feld, wobei der Standardwert 60 Sekunden, minimum 60 Sekunden und das Maximum 300 Sekunden ist. |
StorageBlobDeadLetterDestination
Informationen zum Speicherblob-basierten Ziel für unzustellbare Buchstaben.
Name | Typ | Beschreibung |
---|---|---|
endpointType |
string:
Storage |
Typ des Endpunkts für das Ziel des unzustellbaren Buchstabens |
properties.blobContainerName |
string |
Der Name des Speicherblobcontainers, der das Ziel der Deadletterereignisse darstellt |
properties.resourceId |
string |
Die Azure-Ressourcen-ID des Speicherkontos, das das Ziel der Deadletterereignisse ist |
StringBeginsWithFilter
StringBeginsWith Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
StringContainsFilter
StringContains-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
StringEndsWithFilter
StringEndsWith Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
StringInFilter
StringIn-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
StringNotBeginsWithFilter
StringNotBeginsWith Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
StringNotContainsFilter
StringNotContains-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
StringNotEndsWithFilter
StringNotEndsWith Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
StringNotInFilter
StringNotIn-Filter.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. |
operatorType |
string:
String |
Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. |
values |
string[] |
Der Satz von Filterwerten. |
Subscription
Ereignisabonnement.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierter Bezeichner der Ressource. |
name |
string |
Der Name der Ressource. |
properties.deliveryConfiguration |
Informationen zur Übermittlungskonfiguration des Ereignisabonnements. |
|
properties.eventDeliverySchema |
Das Ereignisübermittlungsschema für das Ereignisabonnement. |
|
properties.filtersConfiguration |
Informationen zum Filter für das Ereignisabonnement. |
|
properties.provisioningState |
Bereitstellungsstatus des Ereignisabonnements. |
|
systemData |
Die Systemmetadaten im Zusammenhang mit der Ereignisabonnementressource. |
|
type |
string |
Der Typ der Ressource. |
SubscriptionProvisioningState
Bereitstellungsstatus des Ereignisabonnements.
Name | Typ | Beschreibung |
---|---|---|
AwaitingManualAction |
string |
|
Canceled |
string |
|
CreateFailed |
string |
|
Creating |
string |
|
DeleteFailed |
string |
|
Deleted |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
UpdatedFailed |
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. |