Condividi tramite


Event Subscriptions - Get

Ottenere una sottoscrizione di eventi.
Ottenere le proprietà di una sottoscrizione di eventi.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
eventSubscriptionName
path True

string

Nome della sottoscrizione dell'evento.

scope
path True

string

Ambito della sottoscrizione di eventi. L'ambito può essere una sottoscrizione o un gruppo di risorse o una risorsa di primo livello appartenente a uno spazio dei nomi del provider di risorse o un argomento EventGrid. Ad esempio, usare '/subscriptions/{subscriptionId}/' per una sottoscrizione, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per un gruppo di risorse, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' per una risorsa e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' per un argomento eventGrid.

api-version
query True

string

Versione dell'API da usare con la richiesta client.

Risposte

Nome Tipo Descrizione
200 OK

EventSubscription

OK

Other Status Codes

Risposte di errore:

  • 400 Richiesta non valida.

  • 500 - Errore interno del server.

Esempio

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Definizioni

Nome Descrizione
AzureFunctionEventSubscriptionDestination

Informazioni sulla destinazione della funzione di Azure per una sottoscrizione di eventi.

BoolEqualsAdvancedFilter

Filtro avanzato BoolEquals.

createdByType

Tipo di identità che ha creato la risorsa.

DeadLetterWithResourceIdentity

Informazioni sulla destinazione deadletter con l'identità delle risorse.

DeliveryWithResourceIdentity

Informazioni sul recapito per una sottoscrizione di eventi con identità della risorsa.

DynamicDeliveryAttributeMapping

Dettagli del mapping degli attributi per il recapito dinamico.

EventDeliverySchema

Schema di recapito eventi per la sottoscrizione dell'evento.

EventHubEventSubscriptionDestination

Informazioni sulla destinazione dell'hub eventi per una sottoscrizione di eventi.

EventSubscription

Sottoscrizione di eventi

EventSubscriptionFilter

Filtrare per la sottoscrizione dell'evento.

EventSubscriptionIdentity

Informazioni sull'identità con la sottoscrizione dell'evento.

EventSubscriptionIdentityType

Tipo di identità gestita usata. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà qualsiasi identità.

EventSubscriptionProvisioningState

Stato di provisioning della sottoscrizione dell'evento.

HybridConnectionEventSubscriptionDestination

Informazioni sulla destinazione HybridConnection per una sottoscrizione di eventi.

IsNotNullAdvancedFilter

Filtro avanzato IsNotNull.

IsNullOrUndefinedAdvancedFilter

Filtro avanzato IsNullOrUndefined.

NumberGreaterThanAdvancedFilter

Filtro avanzato NumberGreaterThan.

NumberGreaterThanOrEqualsAdvancedFilter

Filtro avanzato NumberGreaterThanOrEquals.

NumberInAdvancedFilter

NumberIn Advanced Filter.

NumberInRangeAdvancedFilter

NumberInRange Advanced Filter.

NumberLessThanAdvancedFilter

Filtro avanzato NumberLessThan.

NumberLessThanOrEqualsAdvancedFilter

Filtro avanzato NumberLessThanOrEquals.

NumberNotInAdvancedFilter

Filtro avanzato NumberNotIn.

NumberNotInRangeAdvancedFilter

Filtro avanzato NumberNotInRange.

RetryPolicy

Informazioni sui criteri di ripetizione dei tentativi per una sottoscrizione di eventi.

ServiceBusQueueEventSubscriptionDestination

Informazioni sulla destinazione del bus di servizio per una sottoscrizione di eventi.

ServiceBusTopicEventSubscriptionDestination

Informazioni sulla destinazione dell'argomento del bus di servizio per una sottoscrizione di eventi.

StaticDeliveryAttributeMapping

Dettagli del mapping degli attributi di recapito statici.

StorageBlobDeadLetterDestination

Informazioni sulla destinazione della lettera non recapitata basata sul BLOB di archiviazione.

StorageQueueEventSubscriptionDestination

Informazioni sulla destinazione della coda di archiviazione per una sottoscrizione di eventi.

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

StringContainsAdvancedFilter

String Contiene un filtro avanzato.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

StringInAdvancedFilter

StringIn Advanced Filter.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

StringNotContainsAdvancedFilter

StringNotContains Advanced Filter.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

StringNotInAdvancedFilter

Filtro avanzato StringNotIn.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

WebHookEventSubscriptionDestination

Informazioni sulla destinazione webhook per una sottoscrizione di eventi.

AzureFunctionEventSubscriptionDestination

Informazioni sulla destinazione della funzione di Azure per una sottoscrizione di eventi.

Nome Tipo Valore predefinito Descrizione
endpointType string:

