Dela via


Event Subscriptions - Get

Hämta en händelseprenumeration.
Hämta egenskaper för en händelseprenumeration.

GET https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}?api-version=2022-06-15

URI-parametrar

Name I Obligatorisk Typ Description
eventSubscriptionName
path True

string

Namn på händelseprenumerationen.

scope
path True

string

Händelseprenumerationens omfattning. Omfånget kan vara en prenumeration, en resursgrupp eller en resurs på den översta nivån som tillhör ett namnområde för resursprovidern eller ett EventGrid-ämne. Använd till exempel '/subscriptions/{subscriptionId}/' för en prenumeration, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' för en resursgrupp, och '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' för en resurs och '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' för ett EventGrid-ämne.

api-version
query True

string

Version av API:et som ska användas med klientbegäran.

Svar

Name Typ Description
200 OK

EventSubscription

OK

Other Status Codes

Felsvar: ***

  • 400 Felaktig begäran.

  • 500 Internt serverfel.

Exempel

EventSubscriptions_GetForCustomTopic
EventSubscriptions_GetForCustomTopic_AzureFunctionDestination
EventSubscriptions_GetForCustomTopic_EventHubDestination
EventSubscriptions_GetForCustomTopic_HybridConnectionDestination
EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination
EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination
EventSubscriptions_GetForCustomTopic_StorageQueueDestination
EventSubscriptions_GetForCustomTopic_WebhookDestination
EventSubscriptions_GetForResource
EventSubscriptions_GetForResourceGroup
EventSubscriptions_GetForSubscription

EventSubscriptions_GetForCustomTopic

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_AzureFunctionDestination

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      },
      "endpointType": "AzureFunction"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_EventHubDestination

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_HybridConnectionDestination

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      },
      "endpointType": "HybridConnection"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      },
      "endpointType": "ServiceBusQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      },
      "endpointType": "ServiceBusTopic"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_StorageQueueDestination

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1",
        "queueMessageTimeToLiveInSeconds": 300
      },
      "endpointType": "StorageQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_WebhookDestination

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForResource

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForResourceGroup

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
  "name": "examplesubscription2",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForSubscription

Exempelbegäran

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

Exempelsvar

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
  "name": "examplesubscription3",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

Definitioner

Name Description
AzureFunctionEventSubscriptionDestination

Information om azure-funktionsmålet för en händelseprenumeration.

BoolEqualsAdvancedFilter

BoolEquals Avancerat filter.

createdByType

Den typ av identitet som skapade resursen.

DeadLetterWithResourceIdentity

Information om deadletter-målet med resursidentitet.

DeliveryWithResourceIdentity

Information om leveransen för en händelseprenumeration med resursidentitet.

DynamicDeliveryAttributeMapping

Information om mappning av dynamiska leveransattribut.

EventDeliverySchema

Händelseleveransschemat för händelseprenumerationen.

EventHubEventSubscriptionDestination

Information om händelsehubbens mål för en händelseprenumeration.

EventSubscription

Händelseprenumeration

EventSubscriptionFilter

Filtrera för händelseprenumerationen.

EventSubscriptionIdentity

Identitetsinformationen med händelseprenumerationen.

EventSubscriptionIdentityType

Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.

EventSubscriptionProvisioningState

Etableringstillstånd för händelseprenumerationen.

HybridConnectionEventSubscriptionDestination

Information om HybridConnection-målet för en händelseprenumeration.

IsNotNullAdvancedFilter

IsNotNull Avancerat filter.

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined Avancerat filter.

NumberGreaterThanAdvancedFilter

NumberGreaterThan Avancerat filter.

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals Avancerat filter.

NumberInAdvancedFilter

NumberIn Avancerat filter.

NumberInRangeAdvancedFilter

NumberInRange Avancerat filter.

NumberLessThanAdvancedFilter

NumberLessThan Avancerat filter.

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals Avancerat filter.

NumberNotInAdvancedFilter

NumberNotIn Avancerat filter.

NumberNotInRangeAdvancedFilter

NumberNotInRange Avancerat filter.

RetryPolicy

Information om återförsöksprincipen för en händelseprenumeration.

ServiceBusQueueEventSubscriptionDestination

Information om Service Bus-målet för en händelseprenumeration.

ServiceBusTopicEventSubscriptionDestination

