New-AzEventGridSubscription

リファレンス

モジュール:: Az.EventGrid

トピック、Azure リソース、Azure サブスクリプション、またはリソースグループに新しい Azure Event Grid イベントサブスクリプションを作成します。

構文

New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [[-ResourceGroupName] <String>]
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   [-ResourceId] <String>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   [-InputObject] <PSTopic>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   [-DomainInputObject] <PSDomain>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   [-DomainTopicInputObject] <PSDomainTopic>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-TopicName] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-DomainName] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-DomainName] <String>
   -DomainTopicName <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Azure Event Grid トピック、サポートされている Azure リソース、Azure サブスクリプション、またはリソースグループへの新しいイベントサブスクリプションを作成します。現在選択されている Azure サブスクリプションのイベントサブスクリプションを作成するには、イベントサブスクリプション名と宛先エンドポイントを指定します。リソースグループのイベントサブスクリプションを作成するには、イベントサブスクリプション名と宛先エンドポイントに加えて、リソースグループ名を指定します。 Azure Event Grid トピックのイベントサブスクリプションを作成するには、トピック名も指定します。サポートされている Azure リソースのイベントサブスクリプションを作成するには、リソースの完全なリソース ID を指定します。サポートされている型の一覧を表示するには、Get-AzEventGridTopicType コマンドレットを実行します。

例

例 1

New-AzEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Webhook 宛先エンドポイントを使用して、リソースグループ 'MyResourceGroupName' の Azure Event Grid トピック 'Topic1' に新しいイベントサブスクリプション 'EventSubscription1' を作成します https://requestb.in/19qlscd1。このイベントサブスクリプションでは、既定のフィルターが使用されます。

例 2

New-AzEventGridSubscription -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Webhook 宛先エンドポイントを使用して、リソースグループ 'MyResourceGroupName' に新しいイベントサブスクリプション 'EventSubscription1' を作成します https://requestb.in/19qlscd1。このイベントサブスクリプションでは、既定のフィルターが使用されます。

例 3

New-AzEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Webhook 宛先エンドポイントを使用して、現在選択されている Azure サブスクリプションに新しいイベントサブスクリプション 'EventSubscription1' を作成します https://requestb.in/19qlscd1。このイベントサブスクリプションでは、既定のフィルターが使用されます。

例 4

$includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess"
$labels = "Finance", "HR"
New-AzEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels

Webhook 宛先エンドポイントを使用して、現在選択されている Azure サブスクリプションに新しいイベントサブスクリプション 'EventSubscription1' を作成します https://requestb.in/19qlscd1。このイベントサブスクリプションでは、イベントの種類と件名に追加のフィルターを指定し、それらのフィルターに一致するイベントのみが送信先エンドポイントに配信されます。

例 5

New-AzEventGridSubscription -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"

指定したイベントハブをイベントの送信先として使用して、現在選択されている Azure サブスクリプションに新しいイベントサブスクリプション 'EventSubscription1' を作成します。このイベントサブスクリプションでは、既定のフィルターが使用されます。

例 6

New-AzEventGridSubscription -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

指定した webhook 宛先エンドポイントを持つ EventHub 名前空間に新しいイベントサブスクリプション 'EventSubscription1' を作成します https://requestb.in/19qlscd1。このイベントサブスクリプションでは、既定のフィルターが使用されます。

パラメーター

-AdvancedFilter

属性ベースのフィルター処理に使用される複数のハッシュテーブル値の配列を指定する高度なフィルター。各ハッシュテーブル値には、操作、キー、値、または値というキー値の情報があります。演算子には、NumberIn、NumberNotIn、NumberLessThan、NumberGreaterThan、NumberLessThanOrEquals、NumberGreaterThanOrEquals、BoolEquals、StringIn、StringNotIn、StringBeginsWith、StringEndsWith、StringContains のいずれかを指定できます。キーは、高度なフィルターポリシーが適用されるペイロードプロパティを表します。最後に、値または値は、一致する値または値のセットを表します。これには、対応する型の単一の値または値の配列を指定できます。高度なフィルターパラメーターの例として、$AdvancedFilters=@($AdvFilter 1, $AdvFilter 2) where $AdvFilter 1=@{operator="NumberIn"; key="Data.Key1";Values=@(1,2)} and $AdvFilter 2=@{operator="StringBringsWith"; key="Subject";Values=@("SubjectPrefix1","SubjectPrefix2")}