AzureFunction

Tipo dell'endpoint per la destinazione della sottoscrizione dell'evento.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Dettagli dell'attributo di recapito.

properties.maxEventsPerBatch

integer

1

Numero massimo di eventi per batch.

properties.preferredBatchSizeInKilobytes

integer

64

Dimensioni batch preferite in Kilobyte.

properties.resourceId

string

ID risorsa di Azure che rappresenta l'endpoint della destinazione della funzione di Azure di una sottoscrizione dell'evento.

BoolEqualsAdvancedFilter

Filtro avanzato BoolEquals.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

BoolEquals

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

value

boolean

Valore del filtro booleano.

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

DeadLetterWithResourceIdentity

Informazioni sulla destinazione deadletter con l'identità delle risorse.

Nome Tipo Descrizione
deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Informazioni sulla destinazione in cui gli eventi devono essere recapitati per la sottoscrizione dell'evento. Usa la configurazione dell'identità gestita nella risorsa padre (ad esempio, argomento o dominio) per acquisire i token di autenticazione usati durante il recapito/la lettera non recapitata.

identity

EventSubscriptionIdentity

Identità da usare quando gli eventi di lettera non recapitabili.

DeliveryWithResourceIdentity

Informazioni sul recapito per una sottoscrizione di eventi con identità della risorsa.

Nome Tipo Descrizione
destination EventSubscriptionDestination:

Informazioni sulla destinazione in cui gli eventi devono essere recapitati per la sottoscrizione dell'evento. Usa l'identità di Griglia di eventi di Azure per acquisire i token di autenticazione usati durante il recapito o la lettera non recapitata.

identity

EventSubscriptionIdentity

Identità da usare per la distribuzione di eventi.

DynamicDeliveryAttributeMapping

Dettagli del mapping degli attributi per il recapito dinamico.

Nome Tipo Descrizione
name

string

Nome dell'attributo o dell'intestazione di recapito.

properties.sourceField

string

Percorso JSON nell'evento che contiene il valore dell'attributo.

type string:

Dynamic

Tipo dell'attributo di recapito o del nome dell'intestazione.

EventDeliverySchema

Schema di recapito eventi per la sottoscrizione dell'evento.

Nome Tipo Descrizione
CloudEventSchemaV1_0

string

CustomInputSchema

string

EventGridSchema

string

EventHubEventSubscriptionDestination

Informazioni sulla destinazione dell'hub eventi per una sottoscrizione di eventi.

Nome Tipo Descrizione
endpointType string:

EventHub

Tipo dell'endpoint per la destinazione della sottoscrizione dell'evento.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Dettagli dell'attributo di recapito.

properties.resourceId

string

ID risorsa di Azure che rappresenta l'endpoint di una destinazione hub eventi di una sottoscrizione dell'evento.

EventSubscription

Sottoscrizione di eventi

Nome Tipo Valore predefinito Descrizione
id

string

Identificatore completo della risorsa.

name

string

Nome della risorsa.

properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Destinazione lettera non recapitata della sottoscrizione dell'evento. Qualsiasi evento che non può essere recapitato alla destinazione della lettera morta viene inviato alla destinazione della lettera morta. Usa l'identità di Griglia di eventi di Azure per acquisire i token di autenticazione usati durante il recapito o la lettera non recapitata.

properties.deadLetterWithResourceIdentity

DeadLetterWithResourceIdentity

Destinazione lettera non recapitata della sottoscrizione dell'evento. Qualsiasi evento che non può essere recapitato alla destinazione della lettera morta viene inviato alla destinazione della lettera morta. Usa la configurazione dell'identità gestita nella risorsa padre (ad esempio, argomento o dominio) per acquisire i token di autenticazione usati durante il recapito/la lettera non recapitata.

properties.deliveryWithResourceIdentity

DeliveryWithResourceIdentity

Informazioni sulla destinazione in cui gli eventi devono essere recapitati per la sottoscrizione dell'evento. Usa la configurazione dell'identità gestita nella risorsa padre (ad esempio, argomento o dominio) per acquisire i token di autenticazione usati durante il recapito/la lettera non recapitata.

properties.destination EventSubscriptionDestination:

Informazioni sulla destinazione in cui gli eventi devono essere recapitati per la sottoscrizione dell'evento. Usa l'identità di Griglia di eventi di Azure per acquisire i token di autenticazione usati durante il recapito o la lettera non recapitata.

properties.eventDeliverySchema

EventDeliverySchema

EventGridSchema

Schema di recapito eventi per la sottoscrizione dell'evento.

properties.expirationTimeUtc

string

Data di scadenza della sottoscrizione dell'evento.

properties.filter

EventSubscriptionFilter

