System Topic Event Subscriptions - Create Or Update

Usługa:

Event Grid

Wersja interfejsu API:

2022-06-15

Tworzenie lub aktualizowanie subskrypcji zdarzeń dla tematu systemowego.
Asynchronicznie tworzy lub aktualizuje subskrypcję zdarzeń przy użyciu określonych parametrów. Istniejące subskrypcje zdarzeń zostaną zaktualizowane przy użyciu tego interfejsu API.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}?api-version=2022-06-15

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
eventSubscriptionName	path	True	string	Nazwa subskrypcji zdarzeń do utworzenia. Nazwy subskrypcji zdarzeń muszą mieć długość od 3 do 100 znaków i używać tylko liter alfanumerycznych.
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
systemTopicName	path	True	string	Nazwa tematu systemowego.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Treść żądania

Nazwa	Typ	Opis
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	Miejsce docelowe nieaktywnej subskrypcji zdarzeń. Każde zdarzenie, którego nie można dostarczyć do miejsca docelowego, jest wysyłane do miejsca docelowego utraconych wiadomości. Używa tożsamości Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania /utraconych komunikatów.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity	Miejsce docelowe utraconych komunikatów subskrypcji zdarzeń. Każde zdarzenie, którego nie można dostarczyć do miejsca docelowego, jest wysyłane do miejsca docelowego utraconych komunikatów. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (tj. temacie lub domenie), aby uzyskać tokeny uwierzytelniania używane podczas dostarczania /utraconych komunikatów.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (czyli temacie lub domenie) do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania /zakleszczenia.
properties.destination	EventSubscriptionDestination: WebHookEventSubscriptionDestination EventHubEventSubscriptionDestination StorageQueueEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination AzureFunctionEventSubscriptionDestination	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa tożsamości Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania / martwych listów.
properties.eventDeliverySchema	EventDeliverySchema	Schemat dostarczania zdarzeń dla subskrypcji zdarzeń.
properties.expirationTimeUtc	string	Czas wygaśnięcia subskrypcji zdarzeń.
properties.filter	EventSubscriptionFilter	Informacje o filtrze subskrypcji zdarzeń.
properties.labels	string[]	Lista etykiet zdefiniowanych przez użytkownika.
properties.retryPolicy	RetryPolicy	Zasady ponawiania prób dla zdarzeń. Może to służyć do konfigurowania maksymalnej liczby prób dostarczenia i czasu wygaśnięcia dla zdarzeń.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	EventSubscription	Utworzone
Other Status Codes		Odpowiedzi na błędy: *** 400 Nieprawidłowe żądanie. 500 Wewnętrzny błąd serwera.

Przykłady

SystemTopicEventSubscriptions_CreateOrUpdate

Przykładowe żądanie

HTTP

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

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionInner;
import com.azure.resourcemanager.eventgrid.models.EventSubscriptionFilter;
import com.azure.resourcemanager.eventgrid.models.WebhookEventSubscriptionDestination;

/** Samples for SystemTopicEventSubscriptions CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
     */
    /**
     * Sample code: SystemTopicEventSubscriptions_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void systemTopicEventSubscriptionsCreateOrUpdate(
        com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .systemTopicEventSubscriptions()
            .createOrUpdate(
                "examplerg",
                "exampleSystemTopic1",
                "exampleEventSubscriptionName1",
                new EventSubscriptionInner()
                    .withDestination(
                        new WebhookEventSubscriptionDestination().withEndpointUrl("https://requestb.in/15ksip71"))
                    .withFilter(
                        new EventSubscriptionFilter()
                            .withSubjectBeginsWith("ExamplePrefix")
                            .withSubjectEndsWith("ExampleSuffix")
                            .withIsSubjectCaseSensitive(false)),
                Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python system_topic_event_subscriptions_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.system_topic_event_subscriptions.begin_create_or_update(
        resource_group_name="examplerg",
        system_topic_name="exampleSystemTopic1",
        event_subscription_name="exampleEventSubscriptionName1",
        event_subscription_info={
            "properties": {
                "destination": {
                    "endpointType": "WebHook",
                    "properties": {"endpointUrl": "https://requestb.in/15ksip71"},
                },
                "filter": {
                    "isSubjectCaseSensitive": False,
                    "subjectBeginsWith": "ExamplePrefix",
                    "subjectEndsWith": "ExampleSuffix",
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
func ExampleSystemTopicEventSubscriptionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSystemTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleSystemTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
		Properties: &armeventgrid.EventSubscriptionProperties{
			Destination: &armeventgrid.WebHookEventSubscriptionDestination{
				EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
				Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
					EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
				},
			},
			Filter: &armeventgrid.EventSubscriptionFilter{
				IsSubjectCaseSensitive: to.Ptr(false),
				SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
				SubjectEndsWith:        to.Ptr("ExampleSuffix"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 *
 * @summary Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
 */
async function systemTopicEventSubscriptionsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const systemTopicName = "exampleSystemTopic1";
  const eventSubscriptionName = "exampleEventSubscriptionName1";
  const eventSubscriptionInfo = {
    destination: {
      endpointType: "WebHook",
      endpointUrl: "https://requestb.in/15ksip71",
    },
    filter: {
      isSubjectCaseSensitive: false,
      subjectBeginsWith: "ExamplePrefix",
      subjectEndsWith: "ExampleSuffix",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.systemTopicEventSubscriptions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    systemTopicName,
    eventSubscriptionName,
    eventSubscriptionInfo
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.EventGrid.Models;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
// this example is just showing the usage of "SystemTopicEventSubscriptions_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SystemTopicResource created on azure
// for more information of creating SystemTopicResource, please refer to the document of SystemTopicResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string systemTopicName = "exampleSystemTopic1";
ResourceIdentifier systemTopicResourceId = SystemTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, systemTopicName);
SystemTopicResource systemTopic = client.GetSystemTopicResource(systemTopicResourceId);

// get the collection of this SystemTopicEventSubscriptionResource
SystemTopicEventSubscriptionCollection collection = systemTopic.GetSystemTopicEventSubscriptions();

// invoke the operation
string eventSubscriptionName = "exampleEventSubscriptionName1";
EventGridSubscriptionData data = new EventGridSubscriptionData()
{
    Destination = new WebHookEventSubscriptionDestination()
    {
        Endpoint = new Uri("https://requestb.in/15ksip71"),
    },
    Filter = new EventSubscriptionFilter()
    {
        SubjectBeginsWith = "ExamplePrefix",
        SubjectEndsWith = "ExampleSuffix",
        IsSubjectCaseSensitive = false,
    },
};
ArmOperation<SystemTopicEventSubscriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, eventSubscriptionName, data);
SystemTopicEventSubscriptionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EventGridSubscriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:

201

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": null,
    "eventDeliverySchema": "EventGridSchema",
    "retryPolicy": {
      "maxDeliveryAttempts": 30,
      "eventTimeToLiveInMinutes": 1440
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1",
  "name": "exampleEventSubscriptionName1",
  "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions"
}

Definicje

