Set-AzServiceBusQueue

參考

模組:: Az.ServiceBus

更新 ServiceBus 佇列

Syntax

Set-AzServiceBusQueue
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-AutoDeleteOnIdle <TimeSpan>]
   [-DefaultMessageTimeToLive <TimeSpan>]
   [-DuplicateDetectionHistoryTimeWindow <TimeSpan>]
   [-LockDuration <TimeSpan>]
   [-DeadLetteringOnMessageExpiration]
   [-EnableBatchedOperations]
   [-EnableExpress]
   [-ForwardTo <String>]
   [-ForwardDeadLetteredMessagesTo <String>]
   [-MaxDeliveryCount <Int32>]
   [-MaxSizeInMegabytes <Int32>]
   [-MaxMessageSizeInKilobytes <Int64>]
   [-Status <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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

Description

更新 ServiceBus 佇列

範例

範例 1：更新 ServiceBus 佇列

Set-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myQueue -AutoDeleteOnIdle (New-TimeSpan -Days 4 -Minutes 3 -Seconds 4) -DefaultMessageTimeToLive (New-TimeSpan -Days 9)

AccessedAt                                : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle                          : 4.00:03:04
CountDetailActiveMessageCount             : 0
CountDetailDeadLetterMessageCount         : 0
CountDetailScheduledMessageCount          : 0
CountDetailTransferDeadLetterMessageCount : 0
CountDetailTransferMessageCount           : 0
CreatedAt                                 : 9/22/2022 12:30:45 PM
DeadLetteringOnMessageExpiration          : False
DefaultMessageTimeToLive                  : 9.00:00:00
DuplicateDetectionHistoryTimeWindow       : 00:10:00
EnableBatchedOperations                   : True
EnableExpress                             : False
EnablePartitioning                        : True
ForwardDeadLetteredMessagesTo             :
ForwardTo                                 :
Id                                        : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue
Location                                  : westus
LockDuration                              : 00:01:00
MaxDeliveryCount                          : 10
MaxMessageSizeInKilobytes                 : 1024
MaxSizeInMegabytes                        : 1024
MessageCount                              : 0
Name                                      : myQueue
RequiresDuplicateDetection                : False
RequiresSession                           : False
ResourceGroupName                         : myResourceGroup
SizeInByte                                : 0
Status                                    : Active

更新參數 DefaultMessageTimeToLive，位於命名空間 myNamespace中的 ServiceBus 佇列myQueueAutoDeleteOnIdle上。

範例 2：使用 InputObject 參數集更新 ServiceBus 佇列

$queue = Get-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myQueue
Set-AzServiceBusQueue -InputObject $queue -AutoDeleteOnIdle (New-TimeSpan -Days 4 -Minutes 3 -Seconds 4) -DefaultMessageTimeToLive (New-TimeSpan -Days 9)

AccessedAt                                : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle                          : 4.00:03:04
CountDetailActiveMessageCount             : 0
CountDetailDeadLetterMessageCount         : 0
CountDetailScheduledMessageCount          : 0
CountDetailTransferDeadLetterMessageCount : 0
CountDetailTransferMessageCount           : 0
CreatedAt                                 : 9/22/2022 12:30:45 PM
DeadLetteringOnMessageExpiration          : False
DefaultMessageTimeToLive                  : 9.00:00:00
DuplicateDetectionHistoryTimeWindow       : 00:10:00
EnableBatchedOperations                   : True
EnableExpress                             : False
EnablePartitioning                        : True
ForwardDeadLetteredMessagesTo             :
ForwardTo                                 :
Id                                        : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue
Location                                  : westus
LockDuration                              : 00:01:00
MaxDeliveryCount                          : 10
MaxMessageSizeInKilobytes                 : 1024
MaxSizeInMegabytes                        : 1024
MessageCount                              : 0
Name                                      : myQueue
RequiresDuplicateDetection                : False
RequiresSession                           : False
ResourceGroupName                         : myResourceGroup
SizeInByte                                : 0
Status                                    : Active

更新 Parameters DefaultMessageTimeToLive，在命名空間myNamespace中使用 InputObject 參數集的 ServiceBus 佇列myQueueAutoDeleteOnIdle。

參數

-AsJob

以作業身分執行命令

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

-AutoDeleteOnIdle

ISO 8061 timeSpan 閑置間隔之後，佇列會自動刪除。最短持續時間為 5 分鐘。

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

-Confirm

執行 Cmdlet 之前先提示您確認。

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

-DeadLetteringOnMessageExpiration

值，指出當訊息到期時，這個佇列是否具有寄不出的信件支援。

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

-DefaultMessageTimeToLive

ISO 8601 預設訊息時間範圍到即時值。這是訊息到期的持續時間，從訊息傳送至服務匯流排開始。這是當 TimeToLive 未在訊息本身上設定時所使用的預設值。

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

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DuplicateDetectionHistoryTimeWindow

定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。預設值為 10 分鐘。

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

-EnableBatchedOperations

值，指出是否啟用伺服器端批次作業。

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

-EnableExpress

值，指出是否啟用 Express Entities。快速佇列會在將訊息寫入永續性記憶體之前，暫時將訊息儲存在記憶體中。

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

-ForwardDeadLetteredMessagesTo

值，指出佇列是否支援會話的概念。

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

-ForwardTo

要轉送訊息的佇列/主題名稱

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

-InputObject

識別參數。若要建構，請參閱 INPUTOBJECT 屬性的 NOTES 區段並建立哈希表。

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

-LockDuration

預覽鎖定的 ISO 8601 時間範圍持續時間;也就是說，訊息鎖定給其他接收者的時間量。 LockDuration 的最大值為 5 分鐘;預設值為1分鐘。

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

-MaxDeliveryCount

傳遞計數上限。在傳遞次數之後，會自動死電訊息。預設值為 10。

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

-MaxMessageSizeInKilobytes

佇列可接受之訊息承載的大小上限（以 KB 為單位）。此屬性只用於目前進階版，預設值為 1024。

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

-MaxSizeInMegabytes

傳遞計數上限。在傳遞次數之後，會自動死電訊息。預設值為 10。

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

-Name

佇列的名稱。

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

-NamespaceName

ServiceBus 命名空間的名稱

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

-NoWait

以異步方式執行命令

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

-ResourceGroupName

資源群組的名稱。名稱不區分大小寫。

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

-Status

列舉傳訊實體狀態的可能值。

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

-SubscriptionId

目標訂用帳戶的標識碼。

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

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

輸入

IServiceBusIdentity

輸出

ISbQueue

共用方式為