Freigeben über


New-AzEventGridSubscription

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

Syntax

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

Beschreibung

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

Beispiele

Beispiel 1: Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

$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

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

Beispiel 2: Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

$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

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

Parameter

-AsJob

Ausführen des Befehls als Auftrag

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliases:cf
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-DeadLetterWithResourceIdentityType

Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

Die der Ressource zugeordnete Benutzeridentität.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Der Parameter DefaultProfile ist nicht funktionsfähig. Verwenden Sie den Parameter "SubscriptionId", wenn sie verfügbar ist, wenn Sie das Cmdlet für ein anderes Abonnement ausführen.

Typ:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryWithResourceIdentityDestination

Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Inschrift verwendet werden.

Typ:IEventSubscriptionDestination
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryWithResourceIdentityType

Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryWithResourceIdentityUserAssignedIdentity

Die der Ressource zugeordnete Benutzeridentität.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-Destination

Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Inschrift verwendet werden.

Typ:IEventSubscriptionDestination
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-EventDeliverySchema

Das Ereignisübermittlungsschema für das Ereignisabonnement.

Typ:String
Aliases:DeliverySchema
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-ExpirationTimeUtc

Ablaufzeit des Ereignisabonnements.

Typ:DateTime
Aliases:ExpirationDate
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterAdvancedFilter

Ein Array erweiterter Filter, die zum Filtern von Ereignisabonnements verwendet werden.

Typ:IAdvancedFilter[]
Aliases:AdvancedFilter
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterEnableAdvancedFilteringOnArray

Ermöglicht die Auswertung erweiterter Filter anhand eines Wertearrays, anstatt einen Singularwert zu erwarten.

Typ:SwitchParameter
Aliases:AdvancedFilteringOnArray
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterIncludedEventType

Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn alle Standardereignistypen abonniert werden sollen, legen Sie die IncludedEventTypes auf NULL fest.

Typ:String[]
Aliases:IncludedEventType
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterIsSubjectCaseSensitive

Gibt an, ob die Eigenschaften "SubjectBeginsWith" und "SubjectEndsWith" der Filter in sensitiver Weise verglichen werden sollen.

Typ:SwitchParameter
Aliases:SubjectCaseSensitive
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterSubjectBeginsWith

Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format dieser Ereignisse hängt vom Herausgeber der Ereignisse ab. Wild Karte Zeichen werden in diesem Pfad nicht unterstützt.

Typ:String
Aliases:SubjectBeginsWith
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterSubjectEndsWith

Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. Wild Karte Zeichen werden in diesem Pfad nicht unterstützt.

Typ:String
Aliases:SubjectEndsWith
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity-Parameter

Typ:IEventGridIdentity
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters:False

-JsonFilePath

Pfad der JSON-Datei, die für den Erstellungsvorgang bereitgestellt wird

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:False
Accept wildcard characters:False

-JsonString

Json-Zeichenfolge, die für den Create-Vorgang bereitgestellt wird

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:False
Accept wildcard characters:False

-Label

Liste der benutzerdefinierten Bezeichnungen.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Name des Ereignisabonnements. Ereignisabonnementnamen müssen zwischen 3 und 64 Zeichen lang sein und sollten nur alphanumerische Buchstaben verwenden.

Typ:String
Aliases:EventSubscriptionName
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Asynchrones Ausführen des Befehls

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Gibt true zurück, wenn der Befehl erfolgreich ist.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-RetryPolicyEventTimeToLiveInMinute

Time To Live (in Minuten) für Ereignisse.

Typ:Int32
Aliases:EventTtl
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-RetryPolicyMaxDeliveryAttempt

Maximale Anzahl von Wiederholungsversuchen für Ereignisse.

Typ:Int32
Aliases:MaxDeliveryAttempt
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Der Bezeichner der Ressource, auf die das Ereignisabonnement erstellt oder aktualisiert werden muss. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliases:wi
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

IEventGridIdentity

Ausgaben

IEventSubscription