Compartilhar via

Set-AzServiceBusQueue

  • Referência
Módulo:
Az.ServiceBus

Atualiza uma fila do ServiceBus

Sintaxe

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

Description

Atualiza uma fila do ServiceBus

Exemplos

Exemplo 1: Atualizar uma fila do 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

Atualiza parâmetros DefaultMessageTimeToLive, AutoDeleteOnIdle em uma fila myQueue do ServiceBus no namespace myNamespace.

Exemplo 2: Atualizar uma fila do ServiceBus usando o conjunto de parâmetros InputObject

$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

Parâmetros de atualizações DefaultMessageTimeToLive, AutoDeleteOnIdle em uma fila myQueue do ServiceBus no namespace myNamespace usando o conjunto de parâmetros InputObject.

Parâmetros

-AsJob

Executar o comando como um trabalho

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-AutoDeleteOnIdle

Intervalo ocioso timeSpan ISO 8061 após o qual a fila é excluída automaticamente. A duração mínima é de 5 minutos.

Tipo:TimeSpan
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeadLetteringOnMessageExpiration

Um valor que indica se essa fila tem suporte a mensagens mortas quando uma mensagem expira.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultMessageTimeToLive

Intervalo de tempo da mensagem padrão ISO 8601 para o valor ativo. Essa é a duração após a qual a mensagem expira, a partir do momento em que a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si.

Tipo:TimeSpan
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Tipo:PSObject
Aliases:AzureRMContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DuplicateDetectionHistoryTimeWindow

Estrutura timeSpan ISO 8601 que define a duração do histórico de detecção de duplicatas. O valor padrão é 10 minutos.

Tipo:TimeSpan
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableBatchedOperations

Valor que indica se as operações em lote do lado do servidor estão habilitadas.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableExpress

Um valor que indica se as Entidades Expressas estão habilitadas. Uma fila expressa mantém uma mensagem na memória temporariamente antes de gravá-la no armazenamento persistente.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ForwardDeadLetteredMessagesTo

Um valor que indica se a fila dá suporte ao conceito de sessões.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ForwardTo

Nome da fila/tópico para encaminhar as mensagens

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InputObject

Parâmetro de identidade. Para construir, consulte a seção NOTAS para propriedades INPUTOBJECT e crie uma tabela de hash.

Tipo:IServiceBusIdentity
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-LockDuration

Duração do intervalo de tempo ISO 8601 de um bloqueio de espiada; ou seja, a quantidade de tempo que a mensagem fica bloqueada para outros receptores. O valor máximo de LockDuration é de 5 minutos; O valor padrão é 1 minuto.

Tipo:TimeSpan
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-MaxDeliveryCount

A contagem máxima de entrega. Uma mensagem é automaticamente enviada após esse número de entregas. O valor padrão é 10.

Tipo:Int32
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-MaxMessageSizeInKilobytes

Tamanho máximo (em KB) da carga útil da mensagem que pode ser aceita pela fila. Essa propriedade só é usada no Premium hoje e o padrão é 1024.

Tipo:Int64
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-MaxSizeInMegabytes

A contagem máxima de entrega. Uma mensagem é automaticamente enviada após esse número de entregas. O valor padrão é 10.

Tipo:Int32
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Name

O nome da Fila.

Tipo:String
Aliases:QueueName
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NamespaceName

O nome do namespace do ServiceBus

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NoWait

Execute o comando de forma assíncrona

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Status

Tamanho máximo (em KB) da carga útil da mensagem que pode ser aceita pela fila. Essa propriedade só é usada no Premium hoje e o padrão é 1024.

Tipo:EntityStatus
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-SubscriptionId

A ID da assinatura de destino.

Tipo:String
Cargo:Named
Valor padrão:(Get-AzContext).Subscription.Id
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

IServiceBusIdentity

Saídas

ISbQueue