New-AzEventGridSubscription

Modul:

Az.EventGrid

Asynchronně vytvoří nové odběr událostí nebo aktualizuje existující odběr událostí na základě zadaného oboru.

Syntaxe

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

Description

Asynchronně vytvoří nové odběr událostí nebo aktualizuje existující odběr událostí na základě zadaného oboru.

Příklady

Příklad 1: Asynchronní vytvoření nového odběru událostí nebo aktualizace existujícího odběru událostí na základě zadaného oboru.

$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

Asynchronně vytvoří nové odběr událostí nebo aktualizuje existující odběr událostí na základě zadaného oboru.

Příklad 2: Asynchronní vytvoření nového odběru událostí nebo aktualizace existujícího odběru událostí na základě zadaného oboru.

$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

Asynchronně vytvoří nové odběr událostí nebo aktualizuje existující odběr událostí na základě zadaného oboru.

Parametry

-AsJob

Spuštění příkazu jako úlohy

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DeadLetterWithResourceIdentityType

Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DeadLetterWithResourceIdentityUserAssignedIdentity

Identita uživatele přidružená k prostředku.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DefaultProfile

Parametr DefaultProfile není funkční. Pokud je k dispozici spuštění rutiny pro jiné předplatné, použijte parametr SubscriptionId.

Typ:	PSObject
Aliasy:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DeliveryWithResourceIdentityDestination

Informace o cíli, kde se události musí doručovat pro odběr událostí. Používá identitu služby Azure Event Grid k získání ověřovacích tokenů používaných během doručování nebo nedoručování dopisů.

Typ:	IEventSubscriptionDestination
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DeliveryWithResourceIdentityType

Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DeliveryWithResourceIdentityUserAssignedIdentity

Identita uživatele přidružená k prostředku.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Destination

Informace o cíli, kde se události musí doručovat pro odběr událostí. Používá identitu služby Azure Event Grid k získání ověřovacích tokenů používaných během doručování nebo nedoručování dopisů.

Typ:	IEventSubscriptionDestination
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-EventDeliverySchema

Schéma doručování událostí pro odběr událostí.

Typ:	String
Aliasy:	DeliverySchema
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ExpirationTimeUtc

Čas vypršení platnosti odběru události.

Typ:	DateTime
Aliasy:	ExpirationDate
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-FilterAdvancedFilter

Pole rozšířených filtrů, které se používají k filtrování odběrů událostí.

Typ:	IAdvancedFilter[]
Aliasy:	AdvancedFilter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-FilterEnableAdvancedFilteringOnArray

Umožňuje, aby se rozšířené filtry vyhodnocovaly proti poli hodnot místo toho, aby nečekaly hodnotu v jednotném čísle.

Typ:	SwitchParameter
Aliasy:	AdvancedFilteringOnArray
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-FilterIncludedEventType

Seznam použitelných typů událostí, které musí být součástí odběru událostí. Pokud se chcete přihlásit k odběru všech výchozích typů událostí, nastavte IncludedEventTypes na hodnotu null.

Typ:	String[]
Aliasy:	IncludedEventType
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-FilterIsSubjectCaseSensitive

Určuje, zda SubjectBeginsWith a SubjectEndsWith vlastnosti filtershould se porovná s rozlišováním velkých a malých písmen.

Typ:	SwitchParameter
Aliasy:	SubjectCaseSensitive
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-FilterSubjectBeginsWith

Volitelný řetězec pro filtrování událostí odběru událostí na základě předpony cesty prostředku. Formát závisí na vydavateli událostí. V této cestě nejsou podporovány zástupné znaky.

Typ:	String
Aliasy:	SubjectBeginsWith
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-FilterSubjectEndsWith

Volitelný řetězec pro filtrování událostí odběru událostí na základě přípony cesty prostředku. V této cestě nejsou podporovány zástupné znaky.

Typ:	String
Aliasy:	SubjectEndsWith
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-InputObject

Parametr identity

Typ:	IEventGridIdentity
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-JsonFilePath

Cesta k souboru JSON zadanému pro operaci Vytvoření

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-JsonString

Řetězec JSON zadaný pro operaci Vytvoření

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Label

Seznam popisků definovaných uživatelem

Typ:	String[]
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Name

Název odběru události. Názvy odběrů událostí musí mít délku 3 až 64 znaků a měly by používat pouze alfanumerická písmena.

Typ:	String
Aliasy:	EventSubscriptionName
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-NoWait

Asynchronní spuštění příkazu

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-PassThru

Vrátí hodnotu true, když příkaz proběhne úspěšně.

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-RetryPolicyEventTimeToLiveInMinute

Time To Live (v minutách) pro události.

Typ:	Int32
Aliasy:	EventTtl
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-RetryPolicyMaxDeliveryAttempt

Maximální počet pokusů o opakování doručení událostí

Typ:	Int32
Aliasy:	MaxDeliveryAttempt
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Scope

Identifikátor prostředku, na který je potřeba vytvořit nebo aktualizovat odběr událostí. Oborem může být předplatné, skupina prostředků nebo prostředek nejvyšší úrovně patřící do oboru názvů poskytovatele prostředků nebo téma EventGrid. Například pro předplatné použijte /subscriptions/{subscriptionId}/, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro skupinu prostředků. a /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} pro prostředek a /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName} pro téma EventGridu.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

Vstupy

IEventGridIdentity

Výstupy

IEventSubscription