Nazwa	Opis
AzureFunctionEventSubscriptionDestination	Informacje o miejscu docelowym funkcji platformy Azure dla subskrypcji zdarzeń.
BoolEqualsAdvancedFilter	Filtr zaawansowany boolEquals.
createdByType	Typ tożsamości, która utworzyła zasób.
DeadLetterWithResourceIdentity	Informacje o miejscu docelowym deadletter z tożsamością zasobu.
DeliveryWithResourceIdentity	Informacje o dostarczaniu subskrypcji zdarzeń z tożsamością zasobu.
DynamicDeliveryAttributeMapping	Szczegóły mapowania atrybutów dostarczania dynamicznego.
EventDeliverySchema	Schemat dostarczania zdarzeń dla subskrypcji zdarzeń.
EventHubEventSubscriptionDestination	Informacje o miejscu docelowym centrum zdarzeń dla subskrypcji zdarzeń.
EventSubscription	Subskrypcja zdarzeń
EventSubscriptionFilter	Filtruj pod kątem subskrypcji zdarzeń.
EventSubscriptionIdentity	Informacje o tożsamości z subskrypcją zdarzeń.
EventSubscriptionIdentityType	Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość.
EventSubscriptionProvisioningState	Stan aprowizacji subskrypcji zdarzeń.
HybridConnectionEventSubscriptionDestination	Informacje o lokalizacji docelowej HybridConnection dla subskrypcji zdarzeń.
IsNotNullAdvancedFilter	IsNotNull — filtr zaawansowany.
IsNullOrUndefinedAdvancedFilter	IsNullOrUndefined Filtr zaawansowany.
NumberGreaterThanAdvancedFilter	NumberGreaterThan Filtr zaawansowany.
NumberGreaterThanOrEqualsAdvancedFilter	NumberGreaterThanOrEquals Filtr zaawansowany.
NumberInAdvancedFilter	NumberIn — filtr zaawansowany.
NumberInRangeAdvancedFilter	Filtr zaawansowany NumberInRange.
NumberLessThanAdvancedFilter	NumberLessThan — filtr zaawansowany.
NumberLessThanOrEqualsAdvancedFilter	NumberLessThanOrEquals Filtr zaawansowany.
NumberNotInAdvancedFilter	NumberNotIn — filtr zaawansowany.
NumberNotInRangeAdvancedFilter	NumberNotInRange — filtr zaawansowany.
RetryPolicy	Informacje o zasadach ponawiania dla subskrypcji zdarzeń.
ServiceBusQueueEventSubscriptionDestination	Informacje o miejscu docelowym usługi Service Bus dla subskrypcji zdarzeń.
ServiceBusTopicEventSubscriptionDestination	Informacje o miejscu docelowym tematu usługi Service Bus dla subskrypcji zdarzeń.
StaticDeliveryAttributeMapping	Szczegóły mapowania atrybutów dostarczania statycznego.
StorageBlobDeadLetterDestination	Informacje o miejscu docelowym utraconych komunikatów na podstawie obiektu blob magazynu.
StorageQueueEventSubscriptionDestination	Informacje o miejscu docelowym kolejki magazynu dla subskrypcji zdarzeń.
StringBeginsWithAdvancedFilter	StringBeginsWith Filtr zaawansowany.
StringContainsAdvancedFilter	CiągContains Filtr zaawansowany.
StringEndsWithAdvancedFilter	StringEndsWith Filtr zaawansowany.
StringInAdvancedFilter	StringIn Advanced Filter.
StringNotBeginsWithAdvancedFilter	StringNotBeginsWith Filtr zaawansowany.
StringNotContainsAdvancedFilter	StringNotContains — filtr zaawansowany.
StringNotEndsWithAdvancedFilter	StringNotEndsWith Filtr zaawansowany.
StringNotInAdvancedFilter	StringNotIn — filtr zaawansowany.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
WebHookEventSubscriptionDestination	Informacje o miejscu docelowym elementu webhook dla subskrypcji zdarzeń.

AzureFunctionEventSubscriptionDestination

Informacje o miejscu docelowym funkcji platformy Azure dla subskrypcji zdarzeń.

Nazwa	Typ	Domyślna wartość	Opis
endpointType	string: AzureFunction		Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Szczegóły atrybutu dostarczania.
properties.maxEventsPerBatch	integer	1	Maksymalna liczba zdarzeń na partię.
properties.preferredBatchSizeInKilobytes	integer	64	Preferowany rozmiar partii w kilobajtach.
properties.resourceId	string		Identyfikator zasobu platformy Azure reprezentujący punkt końcowy docelowej funkcji platformy Azure subskrypcji zdarzeń.

BoolEqualsAdvancedFilter

Filtr zaawansowany boolEquals.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: BoolEquals	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
value	boolean	Wartość filtru logicznego.

createdByType

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

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DeadLetterWithResourceIdentity

Informacje o miejscu docelowym deadletter z tożsamością zasobu.

Nazwa	Typ	Opis
deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (tj. temacie lub domenie), aby uzyskać tokeny uwierzytelniania używane podczas dostarczania /utraconych komunikatów.
identity	EventSubscriptionIdentity	Tożsamość, która ma być używana w przypadku zdarzeń utraconych komunikatów.