Informazioni sul filtro per la sottoscrizione dell'evento.

properties.labels

string[]

Elenco delle etichette definite dall'utente.

properties.provisioningState

EventSubscriptionProvisioningState

Stato di provisioning della sottoscrizione dell'evento.

properties.retryPolicy

RetryPolicy

Criteri di ripetizione dei tentativi per gli eventi. Questa operazione può essere usata per configurare il numero massimo di tentativi di recapito e il tempo per l'esecuzione degli eventi.

properties.topic

string

Nome dell'argomento della sottoscrizione dell'evento.

systemData

systemData

Metadati di sistema relativi alla risorsa Sottoscrizione eventi.

type

string

Tipo di risorsa.

EventSubscriptionFilter

Filtrare per la sottoscrizione dell'evento.

Nome Tipo Valore predefinito Descrizione
advancedFilters AdvancedFilter[]:

Matrice di filtri avanzati usati per filtrare le sottoscrizioni degli eventi.

enableAdvancedFilteringOnArrays

boolean

Consente di valutare i filtri avanzati in base a una matrice di valori anziché prevedere un valore singolare.

includedEventTypes

string[]

Elenco di tipi di eventi applicabili che devono essere parte della sottoscrizione dell'evento. Se si desidera sottoscrivere tutti i tipi di evento predefiniti, impostare i valori IncludedEventTypes su Null.

isSubjectCaseSensitive

boolean

False

Specifica se le proprietà SubjectBeginsWith e SubjectEndsWith del filtro devono essere confrontate in modo distinzione tra maiuscole e minuscole.

subjectBeginsWith

string

Stringa facoltativa per filtrare gli eventi per una sottoscrizione di eventi in base al prefisso del percorso della risorsa. Il formato di questo dipende dal server di pubblicazione degli eventi. I caratteri jolly non sono supportati in questo percorso.

subjectEndsWith

string

Stringa facoltativa per filtrare gli eventi per una sottoscrizione di eventi in base a un suffisso del percorso della risorsa. I caratteri jolly non sono supportati in questo percorso.

EventSubscriptionIdentity

Informazioni sull'identità con la sottoscrizione dell'evento.

Nome Tipo Descrizione
type

EventSubscriptionIdentityType

Tipo di identità gestita usata. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà qualsiasi identità.

userAssignedIdentity

string

Identità utente associata alla risorsa.

EventSubscriptionIdentityType

Tipo di identità gestita usata. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà qualsiasi identità.

Nome Tipo Descrizione
SystemAssigned

string

UserAssigned

string

EventSubscriptionProvisioningState

Stato di provisioning della sottoscrizione dell'evento.

Nome Tipo Descrizione
AwaitingManualAction

string

Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

HybridConnectionEventSubscriptionDestination

Informazioni sulla destinazione HybridConnection per una sottoscrizione di eventi.

Nome Tipo Descrizione
endpointType string:

HybridConnection

Tipo dell'endpoint per la destinazione della sottoscrizione dell'evento.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Dettagli dell'attributo di recapito.

properties.resourceId

string

ID risorsa di Azure di una connessione ibrida che rappresenta la destinazione di una sottoscrizione dell'evento.

IsNotNullAdvancedFilter

Filtro avanzato IsNotNull.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

IsNotNull

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

IsNullOrUndefinedAdvancedFilter

Filtro avanzato IsNullOrUndefined.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

IsNullOrUndefined

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

NumberGreaterThanAdvancedFilter

Filtro avanzato NumberGreaterThan.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberGreaterThan

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

value

number

Il valore del filtro.

NumberGreaterThanOrEqualsAdvancedFilter

Filtro avanzato NumberGreaterThanOrEquals.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberGreaterThanOrEquals

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

value

number

Il valore del filtro.

NumberInAdvancedFilter

NumberIn Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberIn

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

number[]

Set di valori di filtro.

NumberInRangeAdvancedFilter

NumberInRange Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberInRange

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

number[]

Set di valori di filtro.

NumberLessThanAdvancedFilter

Filtro avanzato NumberLessThan.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberLessThan

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

value

number

Il valore del filtro.

NumberLessThanOrEqualsAdvancedFilter

Filtro avanzato NumberLessThanOrEquals.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberLessThanOrEquals

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

value

number

Il valore del filtro.

NumberNotInAdvancedFilter

Filtro avanzato NumberNotIn.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberNotIn

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

number[]

Set di valori di filtro.

NumberNotInRangeAdvancedFilter

Filtro avanzato NumberNotInRange.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

NumberNotInRange

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

number[]

Set di valori di filtro.

RetryPolicy

Informazioni sui criteri di ripetizione dei tentativi per una sottoscrizione di eventi.

