New-AzEventGridPartnerTopicEventSubscription
パートナー トピックに新しい Azure Event Grid イベント サブスクリプションを作成します。
構文
New-AzEventGridPartnerTopicEventSubscription
-Name <String>
-ResourceGroupName <String>
-PartnerTopicName <String>
[-AzureActiveDirectoryApplicationIdOrUri <String>]
[-AzureActiveDirectoryTenantId <String>]
[-DeadLetterEndpoint <String>]
[-DeliveryAttributeMapping <Hashtable[]>]
[-Endpoint <String>]
[-EndpointType <String>]
[-DeliverySchema <String>]
[-EventTtl <Int32>]
[-ExpirationDate <DateTime>]
[-Label <String[]>]
[-MaxDeliveryAttempt <Int32>]
[-MaxEventsPerBatch <Int32>]
[-PreferredBatchSizeInKiloByte <Int32>]
[-StorageQueueMessageTtl <Int64>]
[-AdvancedFilter <Hashtable[]>]
[-AdvancedFilteringOnArray]
[-IncludedEventType <String[]>]
[-SubjectBeginsWith <String>]
[-SubjectEndsWith <String>]
[-SubjectCaseSensitive]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Azure Event Grid パートナー トピックへの新しいイベント サブスクリプションを作成します。
例
例 1
New-AzEventGridPartnerTopicEventSubscription -ResourceGroup MyResourceGroup -PartnerTopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1
Webhook 宛先エンドポイントを使用して、リソース グループ 'MyResourceGroupName' の Azure Event Grid パートナー トピック 'Topic1' に新しいイベント サブスクリプション 'EventSubscription1' を作成します https://requestb.in/19qlscd1
。 このイベント サブスクリプションでは、既定のフィルターが使用されます。
例 2
$includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess"
$labels = "Finance", "HR"
New-AzEventGridPartnerTopicEventSubscription -ResourceGroup MyResourceGroup -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 -Endpoint https://requestb.in/19qlscd1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels
Webhook 宛先エンドポイントを使用して、リソース グループ 'MyResourceGroup' の Sytem トピック 'Topic1' に新しいイベント サブスクリプション 'EventSubscription1' を作成します https://requestb.in/19qlscd1
。 このイベント サブスクリプションでは、イベントの種類と件名に追加のフィルターを指定し、それらのフィルターに一致するイベントのみが送信先エンドポイントに配信されます。
例 3
New-AzEventGridPartnerTopicEventSubscription -ResourceGroup MyResourceGroup -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
指定したイベント ハブをイベントの送信先として使用して、リソース グループ 'MyResourceGroup' の Sytem トピック 'Topic1' に新しいイベント サブスクリプション 'EventSubscription1' を作成します。 このイベント サブスクリプションでは、既定のフィルターが使用されます。
パラメーター
-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: | True |
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 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AzureActiveDirectoryTenantId
配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Microsoft Entra テナント ID。宛先として Webhook にのみ適用されます。
Type: | String |
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 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Endpoint
イベント サブスクリプションの宛先エンドポイント。 Webhook URL、または EventHub、ストレージ キュー、hybridconnection、servicebusqueue、servicebustopic、または azurefunction の Azure リソース ID を指定できます。 たとえば、ハイブリッド接続のリソース ID は、/subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]の形式になります。 Event Grid コマンドレットを実行する前に、宛先エンドポイントが作成され、使用できるようになることが予想されます。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-EndpointType
エンドポイントの種類。 これは、webhook、eventhub、storagequeue、hybridconnection、servicebusqueue、servicebustopic、または azurefunction です。 既定値は webhook です。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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: | True |
Accept wildcard characters: | False |
-IncludedEventType
含めるイベントの種類の一覧を指定するフィルター。 指定しない場合は、すべてのイベントの種類 (カスタム トピックと doメイン) または既定のイベントの種類 (他のトピックの種類の場合) が含まれます。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-Name
EventGrid イベント サブスクリプション名。
Type: | String |
Aliases: | EventSubscriptionName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PartnerTopicName
Event Grid パートナー トピック名。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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: | Named |
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: | True |
Accept wildcard characters: | False |
-SubjectEndsWith
指定したサブジェクト サフィックスに一致するイベントのみが含まれることを指定するフィルター。 指定しない場合、すべてのサブジェクト サフィックスを持つイベントが含まれます。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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[]
出力
Azure PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示