Update-AzEventGridSubscription
Event Grid イベント サブスクリプションのプロパティを更新します。
構文
Update-AzEventGridSubscription
[-EventSubscriptionName] <String>
[[-ResourceGroupName] <String>]
[-EndpointType <String>]
[-Endpoint <String>]
[-SubjectBeginsWith <String>]
[-SubjectEndsWith <String>]
[-IncludedEventType <String[]>]
[-Label <String[]>]
[-ExpirationDate <DateTime>]
[-AdvancedFilter <Hashtable[]>]
[-DeliveryAttributeMapping <Hashtable[]>]
[-EventTtl <Int32>]
[-MaxDeliveryAttempt <Int32>]
[-DeadLetterEndpoint <String>]
[-MaxEventsPerBatch <Int32>]
[-PreferredBatchSizeInKiloByte <Int32>]
[-AzureActiveDirectoryApplicationIdOrUri <String>]
[-AzureActiveDirectoryTenantId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzEventGridSubscription
[-ResourceId] <String>
[-EventSubscriptionName] <String>
[-EndpointType <String>]
[-Endpoint <String>]
[-SubjectBeginsWith <String>]
[-SubjectEndsWith <String>]
[-IncludedEventType <String[]>]
[-Label <String[]>]
[-ExpirationDate <DateTime>]
[-AdvancedFilter <Hashtable[]>]
[-DeliveryAttributeMapping <Hashtable[]>]
[-EventTtl <Int32>]
[-MaxDeliveryAttempt <Int32>]
[-DeadLetterEndpoint <String>]
[-MaxEventsPerBatch <Int32>]
[-PreferredBatchSizeInKiloByte <Int32>]
[-AzureActiveDirectoryApplicationIdOrUri <String>]
[-AzureActiveDirectoryTenantId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzEventGridSubscription
[-InputObject] <PSEventSubscription>
[-EndpointType <String>]
[-Endpoint <String>]
[-SubjectBeginsWith <String>]
[-SubjectEndsWith <String>]
[-IncludedEventType <String[]>]
[-Label <String[]>]
[-ExpirationDate <DateTime>]
[-AdvancedFilter <Hashtable[]>]
[-DeliveryAttributeMapping <Hashtable[]>]
[-EventTtl <Int32>]
[-MaxDeliveryAttempt <Int32>]
[-DeadLetterEndpoint <String>]
[-MaxEventsPerBatch <Int32>]
[-PreferredBatchSizeInKiloByte <Int32>]
[-AzureActiveDirectoryApplicationIdOrUri <String>]
[-AzureActiveDirectoryTenantId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzEventGridSubscription
[-EventSubscriptionName] <String>
[-ResourceGroupName] <String>
[-TopicName] <String>
[-EndpointType <String>]
[-Endpoint <String>]
[-SubjectBeginsWith <String>]
[-SubjectEndsWith <String>]
[-IncludedEventType <String[]>]
[-Label <String[]>]
[-ExpirationDate <DateTime>]
[-AdvancedFilter <Hashtable[]>]
[-DeliveryAttributeMapping <Hashtable[]>]
[-EventTtl <Int32>]
[-MaxDeliveryAttempt <Int32>]
[-DeadLetterEndpoint <String>]
[-MaxEventsPerBatch <Int32>]
[-PreferredBatchSizeInKiloByte <Int32>]
[-AzureActiveDirectoryApplicationIdOrUri <String>]
[-AzureActiveDirectoryTenantId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzEventGridSubscription
[-EventSubscriptionName] <String>
[-ResourceGroupName] <String>
[-DomainName] <String>
[-EndpointType <String>]
[-Endpoint <String>]
[-SubjectBeginsWith <String>]
[-SubjectEndsWith <String>]
[-IncludedEventType <String[]>]
[-Label <String[]>]
[-ExpirationDate <DateTime>]
[-AdvancedFilter <Hashtable[]>]
[-DeliveryAttributeMapping <Hashtable[]>]
[-EventTtl <Int32>]
[-MaxDeliveryAttempt <Int32>]
[-DeadLetterEndpoint <String>]
[-MaxEventsPerBatch <Int32>]
[-PreferredBatchSizeInKiloByte <Int32>]
[-AzureActiveDirectoryApplicationIdOrUri <String>]
[-AzureActiveDirectoryTenantId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzEventGridSubscription
[-EventSubscriptionName] <String>
[-ResourceGroupName] <String>
[-DomainName] <String>
[-DomainTopicName] <String>
[-EndpointType <String>]
[-Endpoint <String>]
[-SubjectBeginsWith <String>]
[-SubjectEndsWith <String>]
[-IncludedEventType <String[]>]
[-Label <String[]>]
[-ExpirationDate <DateTime>]
[-AdvancedFilter <Hashtable[]>]
[-DeliveryAttributeMapping <Hashtable[]>]
[-EventTtl <Int32>]
[-MaxDeliveryAttempt <Int32>]
[-DeadLetterEndpoint <String>]
[-MaxEventsPerBatch <Int32>]
[-PreferredBatchSizeInKiloByte <Int32>]
[-AzureActiveDirectoryApplicationIdOrUri <String>]
[-AzureActiveDirectoryTenantId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Event Grid イベント サブスクリプションのプロパティを更新します。 これを使用して、既存のイベント サブスクリプションのフィルター、宛先、またはラベルを更新できます。
例
例 1
Update-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1リソース グループ 'MyResourceGroupName' のトピック 'Topic1' のイベント サブスクリプション 'ES1' のエンドポイントを '' に更新https://requestb.in/1kxxoui1します
例 2
Get-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName | Update-AzEventGridSubscription -Endpoint https://requestb.in/1kxxoui1リソース グループ 'MyResourceGroupName' のトピック 'Topic1' のイベント サブスクリプション 'ES1' のエンドポイントを '' に更新https://requestb.in/1kxxoui1します
例 3
Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg"新しいエンドポイントが '' で、新しい SubjectEndsWith フィルターが 'jpg' である EventHub 名前空間 ContosoNamespace のイベント サブスクリプション 'https://requestb.in/1kxxoui1ES1' のプロパティを更新します。
例 4
$labels = "Finance", "HR"
Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceGroup MyResourceGroupName -Label $labels新しいラベルが$labelsされたリソース グループ 'MyResourceGroupName' のイベント サブスクリプション 'ES1' のプロパティを更新します。
パラメーター
-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="StringBeginsWith"; key="Subject";Values=@("SubjectPrefix1","SubjectPrefix2")}
| Type: | Hashtable[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AzureActiveDirectoryApplicationIdOrUri
配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Microsoft Entra アプリケーション ID または URI。宛先として Webhook にのみ適用されます。
| Type: | String |
| Aliases: | AliasAadAppIdUri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AzureActiveDirectoryTenantId
配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Microsoft Entra テナント ID。宛先として Webhook にのみ適用されます。
| Type: | String |
| Aliases: | AliasAadTenantId |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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: | False |
| 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: | False |
| Accept wildcard characters: | False |
-DomainName
イベント サブスクリプションの作成先となる doメイン の名前。
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DomainTopicName
イベント サブスクリプションを作成する doメイン トピックの名前。
| Type: | String |
| Position: | 3 |
| 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: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndpointType
エンドポイントの種類。 Webhook、eventhub、storagequeue、hybridconnection、servicebusqueue を指定できます。 既定値は webhook です。
| Type: | String |
| Accepted values: | webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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: | False |
| 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: | False |
| Accept wildcard characters: | False |
-InputObject
EventGridSubscription オブジェクト。
| Type: | PSEventSubscription |
| 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: | False |
| Accept wildcard characters: | False |
-MaxDeliveryAttempt
イベントの配信試行の最大数。 この値は 1 から 30 の間である必要があります
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxEventsPerBatch
バッチ内の最大イベント数。 この値は 1 から 5000 の間である必要があります。 このパラメーターは、Endpint 型が webhook のみの場合に有効です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreferredBatchSizeInKiloByte
推奨されるバッチ サイズ (KB 単位)。 この値は 1 から 1024 の間である必要があります。 このパラメーターは、Endpint 型が webhook のみの場合に有効です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
トピックのリソース グループ。
| Type: | String |
| Aliases: | ResourceGroup |
| Position: | 1 |
| 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 |
-SubjectBeginsWith
指定したサブジェクト プレフィックスに一致するイベントのみが含まれることを指定するフィルター。 指定しない場合、すべてのサブジェクト プレフィックスを持つイベントが含まれます。
| Type: | String |
| 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: | False |
| Accept wildcard characters: | False |
-TopicName
イベント サブスクリプションを作成するトピックの名前。
| Type: | String |
| Position: | 2 |
| 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 |
入力
出力
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示