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

説明

指定されたパラメーターを使用して、イベント サブスクリプションを非同期で作成または更新します。 既存のイベント サブスクリプションは、この 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
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeadLetterWithResourceIdentityType

使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeadLetterWithResourceIdentityUserAssignedIdentity

リソースに関連付けられているユーザー ID。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeliveryWithResourceIdentityDestination

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。

型:	IEventSubscriptionDestination
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeliveryWithResourceIdentityType

使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeliveryWithResourceIdentityUserAssignedIdentity

リソースに関連付けられているユーザー ID。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Destination

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。

型:	IEventSubscriptionDestination
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EventDeliverySchema

イベント サブスクリプションのイベント配信スキーマ。

型:	String
Aliases:	DeliverySchema
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EventSubscriptionName

作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 100 文字で、英数字のみを使用する必要があります。

型:	String
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ExpirationTimeUtc

イベント サブスクリプションの有効期限。

型:	DateTime
Aliases:	ExpirationDate
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterAdvancedFilter

イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。

型:	IAdvancedFilter[]
Aliases:	AdvancedFilter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterEnableAdvancedFilteringOnArray

特異な値を期待するのではなく、値の配列に対して高度なフィルターを評価できるようにします。

型:	SwitchParameter
Aliases:	AdvancedFilteringOnArray
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterIncludedEventType

イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。

型:	String[]
Aliases:	IncludedEventType
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterIsSubjectCaseSensitive

フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを大文字と小文字を区別して比較するかどうかを指定します。

型:	SwitchParameter
Aliases:	SubjectCaseSensitive
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterSubjectBeginsWith

リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。この形式は、イベントの発行元によって異なります。このパスでは、ワイルドカード文字はサポートされていません。

型:	String
Aliases:	SubjectBeginsWith
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterSubjectEndsWith

リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。このパスでは、ワイルドカード文字はサポートされていません。

型:	String
Aliases:	SubjectEndsWith
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

IDENTITY パラメーター

型:	IEventGridIdentity
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JsonFilePath

作成操作に指定された Json ファイルのパス

型:	String
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-JsonString

作成操作に指定された Json 文字列

型:	String
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Label

ユーザー定義ラベルの一覧。

型:	String[]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

コマンドを非同期的に実行する

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

コマンドが成功したときに true を返します。

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

ユーザーのサブスクリプション内のリソース グループの名前。

型:	String
Aliases:	ResourceGroup
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RetryPolicyEventTimeToLiveInMinute

イベントの Time To Live (分単位)。

型:	Int32
Aliases:	EventTtl
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RetryPolicyMaxDeliveryAttempt

イベントの配信再試行の最大数。

型:	Int32
Aliases:	MaxDeliveryAttempt
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

型:	String
Position:	Named
既定値:	(Get-AzContext).Subscription.Id
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SystemTopicInputObject

IDENTITY パラメーター

型:	IEventGridIdentity
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SystemTopicName

システム トピックの名前。

型:	String
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

IEventGridIdentity

出力

IEventSubscription