New-AzEventGridSystemTopicEventSubscription

模組:

Az.EventGrid

以異步方式建立具有指定參數的事件訂閱。 現有的事件訂用帳戶將會使用此 API 更新。

語法

New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <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-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <String>
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <String>
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -SystemTopicInputObject <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>]

New-AzEventGridSystemTopicEventSubscription
   -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

以異步方式建立具有指定參數的事件訂閱。 現有的事件訂用帳戶將會使用此 API 更新。

範例

範例 1：以異步方式建立具有指定參數的事件訂閱。

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net"
New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName azps-evnetsub -ResourceGroupName azps_test_group_eventgrid -SystemTopicName azps-systopic -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix" -Destination $obj

Name          ResourceGroupName
----          -----------------
azps-evnetsub azps_test_group_eventgrid

以異步方式建立具有指定參數的事件訂閱。 現有的事件訂用帳戶將會使用此 API 更新。

參數

-AsJob

以作業身分執行命令

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

類型:	SwitchParameter
別名:	cf
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DeadLetterWithResourceIdentityType

所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DeadLetterWithResourceIdentityUserAssignedIdentity

與資源相關聯的使用者身分識別。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DefaultProfile

DefaultProfile 參數無法運作。 如果針對不同的訂用帳戶執行 Cmdlet，請使用 SubscriptionId 參數。

類型:	PSObject
別名:	AzureRMContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DeliveryWithResourceIdentityDestination

事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。

類型:	IEventSubscriptionDestination
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DeliveryWithResourceIdentityType

所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DeliveryWithResourceIdentityUserAssignedIdentity

與資源相關聯的使用者身分識別。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Destination

事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。

類型:	IEventSubscriptionDestination
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-EventDeliverySchema

事件訂閱的事件傳遞架構。

類型:	String
別名:	DeliverySchema
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-EventSubscriptionName

要建立的事件訂閱名稱。 事件訂閱名稱長度必須介於 3 到 100 個字元之間，且只能使用英數位元。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-ExpirationTimeUtc

事件訂閱的到期時間。

類型:	DateTime
別名:	ExpirationDate
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FilterAdvancedFilter

用於篩選事件訂閱的進階篩選陣列。

類型:	IAdvancedFilter[]
別名:	AdvancedFilter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FilterEnableAdvancedFilteringOnArray

允許針對值的數位評估進階篩選，而不是預期單一值。

類型:	SwitchParameter
別名:	AdvancedFilteringOnArray
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FilterIncludedEventType

需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型，請將 IncludedEventTypes 設定為 null。

類型:	String[]
別名:	IncludedEventType
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FilterIsSubjectCaseSensitive

指定是否以區分大小寫的方式比較 filtershould 的 SubjectBeginsWith 和 SubjectEndsWith 屬性。

類型:	SwitchParameter
別名:	SubjectCaseSensitive
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FilterSubjectBeginsWith

選擇性字串，可根據資源路徑前置詞篩選事件訂用帳戶的事件。此格式取決於事件的發行者。此路徑不支援通配符。

類型:	String
別名:	SubjectBeginsWith
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FilterSubjectEndsWith

選擇性字串，可根據資源路徑後綴篩選事件訂用帳戶的事件。此路徑不支援通配符。

類型:	String
別名:	SubjectEndsWith
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InputObject

Identity 參數

類型:	IEventGridIdentity
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-JsonFilePath

提供給建立作業的 Json 檔案路徑

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-JsonString

提供給建立作業的 Json 字串

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Label

使用者定義的標籤清單。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-NoWait

以異步方式執行命令

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-PassThru

當命令成功時傳回 true

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ResourceGroupName

用戶訂用帳戶內的資源組名。

類型:	String
別名:	ResourceGroup
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-RetryPolicyEventTimeToLiveInMinute

活動存留時間（以分鐘為單位）。

類型:	Int32
別名:	EventTtl
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-RetryPolicyMaxDeliveryAttempt

事件的傳遞重試嘗試次數上限。

類型:	Int32
別名:	MaxDeliveryAttempt
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-SubscriptionId

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

類型:	String
Position:	Named
預設值:	(Get-AzContext).Subscription.Id
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-SystemTopicInputObject

Identity 參數

類型:	IEventGridIdentity
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-SystemTopicName

系統主題的名稱。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

類型:	SwitchParameter
別名:	wi
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

IEventGridIdentity

輸出

IEventSubscription