DeliveryWithResourceIdentity

Informacje o dostarczaniu subskrypcji zdarzeń z tożsamością zasobu.

Nazwa	Typ	Opis
destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa tożsamości Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania /utraconych komunikatów.
identity	EventSubscriptionIdentity	Tożsamość do użycia podczas dostarczania zdarzeń.

DynamicDeliveryAttributeMapping

Szczegóły mapowania atrybutów dostarczania dynamicznego.

Nazwa	Typ	Opis
name	string	Nazwa atrybutu dostawy lub nagłówka.
properties.sourceField	string	Ścieżka JSON w zdarzeniu zawierającym wartość atrybutu.
type	string: Dynamic	Typ atrybutu dostarczania lub nazwy nagłówka.

EventDeliverySchema

Schemat dostarczania zdarzeń dla subskrypcji zdarzeń.

Nazwa	Typ	Opis
CloudEventSchemaV1_0	string
CustomInputSchema	string
EventGridSchema	string

EventHubEventSubscriptionDestination

Informacje o miejscu docelowym centrum zdarzeń dla subskrypcji zdarzeń.

Nazwa	Typ	Opis
endpointType	string: EventHub	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Szczegóły atrybutu dostarczania.
properties.resourceId	string	Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń.

EventSubscription

Subskrypcja zdarzeń

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu.
name	string		Nazwa zasobu.
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination		Miejsce docelowe utraconych komunikatów subskrypcji zdarzeń. Każde zdarzenie, którego nie można dostarczyć do miejsca docelowego, jest wysyłane do miejsca docelowego utraconych komunikatów. Używa tożsamości Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania /utraconych komunikatów.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity		Miejsce docelowe utraconych komunikatów subskrypcji zdarzeń. Każde zdarzenie, którego nie można dostarczyć do miejsca docelowego, jest wysyłane do miejsca docelowego utraconych komunikatów. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (tj. temacie lub domenie), aby uzyskać tokeny uwierzytelniania używane podczas dostarczania /utraconych komunikatów.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity		Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (tj. temacie lub domenie), aby uzyskać tokeny uwierzytelniania używane podczas dostarczania /utraconych komunikatów.
properties.destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination		Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa tożsamości Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania /utraconych komunikatów.
properties.eventDeliverySchema	EventDeliverySchema	EventGridSchema	Schemat dostarczania zdarzeń dla subskrypcji zdarzeń.
properties.expirationTimeUtc	string		Czas wygaśnięcia subskrypcji zdarzeń.
properties.filter	EventSubscriptionFilter		Informacje o filtrze subskrypcji zdarzeń.
properties.labels	string[]		Lista etykiet zdefiniowanych przez użytkownika.
properties.provisioningState	EventSubscriptionProvisioningState		Stan aprowizacji subskrypcji zdarzeń.
properties.retryPolicy	RetryPolicy		Zasady ponawiania dla zdarzeń. Może to służyć do konfigurowania maksymalnej liczby prób dostarczenia i czasu wygaśnięcia dla zdarzeń.
properties.topic	string		Nazwa tematu subskrypcji zdarzeń.
systemData	systemData		Metadane systemowe odnoszące się do zasobu subskrypcji zdarzeń.
type	string		Typ zasobu.

EventSubscriptionFilter

Filtruj pod kątem subskrypcji zdarzeń.

