Set-AzServiceBusSubscription

リファレンス

モジュール:: Az.ServiceBus

ServiceBus サブスクリプションを更新します

構文

Set-AzServiceBusSubscription
   -Name <String>
   -TopicName <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-AutoDeleteOnIdle <TimeSpan>]
   [-DefaultMessageTimeToLive <TimeSpan>]
   [-DuplicateDetectionHistoryTimeWindow <TimeSpan>]
   [-LockDuration <TimeSpan>]
   [-EnableBatchedOperations]
   [-Status <String>]
   [-ForwardTo <String>]
   [-ForwardDeadLetteredMessagesTo <String>]
   [-MaxDeliveryCount <Int32>]
   [-DeadLetteringOnFilterEvaluationException]
   [-DeadLetteringOnMessageExpiration]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzServiceBusSubscription
   -InputObject <IServiceBusIdentity>
   [-AutoDeleteOnIdle <TimeSpan>]
   [-DefaultMessageTimeToLive <TimeSpan>]
   [-DuplicateDetectionHistoryTimeWindow <TimeSpan>]
   [-LockDuration <TimeSpan>]
   [-EnableBatchedOperations]
   [-Status <String>]
   [-ForwardTo <String>]
   [-ForwardDeadLetteredMessagesTo <String>]
   [-MaxDeliveryCount <Int32>]
   [-DeadLetteringOnFilterEvaluationException]
   [-DeadLetteringOnMessageExpiration]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

ServiceBus サブスクリプションを更新します

例

例 1: ServiceBus サブスクリプションを更新する

Set-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name mySubscription -DefaultMessageTimeToLive (New-TimeSpan -Days 10) -EnableBatchedOperations

AccessedAt                                : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle                          : 10675199.02:48:05.4775807
ClientId                                  :
CountDetailActiveMessageCount             : 0
CountDetailDeadLetterMessageCount         : 0
CountDetailScheduledMessageCount          : 0
CountDetailTransferDeadLetterMessageCount : 0
CountDetailTransferMessageCount           : 0
CreatedAt                                 : 9/23/2022 2:37:46 PM
DeadLetteringOnFilterEvaluationException  : True
DeadLetteringOnMessageExpiration          : False
DefaultMessageTimeToLive                  : 10.00:00:00
DuplicateDetectionHistoryTimeWindow       :
EnableBatchedOperations                   : True
ForwardDeadLetteredMessagesTo             :
ForwardTo                                 :
Id                                        : /subscriptions/000000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription
IsClientAffine                            : False
IsDurable                                 :
IsShared                                  :
Location                                  : westus
LockDuration                              : 00:01:00
MaxDeliveryCount                          : 10
MessageCount                              : 0
Name                                      : testsub
RequiresSession                           : False
ResourceGroupName                         : myResourceGroup
Status                                    : Active

トピック myTopicの ServiceBus サブスクリプション mySubscriptionDefaultMessageTimeToLive と EnableBatchedOperations を更新します。

例 1: InputObject パラメーターセットを使用して ServiceBus サブスクリプションを更新する

$subscription = Get-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name mySubscription
Set-AzServiceBusSubscription -InputObject $subscription -DefaultMessageTimeToLive (New-TimeSpan -Days 10) -EnableBatchedOperations

AccessedAt                                : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle                          : 10675199.02:48:05.4775807
ClientId                                  :
CountDetailActiveMessageCount             : 0
CountDetailDeadLetterMessageCount         : 0
CountDetailScheduledMessageCount          : 0
CountDetailTransferDeadLetterMessageCount : 0
CountDetailTransferMessageCount           : 0
CreatedAt                                 : 9/23/2022 2:37:46 PM
DeadLetteringOnFilterEvaluationException  : True
DeadLetteringOnMessageExpiration          : False
DefaultMessageTimeToLive                  : 10.00:00:00
DuplicateDetectionHistoryTimeWindow       :
EnableBatchedOperations                   : True
ForwardDeadLetteredMessagesTo             :
ForwardTo                                 :
Id                                        : /subscriptions/000000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription
IsClientAffine                            : False
IsDurable                                 :
IsShared                                  :
Location                                  : westus
LockDuration                              : 00:01:00
MaxDeliveryCount                          : 10
MessageCount                              : 0
Name                                      : testsub
RequiresSession                           : False
ResourceGroupName                         : myResourceGroup
Status                                    : Active