Nome Tipo Valore predefinito Descrizione
eventTimeToLiveInMinutes

integer

1440

Time To Live (in minuti) per gli eventi.

maxDeliveryAttempts

integer

30

Numero massimo di tentativi di recapito per gli eventi.

ServiceBusQueueEventSubscriptionDestination

Informazioni sulla destinazione del bus di servizio per una sottoscrizione di eventi.

Nome Tipo Descrizione
endpointType string:

ServiceBusQueue

Tipo dell'endpoint per la destinazione della sottoscrizione dell'evento.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Dettagli dell'attributo di recapito.

properties.resourceId

string

ID risorsa di Azure che rappresenta l'endpoint della destinazione del bus di servizio di una sottoscrizione dell'evento.

ServiceBusTopicEventSubscriptionDestination

Informazioni sulla destinazione dell'argomento del bus di servizio per una sottoscrizione di eventi.

Nome Tipo Descrizione
endpointType string:

ServiceBusTopic

Tipo dell'endpoint per la destinazione della sottoscrizione dell'evento.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Dettagli dell'attributo di recapito.

properties.resourceId

string

ID risorsa di Azure che rappresenta l'endpoint della destinazione argomento del bus di servizio di una sottoscrizione dell'evento.

StaticDeliveryAttributeMapping

Dettagli del mapping degli attributi di recapito statici.

Nome Tipo Valore predefinito Descrizione
name

string

Nome dell'attributo o dell'intestazione di recapito.

properties.isSecret

boolean

False

Flag booleano che indica se l'attributo contiene informazioni riservate.

properties.value

string

Valore dell'attributo di recapito.

type string:

Static

Tipo dell'attributo di recapito o del nome dell'intestazione.

StorageBlobDeadLetterDestination

Informazioni sulla destinazione della lettera non recapitata basata sul BLOB di archiviazione.

Nome Tipo Descrizione
endpointType string:

StorageBlob

Tipo di endpoint per la destinazione dei messaggi non recapitabili

properties.blobContainerName

string

Nome del contenitore BLOB di archiviazione che rappresenta la destinazione degli eventi non recapitabili

properties.resourceId

string

ID risorsa di Azure dell'account di archiviazione che rappresenta la destinazione degli eventi deadletter

StorageQueueEventSubscriptionDestination

Informazioni sulla destinazione della coda di archiviazione per una sottoscrizione di eventi.

Nome Tipo Descrizione
endpointType string:

StorageQueue

Tipo dell'endpoint per la destinazione della sottoscrizione dell'evento.

properties.queueMessageTimeToLiveInSeconds

integer

Tempo del messaggio della coda di archiviazione in secondi.

properties.queueName

string

Nome della coda di archiviazione in un account di archiviazione che rappresenta la destinazione di una sottoscrizione dell'evento.

properties.resourceId

string

ID risorsa di Azure dell'account di archiviazione che contiene la coda che rappresenta la destinazione di una sottoscrizione dell'evento.

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringBeginsWith

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

StringContainsAdvancedFilter

String Contiene un filtro avanzato.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringContains

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringEndsWith

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

StringInAdvancedFilter

StringIn Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringIn

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringNotBeginsWith

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

StringNotContainsAdvancedFilter

StringNotContains Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringNotContains

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringNotEndsWith

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

StringNotInAdvancedFilter

Filtro avanzato StringNotIn.

Nome Tipo Descrizione
key

string

Campo/proprietà nell'evento in base al quale si desidera filtrare.

operatorType string:

StringNotIn

Tipo di operatore usato per filtrare, ad esempio NumberIn, StringContains, BoolEquals e altri.

values

string[]

Set di valori di filtro.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima risorsa.

WebHookEventSubscriptionDestination

Informazioni sulla destinazione webhook per una sottoscrizione di eventi.

Nome Tipo Valore predefinito Descrizione
endpointType string:

WebHook

Tipo dell'endpoint per la destinazione della sottoscrizione dell'evento.

properties.azureActiveDirectoryApplicationIdOrUri

string

ID applicazione di Azure Active Directory o URI per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito.

properties.azureActiveDirectoryTenantId

string

ID tenant di Azure Active Directory per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Dettagli dell'attributo di recapito.

properties.endpointBaseUrl

string

URL di base che rappresenta l'endpoint della destinazione di una sottoscrizione dell'evento.

properties.endpointUrl

string

URL che rappresenta l'endpoint della destinazione di una sottoscrizione dell'evento.

properties.maxEventsPerBatch

integer

1

Numero massimo di eventi per batch.

properties.preferredBatchSizeInKilobytes

integer

64

Dimensioni batch preferite in Kilobyte.