你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzServiceBusQueue

  • 参考
模块:
Az.ServiceBus

汇报 ServiceBus 队列

语法

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 <EntityStatus>]
   [-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 <EntityStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

汇报 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

在命名空间myNamespace中的 ServiceBus 队列myQueue上汇报参数DefaultMessageTimeToLiveAutoDeleteOnIdle。

示例 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

使用 InputObject 参数集在命名空间myNamespace中的 ServiceBus 队列myQueue上汇报 ParametersDefaultMessageTimeToLiveAutoDeleteOnIdle。

参数

-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

队列可以接受的消息有效负载的最大大小（以 知识库(KB) 为单位）。 此属性仅在今天高级版中使用，默认值为 1024。

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

-SubscriptionId

目标订阅的 ID。

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