Udostępnij przez

New-AzEventGridSubscription

Moduł:
Az.EventGrid Module

Asynchronicznie utwórz nową subskrypcję zdarzeń lub utwórz istniejącą subskrypcję zdarzeń na podstawie określonego zakresu.

Składnia

CreateExpanded (domyślnie) 

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>]

CreateViaJsonString 

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

CreateViaJsonFilePath 

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

CreateViaIdentityExpanded 

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 utwórz nową subskrypcję zdarzeń lub utwórz 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

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:por

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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ść.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

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

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DefaultProfile

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

Właściwości parametru

Typ:PSObject
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:AzureRMContext, AzureCredential

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:IEventSubscriptionDestination
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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ść.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DeliveryWithResourceIdentityUserAssignedIdentity

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

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:IEventSubscriptionDestination
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-EventDeliverySchema

Schemat dostarczania zdarzeń dla subskrypcji zdarzeń.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:DeliverySchema

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ExpirationTimeUtc

Czas wygaśnięcia subskrypcji zdarzeń.

Właściwości parametru

Typ:DateTime
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Data wygaśnięcia

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-FilterAdvancedFilter

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

Właściwości parametru

Typ:

IAdvancedFilter[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:AdvancedFilter

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-FilterEnableAdvancedFilteringOnArray

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

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:AdvancedFilteringOnArray

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:IncludedEventType

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-FilterIsSubjectCaseSensitive

Określa, czy właściwości SubjectBeginsWith i SubjectEndsWith filtru powinny być porównywane w sposób uwzględniający wielkość liter.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:SubjectCaseSensitive

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:SubjectBeginsWith

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:SubjectEndsWith

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-InputObject

Parametr tożsamości

Właściwości parametru

Typ:IEventGridIdentity
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateViaIdentityExpanded
Position:Named
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-JsonFilePath

Ścieżka pliku Json dostarczonego do operacji Tworzenia

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateViaJsonFilePath
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-JsonString

Ciąg Json dostarczony do operacji Tworzenia

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateViaJsonString
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Label

Lista etykiet zdefiniowanych przez użytkownika.

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:EventSubscriptionName

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaJsonString
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaJsonFilePath
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-NoWait

Uruchom polecenie asynchronicznie

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PassThru

Zwraca wartość true, gdy polecenie powiedzie się

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-RetryPolicyEventTimeToLiveInMinute

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

Właściwości parametru

Typ:Int32
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:EventTtl

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-RetryPolicyMaxDeliveryAttempt

Maksymalna liczba ponownych prób dostarczenia dla zdarzeń.

Właściwości parametru

Typ:Int32
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:MaxDeliveryAttempt

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaIdentityExpanded
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

CreateExpanded
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaJsonString
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
CreateViaJsonFilePath
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Wi

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

IEventGridIdentity

Dane wyjściowe

IEventSubscription