Information om service bus-ämnesmålet för en händelseprenumeration.

StaticDeliveryAttributeMapping

Information om mappning av statiska leveransattribut.

StorageBlobDeadLetterDestination

Information om det lagringsblobbaserade målet med obeställbara bokstäver.

StorageQueueEventSubscriptionDestination

Information om lagringskömålet för en händelseprenumeration.

StringBeginsWithAdvancedFilter

StringBeginsWith Avancerat filter.

StringContainsAdvancedFilter

StringContains Avancerat filter.

StringEndsWithAdvancedFilter

StringEndsWith Avancerat filter.

StringInAdvancedFilter

StringIn Avancerat filter.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Avancerat filter.

StringNotContainsAdvancedFilter

StringNotContains Avancerat filter.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Avancerat filter.

StringNotInAdvancedFilter

StringNotIn Avancerat filter.

systemData

Metadata som rör skapande och senaste ändring av resursen.

WebHookEventSubscriptionDestination

Information om webhookens mål för en händelseprenumeration.

AzureFunctionEventSubscriptionDestination

Information om azure-funktionsmålet för en händelseprenumeration.

Name Typ Standardvärde Description
endpointType string:

AzureFunction

Typ av slutpunkt för händelseprenumerationsmålet.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Information om leveransattribut.

properties.maxEventsPerBatch

integer (int32)

1

Maximalt antal händelser per batch.

properties.preferredBatchSizeInKilobytes

integer (int32)

64

Önskad batchstorlek i Kilobytes.

properties.resourceId

string (arm-id)

Det Azure-resurs-ID som representerar slutpunkten för Azure-funktionsmålet för en händelseprenumeration.

BoolEqualsAdvancedFilter

BoolEquals Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

BoolEquals

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

value

boolean

Det booleska filtervärdet.

createdByType

Den typ av identitet som skapade resursen.

Värde Description
Application
Key
ManagedIdentity
User

DeadLetterWithResourceIdentity

Information om deadletter-målet med resursidentitet.

Name Typ Description
deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Information om målet där händelser måste levereras för händelseprenumerationen. Använder konfigurationen av hanterad identitet på den överordnade resursen (dvs. ämne eller domän) för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

identity

EventSubscriptionIdentity

Identiteten som ska användas vid händelser med obeställbara bokstäver.

DeliveryWithResourceIdentity

Information om leveransen för en händelseprenumeration med resursidentitet.

Name Typ Description
destination EventSubscriptionDestination:

Information om målet där händelser måste levereras för händelseprenumerationen. Använder Azure Event Grids identitet för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

identity

EventSubscriptionIdentity

Identiteten som ska användas när händelser levereras.

DynamicDeliveryAttributeMapping

Information om mappning av dynamiska leveransattribut.

Name Typ Description
name

string

Namnet på leveransattributet eller huvudet.

properties.sourceField

string

JSON-sökväg i händelsen som innehåller attributvärde.

type string:

Dynamic

Typ av leveransattribut eller rubriknamn.

EventDeliverySchema

Händelseleveransschemat för händelseprenumerationen.

Värde Description
CloudEventSchemaV1_0
CustomInputSchema
EventGridSchema

EventHubEventSubscriptionDestination

Information om händelsehubbens mål för en händelseprenumeration.

Name Typ Description
endpointType string:

EventHub

Typ av slutpunkt för händelseprenumerationsmålet.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Information om leveransattribut.

properties.resourceId

string (arm-id)

Det Azure-resurs-ID som representerar slutpunkten för ett Event Hub-mål för en händelseprenumeration.

EventSubscription

Händelseprenumeration

Name Typ Standardvärde Description
id

string

Fullständigt kvalificerad identifierare för resursen.

name

string

Namnet på resursen.

properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Målet för händelseprenumerationen med obeställbara bokstäver. Alla händelser som inte kan levereras till målet skickas till målet med obeställbara meddelanden. Använder Azure Event Grids identitet för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

properties.deadLetterWithResourceIdentity

DeadLetterWithResourceIdentity

Målet för händelseprenumerationen med obeställbara bokstäver. Alla händelser som inte kan levereras till målet skickas till målet med obeställbara meddelanden. Använder konfigurationen av hanterad identitet på den överordnade resursen (dvs. ämne eller domän) för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

properties.deliveryWithResourceIdentity