Nazwa	Typ	Domyślna wartość	Opis
advancedFilters	AdvancedFilter[]: BoolEqualsAdvancedFilter[] IsNotNullAdvancedFilter[] IsNullOrUndefinedAdvancedFilter[] NumberGreaterThanAdvancedFilter[] NumberGreaterThanOrEqualsAdvancedFilter[] NumberInAdvancedFilter[] NumberInRangeAdvancedFilter[] NumberLessThanAdvancedFilter[] NumberLessThanOrEqualsAdvancedFilter[] NumberNotInAdvancedFilter[] NumberNotInRangeAdvancedFilter[] StringBeginsWithAdvancedFilter[] StringContainsAdvancedFilter[] StringEndsWithAdvancedFilter[] StringInAdvancedFilter[] StringNotBeginsWithAdvancedFilter[] StringNotContainsAdvancedFilter[] StringNotEndsWithAdvancedFilter[] StringNotInAdvancedFilter[]		Tablica filtrów zaawansowanych, które są używane do filtrowania subskrypcji zdarzeń.
enableAdvancedFilteringOnArrays	boolean		Umożliwia ocenianie filtrów zaawansowanych względem tablicy wartości zamiast oczekiwać pojedynczej wartości.
includedEventTypes	string[]		Lista odpowiednich typów zdarzeń, które muszą być częścią subskrypcji zdarzeń. Jeśli chcesz zasubskrybować wszystkie domyślne typy zdarzeń, ustaw parametr IncludedEventTypes na wartość null.
isSubjectCaseSensitive	boolean	False	Określa, czy właściwości SubjectBeginsWith i SubjectEndsWith filtru powinny być porównywane w sposób uwzględniający wielkość liter.
subjectBeginsWith	string		Opcjonalny ciąg filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie prefiksu ścieżki zasobu. Format tego ustawienia zależy od wydawcy zdarzeń. Znaki wieloznaczne nie są obsługiwane w tej ścieżce.
subjectEndsWith	string		Opcjonalny ciąg do filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie sufiksu ścieżki zasobu. Znaki wieloznaczne nie są obsługiwane w tej ścieżce.

EventSubscriptionIdentity

Informacje o tożsamości z subskrypcją zdarzeń.

Nazwa	Typ	Opis
type	EventSubscriptionIdentityType	Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie dowolnej tożsamości.
userAssignedIdentity	string	Tożsamość użytkownika skojarzona z zasobem.

EventSubscriptionIdentityType

Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość.

Nazwa	Typ	Opis
SystemAssigned	string
UserAssigned	string

EventSubscriptionProvisioningState

Stan aprowizacji subskrypcji zdarzeń.

Nazwa	Typ	Opis
AwaitingManualAction	string
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

HybridConnectionEventSubscriptionDestination

Informacje o lokalizacji docelowej HybridConnection dla subskrypcji zdarzeń.

Nazwa	Typ	Opis
endpointType	string: HybridConnection	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Szczegóły atrybutu dostarczania.
properties.resourceId	string	Identyfikator zasobu platformy Azure połączenia hybrydowego, który jest miejscem docelowym subskrypcji zdarzeń.

IsNotNullAdvancedFilter

IsNotNull — filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: IsNotNull	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: IsNullOrUndefined	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.

NumberGreaterThanAdvancedFilter

NumberGreaterThan Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberGreaterThan	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
value	number	Wartość filtru.

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberGreaterThanOrEquals	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
value	number	Wartość filtru.

NumberInAdvancedFilter

NumberIn — filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberIn	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	number[]	Zestaw wartości filtru.

NumberInRangeAdvancedFilter

Filtr zaawansowany NumberInRange.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberInRange	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	number[]	Zestaw wartości filtru.

NumberLessThanAdvancedFilter

NumberLessThan — filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberLessThan	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
value	number	Wartość filtru.

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberLessThanOrEquals	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
value	number	Wartość filtru.

NumberNotInAdvancedFilter

NumberNotIn — filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberNotIn	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	number[]	Zestaw wartości filtru.

NumberNotInRangeAdvancedFilter

NumberNotInRange — filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: NumberNotInRange	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	number[]	Zestaw wartości filtru.

RetryPolicy

Informacje o zasadach ponawiania dla subskrypcji zdarzeń.

Nazwa	Typ	Domyślna wartość	Opis
eventTimeToLiveInMinutes	integer	1440	Czas wygaśnięcia (w minutach) dla zdarzeń.
maxDeliveryAttempts	integer	30	Maksymalna liczba prób ponawiania prób dostarczenia dla zdarzeń.

ServiceBusQueueEventSubscriptionDestination

Informacje o miejscu docelowym usługi Service Bus dla subskrypcji zdarzeń.

Nazwa	Typ	Opis
endpointType	string: ServiceBusQueue	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Szczegóły atrybutu dostarczania.
properties.resourceId	string	Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego usługi Service Bus subskrypcji zdarzeń.

