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

Set-AzServiceBusQueue

模块:: Az.ServiceBus Module

更新 ServiceBus 队列

语法

SetExpanded （默认值）

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>]

SetViaIdentityExpanded

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>]

说明

更新 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中 ServiceBus 队列 AutoDeleteOnIdle 的参数 myQueuemyNamespace。

示例 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 参数集更新命名空间 DefaultMessageTimeToLive 中 ServiceBus 队列 AutoDeleteOnIdle 的参数 myQueuemyNamespace。

参数

-AsJob

以作业身份运行命令

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-AutoDeleteOnIdle

ISO 8061 timeSpan 空闲间隔后，队列会自动删除。最短持续时间为 5 分钟。

参数属性

类型:	TimeSpan
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DeadLetteringOnMessageExpiration

一个值，该值指示消息过期时此队列是否具有死信支持。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DefaultMessageTimeToLive

ISO 8601 默认消息时间跨度为实时值。这是消息过期的持续时间，从消息发送到服务总线时开始。这是未在消息本身上设置 TimeToLive 时使用的默认值。

参数属性

类型:	TimeSpan
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:	PSObject
默认值:	None
支持通配符:	False
不显示:	False
别名:	AzureRMContext, AzureCredential

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DuplicateDetectionHistoryTimeWindow

定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。默认值为 10 分钟。

参数属性

类型:	TimeSpan
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-EnableBatchedOperations

指示是否启用服务器端批处理作的值。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-EnableExpress

一个值，该值指示是否启用 Express Entities。快速队列将消息暂时保存在内存中，然后再将其写入永久性存储。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ForwardDeadLetteredMessagesTo

一个值，该值指示队列是否支持会话的概念。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ForwardTo

用于转发消息的队列/主题名称

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-InputObject

标识参数。若要构造，请参阅 INPUTOBJECT 属性的 NOTES 部分并创建哈希表。

参数属性

类型:	IServiceBusIdentity
默认值:	None
支持通配符:	False
不显示:	False

参数集

SetViaIdentityExpanded

Position:	Named
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-LockDuration

扫视锁的 ISO 8601 时间跨度持续时间;也就是说，为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。

参数属性

类型:	TimeSpan
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-MaxDeliveryCount

最大传递计数。在传递数之后，消息会自动死机。默认值为 10。

参数属性

类型:	Int32
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-MaxMessageSizeInKilobytes

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

参数属性

类型:	Int64
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-MaxSizeInMegabytes

最大传递计数。在传递数之后，消息会自动死机。默认值为 10。

参数属性

类型:	Int32
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Name

队列的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False
别名:	QueueName

参数集

SetExpanded

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-NamespaceName

ServiceBus 命名空间的名称

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

SetExpanded

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-NoWait

异步运行命令

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResourceGroupName

资源组的名称。此名称不区分大小写。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

SetExpanded

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Status

枚举消息实体状态的可能值。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-SubscriptionId

目标订阅的 ID。

参数属性

类型:	String
默认值:	(Get-AzContext).Subscription.Id
支持通配符:	False
不显示:	False

参数集

SetExpanded

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。命令脚本未运行。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。

通过

Set-AzServiceBusQueue

语法

SetExpanded （默认值）

SetViaIdentityExpanded

说明

示例

示例 1：更新 ServiceBus 队列

示例 2：使用 InputObject 参数集更新 ServiceBus 队列

参数

-AsJob

参数属性

参数集

-AutoDeleteOnIdle

参数属性

参数集

-Confirm

参数属性

参数集

-DeadLetteringOnMessageExpiration

参数属性

参数集

-DefaultMessageTimeToLive

参数属性

参数集

-DefaultProfile

参数属性

参数集

-DuplicateDetectionHistoryTimeWindow

参数属性

参数集

-EnableBatchedOperations

参数属性

参数集

-EnableExpress

参数属性

参数集

-ForwardDeadLetteredMessagesTo

参数属性

参数集

-ForwardTo

参数属性

参数集

-InputObject

参数属性

参数集

-LockDuration

参数属性

参数集

-MaxDeliveryCount

参数属性

参数集

-MaxMessageSizeInKilobytes

参数属性

参数集

-MaxSizeInMegabytes

参数属性

参数集

-Name

参数属性

参数集

-NamespaceName

参数属性

参数集

-NoWait

参数属性

参数集

-ResourceGroupName

参数属性

参数集

-Status

参数属性

参数集

-SubscriptionId

参数属性

参数集

-WhatIf

参数属性

参数集

CommonParameters