DeliveryWithResourceIdentity

Information om målet där händelser måste levereras för händelseprenumerationen. Använder konfigurationen av hanterad identitet på den överordnade resursen (dvs. ämne eller domän) för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

properties.destination EventSubscriptionDestination:

Information om målet där händelser måste levereras för händelseprenumerationen. Använder Azure Event Grids identitet för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

properties.eventDeliverySchema

EventDeliverySchema

EventGridSchema

Händelseleveransschemat för händelseprenumerationen.

properties.expirationTimeUtc

string (date-time)

Förfallotid för händelseprenumerationen.

properties.filter

EventSubscriptionFilter

Information om filtret för händelseprenumerationen.

properties.labels

string[]

Lista över användardefinierade etiketter.

properties.provisioningState

EventSubscriptionProvisioningState

Etableringstillstånd för händelseprenumerationen.

properties.retryPolicy

RetryPolicy

Återförsöksprincipen för händelser. Detta kan användas för att konfigurera maximalt antal leveransförsök och tid att leva för händelser.

properties.topic

string

Namn på ämnet för händelseprenumerationen.

systemData

systemData

Systemmetadata som rör resurs för händelseprenumeration.

type

string

Typ av resurs.

EventSubscriptionFilter

Filtrera för händelseprenumerationen.

Name Typ Standardvärde Description
advancedFilters AdvancedFilter[]:

En matris med avancerade filter som används för att filtrera händelseprenumerationer.

enableAdvancedFilteringOnArrays

boolean

Gör att avancerade filter kan utvärderas mot en matris med värden i stället för att förvänta sig ett singularvärde.

includedEventTypes

string[]

En lista över tillämpliga händelsetyper som måste ingå i händelseprenumerationen. Om du vill prenumerera på alla standardhändelsetyper anger du IncludedEventTypes till null.

isSubjectCaseSensitive

boolean

False

Anger om egenskaperna SubjectBeginsWith och SubjectEndsWith för filtret ska jämföras på ett skiftlägeskänsligt sätt.

subjectBeginsWith

string

En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett resurssökvägsprefix. Formatet för detta beror på utgivaren av händelserna. Jokertecken stöds inte i den här sökvägen.

subjectEndsWith

string

En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett suffix för resurssökväg. Jokertecken stöds inte i den här sökvägen.

EventSubscriptionIdentity

Identitetsinformationen med händelseprenumerationen.

Name Typ Description
type

EventSubscriptionIdentityType

Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.

userAssignedIdentity

string

Användaridentiteten som är associerad med resursen.

EventSubscriptionIdentityType

Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.

Värde Description
SystemAssigned
UserAssigned

EventSubscriptionProvisioningState

Etableringstillstånd för händelseprenumerationen.

Värde Description
AwaitingManualAction
Canceled
Creating
Deleting
Failed
Succeeded
Updating

HybridConnectionEventSubscriptionDestination

Information om HybridConnection-målet för en händelseprenumeration.

Name Typ Description
endpointType string:

HybridConnection

Typ av slutpunkt för händelseprenumerationsmålet.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Information om leveransattribut.

properties.resourceId

string (arm-id)

Azure-resurs-ID för en hybridanslutning som är målet för en händelseprenumeration.

IsNotNullAdvancedFilter

IsNotNull Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

IsNotNull

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

IsNullOrUndefined

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

NumberGreaterThanAdvancedFilter

NumberGreaterThan Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberGreaterThan

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

value

number (double)

Filtervärdet.

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberGreaterThanOrEquals

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

value

number (double)

Filtervärdet.

NumberInAdvancedFilter

NumberIn Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberIn

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

number[] (double)

Uppsättningen med filtervärden.

NumberInRangeAdvancedFilter

NumberInRange Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberInRange

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

number[] (double)

Uppsättningen med filtervärden.

NumberLessThanAdvancedFilter

NumberLessThan Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberLessThan

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

value

number (double)

Filtervärdet.

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberLessThanOrEquals

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

value

number (double)

Filtervärdet.

NumberNotInAdvancedFilter

NumberNotIn Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberNotIn

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

number[] (double)

Uppsättningen med filtervärden.

NumberNotInRangeAdvancedFilter

NumberNotInRange Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

NumberNotInRange

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

number[] (double)

Uppsättningen med filtervärden.

RetryPolicy