ServiceBusTopicEventSubscriptionDestination

Informacje o miejscu docelowym tematu usługi Service Bus dla subskrypcji zdarzeń.

Nazwa	Typ	Opis
endpointType	string: ServiceBusTopic	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Szczegóły atrybutu dostarczania.
properties.resourceId	string	Identyfikator zasobu platformy Azure, który reprezentuje punkt końcowy miejsca docelowego tematu usługi Service Bus subskrypcji zdarzeń.

StaticDeliveryAttributeMapping

Szczegóły mapowania atrybutów dostarczania statycznego.

Nazwa	Typ	Domyślna wartość	Opis
name	string		Nazwa atrybutu dostawy lub nagłówka.
properties.isSecret	boolean	False	Flaga logiczna określająca, czy atrybut zawiera informacje poufne .
properties.value	string		Wartość atrybutu dostarczania.
type	string: Static		Typ atrybutu dostarczania lub nazwy nagłówka.

StorageBlobDeadLetterDestination

Informacje o miejscu docelowym utraconych komunikatów na podstawie obiektu blob magazynu.

Nazwa	Typ	Opis
endpointType	string: StorageBlob	Typ punktu końcowego dla miejsca docelowego utraconych komunikatów
properties.blobContainerName	string	Nazwa kontenera obiektów blob usługi Storage, który jest miejscem docelowym zdarzeń deadletter
properties.resourceId	string	Identyfikator zasobu platformy Azure konta magazynu, który jest miejscem docelowym zdarzeń deadletter

StorageQueueEventSubscriptionDestination

Informacje o miejscu docelowym kolejki magazynu dla subskrypcji zdarzeń.

Nazwa	Typ	Opis
endpointType	string: StorageQueue	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.
properties.queueMessageTimeToLiveInSeconds	integer	Czas wygaśnięcia komunikatu kolejki magazynu w sekundach.
properties.queueName	string	Nazwa kolejki usługi Storage w ramach konta magazynu, które jest miejscem docelowym subskrypcji zdarzeń.
properties.resourceId	string	Identyfikator zasobu platformy Azure konta magazynu, który zawiera kolejkę, która jest miejscem docelowym subskrypcji zdarzeń.

StringBeginsWithAdvancedFilter

StringBeginsWith Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringBeginsWith	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

StringContainsAdvancedFilter

CiągContains Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringContains	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

StringEndsWithAdvancedFilter

StringEndsWith Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringEndsWith	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

StringInAdvancedFilter

StringIn Advanced Filter.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringIn	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringNotBeginsWith	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

StringNotContainsAdvancedFilter

StringNotContains — filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringNotContains	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringNotEndsWith	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

StringNotInAdvancedFilter

StringNotIn — filtr zaawansowany.

Nazwa	Typ	Opis
key	string	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.
operatorType	string: StringNotIn	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.
values	string[]	Zestaw wartości filtru.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

WebHookEventSubscriptionDestination

Informacje o miejscu docelowym elementu webhook dla subskrypcji zdarzeń.

Nazwa	Typ	Domyślna wartość	Opis
endpointType	string: WebHook		Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.
properties.azureActiveDirectoryApplicationIdOrUri	string		Identyfikator aplikacji usługi Azure Active Directory lub identyfikator URI umożliwiający uzyskanie tokenu dostępu, który zostanie uwzględniony jako token elementu nośnego w żądaniach dostarczenia.
properties.azureActiveDirectoryTenantId	string		Identyfikator dzierżawy usługi Azure Active Directory umożliwiający uzyskanie tokenu dostępu, który zostanie dołączony jako token elementu nośnego w żądaniach dostarczenia.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Szczegóły atrybutu dostarczania.
properties.endpointBaseUrl	string		Podstawowy adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń.
properties.endpointUrl	string		Adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń.
properties.maxEventsPerBatch	integer	1	Maksymalna liczba zdarzeń na partię.
properties.preferredBatchSizeInKilobytes	integer	64	Preferowany rozmiar partii w kilobajtach.