InputObject パラメーターセットを使用 myTopic トピックの ServiceBus サブスクリプション mySubscriptionDefaultMessageTimeToLive と EnableBatchedOperations を更新します。

パラメーター

-AsJob

コマンドをジョブとして実行する

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AutoDeleteOnIdle

ISO 8061 timeSpan アイドル間隔。その後、サブスクリプションが自動的に削除されます。最小期間は 5 分です。

型:	TimeSpan
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DeadLetteringOnFilterEvaluationException

フィルター評価例外でサブスクリプションが配信不能サポートを持っているかどうかを示す値。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DeadLetteringOnMessageExpiration

メッセージの有効期限が切れたときにサブスクリプションが配信不能サポートを受けるかどうかを示す値。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultMessageTimeToLive

ISO 8601 の既定のメッセージ期間からライブ値。これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。

型:	TimeSpan
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DuplicateDetectionHistoryTimeWindow

重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。既定値は 10 分です。

型:	TimeSpan
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EnableBatchedOperations

サーバー側のバッチ処理操作が有効かどうかを示す値。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ForwardDeadLetteredMessagesTo

配信不能メッセージを転送するキュー/トピック名

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ForwardTo

メッセージを転送するためのキュー/トピック名

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

ID パラメーター。構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IServiceBusIdentity
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-LockDuration

ピークロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。

型:	TimeSpan
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MaxDeliveryCount

配信の最大数。この数の配信後、メッセージは自動的に配信不能になります。既定値は 10 です。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

サブスクリプションの名前。

型:	String
Aliases:	SubscriptionName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NamespaceName

ServiceBus 名前空間の名前

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoWait

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前。名前では大文字と小文字が区別されません。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Status

メッセージングエンティティの状態に使用できる値を列挙します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SubscriptionId

ターゲットサブスクリプションの ID。

型:	String
配置:	Named
規定値:	(Get-AzContext).Subscription.Id
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TopicName

トピックの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

IServiceBusIdentity

出力

ISbSubscription

次の方法で共有

Set-AzServiceBusSubscription

構文

説明

例

例 1: ServiceBus サブスクリプションを更新する

例 1: InputObject パラメーターセットを使用して ServiceBus サブスクリプションを更新する

パラメーター

-AsJob

-AutoDeleteOnIdle

-Confirm

-DeadLetteringOnFilterEvaluationException

-DeadLetteringOnMessageExpiration

-DefaultMessageTimeToLive

-DefaultProfile

-DuplicateDetectionHistoryTimeWindow

-EnableBatchedOperations

-ForwardDeadLetteredMessagesTo

-ForwardTo

-InputObject

-LockDuration

-MaxDeliveryCount

-Name

-NamespaceName

-NoWait

-ResourceGroupName

-Status

-SubscriptionId

-TopicName

-WhatIf

入力

出力

その他のリソース

次の方法で共有

Set-AzServiceBusSubscription

構文

説明

例

例 1: ServiceBus サブスクリプションを更新する

例 1: InputObject パラメーター セットを使用して ServiceBus サブスクリプションを更新する

パラメーター

-AsJob

-AutoDeleteOnIdle

-Confirm

-DeadLetteringOnFilterEvaluationException

-DeadLetteringOnMessageExpiration

-DefaultMessageTimeToLive

-DefaultProfile

-DuplicateDetectionHistoryTimeWindow

-EnableBatchedOperations

-ForwardDeadLetteredMessagesTo

-ForwardTo

-InputObject

-LockDuration

-MaxDeliveryCount

-Name

-NamespaceName

-NoWait

-ResourceGroupName

-Status

-SubscriptionId

-TopicName

-WhatIf

入力

出力

その他のリソース

例 1: InputObject パラメーターセットを使用して ServiceBus サブスクリプションを更新する