Information om återförsöksprincipen för en händelseprenumeration.

Name Typ Standardvärde Description
eventTimeToLiveInMinutes

integer (int32)

1440

Time To Live (i minuter) för händelser.

maxDeliveryAttempts

integer (int32)

30

Maximalt antal återförsök av leveransförsök för händelser.

ServiceBusQueueEventSubscriptionDestination

Information om Service Bus-målet för en händelseprenumeration.

Name Typ Description
endpointType string:

ServiceBusQueue

Typ av slutpunkt för händelseprenumerationsmålet.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Information om leveransattribut.

properties.resourceId

string (arm-id)

Det Azure-resurs-ID som representerar slutpunkten för Service Bus-målet för en händelseprenumeration.

ServiceBusTopicEventSubscriptionDestination

Information om service bus-ämnesmålet för en händelseprenumeration.

Name Typ Description
endpointType string:

ServiceBusTopic

Typ av slutpunkt för händelseprenumerationsmålet.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Information om leveransattribut.

properties.resourceId

string (arm-id)

Det Azure-resurs-ID som representerar slutpunkten för Service Bus Topic-målet för en händelseprenumeration.

StaticDeliveryAttributeMapping

Information om mappning av statiska leveransattribut.

Name Typ Standardvärde Description
name

string

Namnet på leveransattributet eller huvudet.

properties.isSecret

boolean

False

Boolesk flagga för att se om attributet innehåller känslig information .

properties.value

string

Värdet för leveransattributet.

type string:

Static

Typ av leveransattribut eller rubriknamn.

StorageBlobDeadLetterDestination

Information om det lagringsblobbaserade målet med obeställbara bokstäver.

Name Typ Description
endpointType string:

StorageBlob

Typ av slutpunkt för mål med obeställbara bokstäver

properties.blobContainerName

string

Namnet på lagringsblobcontainern som är målet för deadletter-händelserna

properties.resourceId

string (arm-id)

Azure-resurs-ID:t för lagringskontot som är målet för deadletter-händelserna

StorageQueueEventSubscriptionDestination

Information om lagringskömålet för en händelseprenumeration.

Name Typ Description
endpointType string:

StorageQueue

Typ av slutpunkt för händelseprenumerationsmålet.

properties.queueMessageTimeToLiveInSeconds

integer (int64)

Lagringskö meddelandetid att leva i sekunder.

properties.queueName

string

Namnet på lagringskö under ett lagringskonto som är målet för en händelseprenumeration.

properties.resourceId

string (arm-id)

Azure-resurs-ID för lagringskontot som innehåller kön som är målet för en händelseprenumeration.

StringBeginsWithAdvancedFilter

StringBeginsWith Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringBeginsWith

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

StringContainsAdvancedFilter

StringContains Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringContains

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

StringEndsWithAdvancedFilter

StringEndsWith Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringEndsWith

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

StringInAdvancedFilter

StringIn Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringIn

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringNotBeginsWith

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

StringNotContainsAdvancedFilter

StringNotContains Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringNotContains

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringNotEndsWith

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

StringNotInAdvancedFilter

StringNotIn Avancerat filter.

Name Typ Description
key

string

Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.

operatorType string:

StringNotIn

Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.

values

string[]

Uppsättningen med filtervärden.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

WebHookEventSubscriptionDestination

Information om webhookens mål för en händelseprenumeration.

Name Typ Standardvärde Description
endpointType string:

WebHook

Typ av slutpunkt för händelseprenumerationsmålet.

properties.azureActiveDirectoryApplicationIdOrUri

string

Azure Active Directory-program-ID eller URI för att hämta åtkomsttoken som ska ingå som ägartoken i leveransbegäranden.

properties.azureActiveDirectoryTenantId

string

Azure Active Directory-klient-ID:t för att hämta åtkomsttoken som ska inkluderas som ägartoken i leveransbegäranden.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Information om leveransattribut.

properties.endpointBaseUrl

string

Bas-URL:en som representerar slutpunkten för målet för en händelseprenumeration.

properties.endpointUrl

string

DEN URL som representerar slutpunkten för målet för en händelseprenumeration.

properties.maxEventsPerBatch

integer (int32)

1

Maximalt antal händelser per batch.

properties.preferredBatchSizeInKilobytes

integer (int32)

64

Önskad batchstorlek i Kilobytes.