Type:	Hashtable[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AdvancedFilteringOnArray

このパラメーターの存在は、配列に対する高度なフィルター処理が有効になっていることを示します

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureActiveDirectoryApplicationIdOrUri

配信要求にベアラートークンとして含まれるアクセストークンを取得する Microsoft Entra アプリケーション ID または URI。宛先として Webhook にのみ適用されます。

Type:	String
Aliases:	AliasAadAppIdUri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureActiveDirectoryTenantId

配信要求にベアラートークンとして含まれるアクセストークンを取得する Microsoft Entra テナント ID。宛先として Webhook にのみ適用されます。

Type:	String
Aliases:	AliasAadTenantId
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeadLetterEndpoint

配信不能イベントの格納に使用されるエンドポイント。ストレージ BLOB コンテナーの Azure リソース ID を指定します。例: /subscriptions/[SubscriptionId]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Storage/storageAccounts/[StorageAccountName]/blobServices/default/containers/[ContainerName]。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeliveryAttributeMapping

このシステムトピックイベントサブスクリプションの配信属性マッピング。各配信属性マッピングには、Name と Type という 2 つの必須フィールドが含まれている必要があります。型には、'Static' または 'Dynamic' のいずれかを指定できます。型が 'Static' の場合、プロパティ 'Value' と 'IsSecret' が必要です。型が 'Dynamic' の場合、プロパティ 'SourceField' が必要です。 DynamicAttributeMapping パラメーターの例: $DeliveryAttributeMapping=@($DeliveryAttributeMapping 1, $DeliveryAttributeMapping 2) where $DeliveryAttributeMapping 1=@{Name="Name1";Type="Static";Values="value";IsSecret="false"} and $DeliveryAttributeMapping 2=@{Name="Name2";Type="Dynamic";SourceField="data.prop1"}

Type:	Hashtable[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DeliverySchema

送信先にイベントを配信するときに使用するスキーマ。指定できる値は、eventgridschema、CustomInputSchema、または cloudeventv01schema です。既定値は CustomInputSchema です。

Type:	String
Accepted values:	EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0, EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainInputObject

EventGrid Doメインオブジェクト。

Type:	PSDomain
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainName

イベントサブスクリプションの作成先となる Event Grid doメインの名前。

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainTopicInputObject

EventGrid Doメイン Topic オブジェクト。

Type:	PSDomainTopic
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainTopicName

イベントサブスクリプションを作成する doメイントピックの名前。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Endpoint

イベントサブスクリプションの宛先エンドポイント。 Webhook URL、または EventHub、ストレージキュー、hybridconnection、または servicebusqueue の Azure リソース ID を指定できます。たとえば、ハイブリッド接続のリソース ID は、/subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]の形式になります。 Event Grid コマンドレットを実行する前に、宛先エンドポイントが作成され、使用できるようになることが予想されます。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-EndpointType

エンドポイントの種類。 Webhook、eventhub、storagequeue、hybridconnection、servicebusqueue を指定できます。既定値は webhook です。

Type:	String
Accepted values:	webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction, webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-EventSubscriptionName

イベントサブスクリプションの名前

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-EventTtl

イベント配信の時間 (分)。この値は 1 から 1440 の間である必要があります

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ExpirationDate

イベントサブスクリプションが廃止されるイベントサブスクリプションの有効期限 DateTime を決定します。

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IncludedEventType

含めるイベントの種類の一覧を指定するフィルター。指定しない場合は、すべてのイベントの種類が含まれます。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

EventGrid Topic オブジェクト。

Type:	PSTopic
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Label

イベントサブスクリプションのラベル

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MaxDeliveryAttempt

イベントの配信試行の最大数。この値は 1 から 30 の間である必要があります

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MaxEventsPerBatch

バッチ内の最大イベント数。この値は 1 から 5000 の間である必要があります。このパラメーターは、Endpint 型が webhook のみの場合に有効です。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PreferredBatchSizeInKiloByte

推奨されるバッチサイズ (KB 単位)。この値は 1 から 1024 の間である必要があります。このパラメーターは、Endpint 型が webhook のみの場合に有効です。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

トピックのリソースグループ。

Type:	String
Aliases:	ResourceGroup
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

イベントサブスクリプションを作成するリソースの識別子。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-StorageQueueMessageTtl

ストレージキューメッセージの有効期間 (ミリ秒単位)

Type:	Int64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SubjectBeginsWith

指定したサブジェクトプレフィックスに一致するイベントのみが含まれることを指定するフィルター。指定しない場合、すべてのサブジェクトプレフィックスを持つイベントが含まれます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SubjectCaseSensitive

件名フィールドを大文字と小文字を区別して比較することを指定するフィルター。指定しない場合、件名は大文字と小文字を区別せずに比較されます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubjectEndsWith

指定したサブジェクトサフィックスに一致するイベントのみが含まれることを指定するフィルター。指定しない場合、すべてのサブジェクトサフィックスを持つイベントが含まれます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-TopicName

イベントサブスクリプションを作成するトピックの名前。

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

String

PSTopic

PSDomain

PSDomainTopic

String[]

Int32

出力

PSEventSubscription