Dela via


New-AzEventGridSubscription

Asynkront skapar en ny händelseprenumeration eller uppdaterar en befintlig händelseprenumeration baserat på det angivna omfånget.

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

Description

Asynkront skapar en ny händelseprenumeration eller uppdaterar en befintlig händelseprenumeration baserat på det angivna omfånget.

Exempel

Exempel 1: Asynkront skapar en ny händelseprenumeration eller uppdaterar en befintlig händelseprenumeration baserat på det angivna omfånget.

$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

Asynkront skapar en ny händelseprenumeration eller uppdaterar en befintlig händelseprenumeration baserat på det angivna omfånget.

Exempel 2: Asynkront skapar en ny händelseprenumeration eller uppdaterar en befintlig händelseprenumeration baserat på det angivna omfånget.

$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

Asynkront skapar en ny händelseprenumeration eller uppdaterar en befintlig händelseprenumeration baserat på det angivna omfånget.

Parametrar

-AsJob

Kör kommandot som ett jobb

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DeadLetterWithResourceIdentityType

Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

Användaridentiteten som är associerad med resursen.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultProfile

Parametern DefaultProfile fungerar inte. Använd parametern SubscriptionId när den är tillgänglig om du kör cmdleten mot en annan prenumeration.

Typ:PSObject
Alias:AzureRMContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DeliveryWithResourceIdentityDestination

Information om målet där händelser måste levereras för händelseprenumerationen. Använder Azure Event Grids identitet för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

Typ:IEventSubscriptionDestination
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DeliveryWithResourceIdentityType

Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DeliveryWithResourceIdentityUserAssignedIdentity

Användaridentiteten som är associerad med resursen.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Destination

Information om målet där händelser måste levereras för händelseprenumerationen. Använder Azure Event Grids identitet för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.

Typ:IEventSubscriptionDestination
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-EventDeliverySchema

Händelseleveransschemat för händelseprenumerationen.

Typ:String
Alias:DeliverySchema
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ExpirationTimeUtc

Förfallotid för händelseprenumerationen.

Typ:DateTime
Alias:ExpirationDate
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-FilterAdvancedFilter

En matris med avancerade filter som används för att filtrera händelseprenumerationer.

Typ:IAdvancedFilter[]
Alias:AdvancedFilter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-FilterEnableAdvancedFilteringOnArray

Gör att avancerade filter kan utvärderas mot en matris med värden i stället för att förvänta sig ett singularvärde.

Typ:SwitchParameter
Alias:AdvancedFilteringOnArray
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-FilterIncludedEventType

En lista över tillämpliga händelsetyper som måste ingå i händelseprenumerationen. Om du vill prenumerera på alla standardhändelsetyper anger du IncludedEventTypes till null.

Typ:String[]
Alias:IncludedEventType
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-FilterIsSubjectCaseSensitive

Anger om egenskaperna SubjectBeginsWith och SubjectEndsWith för filtren ska jämföras på ett skiftlägeskänsligt sätt.

Typ:SwitchParameter
Alias:SubjectCaseSensitive
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-FilterSubjectBeginsWith

En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett resurssökvägsprefix. Formatet för detta beror på utgivaren av händelserna. Jokertecken stöds inte i den här sökvägen.

Typ:String
Alias:SubjectBeginsWith
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-FilterSubjectEndsWith

En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett suffix för resurssökväg. Jokertecken stöds inte i den här sökvägen.

Typ:String
Alias:SubjectEndsWith
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-InputObject

Identitetsparameter

Typ:IEventGridIdentity
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-JsonFilePath

Sökväg till Json-fil som angetts för åtgärden Skapa

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-JsonString

Json-sträng som har angetts för åtgärden Skapa

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Label

Lista över användardefinierade etiketter.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Name

Namn på händelseprenumerationen. Händelseprenumerationsnamn måste vara mellan 3 och 64 tecken långa och bör endast använda alfanumeriska bokstäver.

Typ:String
Alias:EventSubscriptionName
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-NoWait

Kör kommandot asynkront

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-PassThru

Returnerar sant när kommandot lyckas

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-RetryPolicyEventTimeToLiveInMinute

Time To Live (i minuter) för händelser.

Typ:Int32
Alias:EventTtl
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-RetryPolicyMaxDeliveryAttempt

Maximalt antal återförsök av leveransförsök för händelser.

Typ:Int32
Alias:MaxDeliveryAttempt
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Scope

Identifieraren för den resurs som händelseprenumerationen måste skapas eller uppdateras till. Omfånget kan vara en prenumeration, en resursgrupp eller en resurs på den översta nivån som tillhör ett namnområde för resursprovidern eller ett EventGrid-ämne. Använd till exempel '/subscriptions/{subscriptionId}/' för en prenumeration, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' för en resursgrupp, och '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' för en resurs och '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' för ett EventGrid-ämne.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

IEventGridIdentity

Utdata

IEventSubscription