Set-AzServiceBusQueue

  • Referência
Módulo:
Az.ServiceBus

Atualiza uma fila do 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 <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 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

Atualiza parâmetros DefaultMessageTimeToLive, AutoDeleteOnIdle em uma fila myQueue ServiceBus no namespace myNamespace usando o conjunto de parâmetros InputObject.

Parâmetros

-AsJob

Executar o comando como um trabalho

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

-AutoDeleteOnIdle

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

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

-Confirm

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

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

-DeadLetteringOnMessageExpiration

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

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

-DefaultMessageTimeToLive

Intervalo de tempo da mensagem padrão ISO 8601 para o valor em tempo real. Esta é a duração após a qual a mensagem expira, a partir de quando a mensagem é enviada para o Service Bus. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si.

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

-DefaultProfile

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

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

-DuplicateDetectionHistoryTimeWindow

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

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

-EnableBatchedOperations

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-ForwardDeadLetteredMessagesTo

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

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

-ForwardTo

Nome da fila/tópico para encaminhar as mensagens

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

-InputObject

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

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

-LockDuration

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

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

-MaxDeliveryCount

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-MaxSizeInMegabytes

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

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

-Name

O nome da fila.

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

-NamespaceName

O nome do namespace ServiceBus

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

-NoWait

Execute o comando de forma assíncrona

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

-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

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

-SubscriptionId

A ID da assinatura de destino.

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

-WhatIf

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

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

Entradas

IServiceBusIdentity

Saídas

ISbQueue

Observações

ALIASES

PROPRIEDADES DE PARÂMETROS COMPLEXOS

Para criar os parâmetros descritos abaixo, construa uma tabela de hash contendo as propriedades apropriadas. Para obter informações sobre tabelas de hash, execute Get-Help about_Hash_Tables.

INPUTOBJECT <IServiceBusIdentity>: Parâmetro de identidade.

  • [Alias <String>]: O nome da configuração de recuperação de desastres
  • [AuthorizationRuleName <String>]: O nome da regra de autorização.
  • [ConfigName <MigrationConfigurationName?>]: O nome da configuração. Deve ser sempre "$default".
  • [Id <String>]: Caminho de identidade do recurso
  • [NamespaceName <String>]: O nome do namespace
  • [PrivateEndpointConnectionName <String>]: O nome PrivateEndpointConnection
  • [QueueName <String>]: O nome da fila.
  • [ResourceGroupName <String>]: Nome do grupo de recursos na assinatura do Azure.
  • [RuleName <String>]: O nome da regra.
  • [SubscriptionId <String>]: credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
  • [SubscriptionName <String>]: O nome da assinatura.
  • [TopicName <String>]: O nome do tópico.