New-AzEventGridSubscription

Moduł:

Az.EventGrid

Asynchronicznie tworzy nową subskrypcję zdarzeń lub aktualizuje istniejącą subskrypcję zdarzeń na podstawie określonego zakresu.

Składnia

New-AzEventGridSubscription
   -Name <String>
   -Scope <String>
   [-DeadLetterWithResourceIdentityType <String>]
   [-DeadLetterWithResourceIdentityUserAssignedIdentity <String>]
   [-DeliveryWithResourceIdentityDestination <IEventSubscriptionDestination>]
   [-DeliveryWithResourceIdentityType <String>]
   [-DeliveryWithResourceIdentityUserAssignedIdentity <String>]
   [-Destination <IEventSubscriptionDestination>]
   [-EventDeliverySchema <String>]
   [-ExpirationTimeUtc <DateTime>]
   [-FilterAdvancedFilter <IAdvancedFilter[]>]
   [-FilterEnableAdvancedFilteringOnArray]
   [-FilterIncludedEventType <String[]>]
   [-FilterIsSubjectCaseSensitive]
   [-FilterSubjectBeginsWith <String>]
   [-FilterSubjectEndsWith <String>]
   [-Label <String[]>]
   [-RetryPolicyEventTimeToLiveInMinute <Int32>]
   [-RetryPolicyMaxDeliveryAttempt <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   -Name <String>
   -Scope <String>
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   -Name <String>
   -Scope <String>
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   -InputObject <IEventGridIdentity>
   [-DeadLetterWithResourceIdentityType <String>]
   [-DeadLetterWithResourceIdentityUserAssignedIdentity <String>]
   [-DeliveryWithResourceIdentityDestination <IEventSubscriptionDestination>]
   [-DeliveryWithResourceIdentityType <String>]
   [-DeliveryWithResourceIdentityUserAssignedIdentity <String>]
   [-Destination <IEventSubscriptionDestination>]
   [-EventDeliverySchema <String>]
   [-ExpirationTimeUtc <DateTime>]
   [-FilterAdvancedFilter <IAdvancedFilter[]>]
   [-FilterEnableAdvancedFilteringOnArray]
   [-FilterIncludedEventType <String[]>]
   [-FilterIsSubjectCaseSensitive]
   [-FilterSubjectBeginsWith <String>]
   [-FilterSubjectEndsWith <String>]
   [-Label <String[]>]
   [-RetryPolicyEventTimeToLiveInMinute <Int32>]
   [-RetryPolicyMaxDeliveryAttempt <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Opis

Asynchronicznie tworzy nową subskrypcję zdarzeń lub aktualizuje istniejącą subskrypcję zdarzeń na podstawie określonego zakresu.

Przykłady

Przykład 1: Asynchronicznie tworzy nową subskrypcję zdarzeń lub aktualizuje istniejącą subskrypcję zdarzeń na podstawie określonego zakresu.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
New-AzEventGridSubscription -Name azps-eventsub -Scope "subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" -Destination $obj -FilterIsSubjectCaseSensitive:$false

Name          ResourceGroupName
----          -----------------
azps-eventsub

Asynchronicznie tworzy nową subskrypcję zdarzeń lub aktualizuje istniejącą subskrypcję zdarzeń na podstawie określonego zakresu.

Przykład 2. Asynchronicznie tworzy nową subskrypcję zdarzeń lub aktualizuje istniejącą subskrypcję zdarzeń na podstawie określonego zakresu.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
$topic = Get-AzEventGridTopic -ResourceGroupName azps_test_group_eventgrid -Name azps-topic
New-AzEventGridSubscription -Name azps-eventsub -Scope $topic.Id -Destination $obj -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix"

Name          ResourceGroupName
----          -----------------
azps-eventsub azps_test_group_eventgrid

Asynchronicznie tworzy nową subskrypcję zdarzeń lub aktualizuje istniejącą subskrypcję zdarzeń na podstawie określonego zakresu.

Parametry

-AsJob

Uruchamianie polecenia jako zadania

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-DeadLetterWithResourceIdentityType

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 "None" usunie dowolną tożsamość.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-DeadLetterWithResourceIdentityUserAssignedIdentity

Tożsamość użytkownika skojarzona z zasobem.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-DefaultProfile

Parametr DefaultProfile nie działa. Użyj parametru SubscriptionId, jeśli jest dostępny, jeśli wykonuje polecenie cmdlet dla innej subskrypcji.

Typ:	PSObject
Aliasy:	AzureRMContext, AzureCredential
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-DeliveryWithResourceIdentityDestination

Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa tożsamości usługi Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania/zakleszczenia.

Typ:	IEventSubscriptionDestination
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-DeliveryWithResourceIdentityType

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 "None" usunie dowolną tożsamość.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-DeliveryWithResourceIdentityUserAssignedIdentity

Tożsamość użytkownika skojarzona z zasobem.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Destination

Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa tożsamości usługi Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania/zakleszczenia.

Typ:	IEventSubscriptionDestination
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-EventDeliverySchema

Schemat dostarczania zdarzeń dla subskrypcji zdarzeń.

Typ:	String
Aliasy:	DeliverySchema
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-ExpirationTimeUtc

Czas wygaśnięcia subskrypcji zdarzeń.

Typ:	DateTime
Aliasy:	ExpirationDate
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FilterAdvancedFilter

Tablica zaawansowanych filtrów używanych do filtrowania subskrypcji zdarzeń.

Typ:	IAdvancedFilter[]
Aliasy:	AdvancedFilter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FilterEnableAdvancedFilteringOnArray

Umożliwia ocenianie filtrów zaawansowanych względem tablicy wartości zamiast oczekiwać pojedynczej wartości.

Typ:	SwitchParameter
Aliasy:	AdvancedFilteringOnArray
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FilterIncludedEventType

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.

Typ:	String[]
Aliasy:	IncludedEventType
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FilterIsSubjectCaseSensitive

Określa, czy właściwości SubjectBeginsWith i SubjectEndsWith filtru należy porównać w sposób uwzględniający wielkość liter.

Typ:	SwitchParameter
Aliasy:	SubjectCaseSensitive
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FilterSubjectBeginsWith

Opcjonalny ciąg filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie prefiksu ścieżki zasobu. Format tego ustawienia zależy od wydawcy zdarzeń. Symbole wieloznaczne nie są obsługiwane w tej ścieżce.

Typ:	String
Aliasy:	SubjectBeginsWith
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FilterSubjectEndsWith

Opcjonalny ciąg do filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie sufiksu ścieżki zasobu. Symbole wieloznaczne nie są obsługiwane w tej ścieżce.

Typ:	String
Aliasy:	SubjectEndsWith
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-InputObject

Parametr tożsamości

Typ:	IEventGridIdentity
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-JsonFilePath

Ścieżka pliku Json dostarczonego do operacji Tworzenia

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-JsonString

Ciąg Json dostarczony do operacji Tworzenia

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Label

Lista etykiet zdefiniowanych przez użytkownika.

Typ:	String[]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Name

Nazwa subskrypcji zdarzeń. Nazwy subskrypcji zdarzeń muszą mieć długość od 3 do 64 znaków i powinny używać tylko liter alfanumerycznych.

Typ:	String
Aliasy:	EventSubscriptionName
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-NoWait

Uruchom polecenie asynchronicznie

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-PassThru

Zwraca wartość true, gdy polecenie powiedzie się

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-RetryPolicyEventTimeToLiveInMinute

Czas wygaśnięcia (w minutach) dla zdarzeń.

Typ:	Int32
Aliasy:	EventTtl
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-RetryPolicyMaxDeliveryAttempt

Maksymalna liczba ponownych prób dostarczenia dla zdarzeń.

Typ:	Int32
Aliasy:	MaxDeliveryAttempt
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Scope

Identyfikator zasobu, do którego należy utworzyć lub zaktualizować subskrypcję zdarzeń. Zakresem może być subskrypcja lub grupa zasobów albo zasób najwyższego poziomu należący do przestrzeni nazw dostawcy zasobów lub temat EventGrid. Na przykład użyj wartości "/subscriptions/{subscriptionId}/" dla subskrypcji, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" dla grupy zasobów, i "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" dla zasobu i "/subscriptions/{subscriptions}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}" dla tematu usługi EventGrid.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

IEventGridIdentity

Dane wyjściowe

IEventSubscription