Set-AzEventHubConsumerGroup

Referência

Módulo:: Az.EventHub

Define um grupo de consumidores do EventHub

Sintaxe

Set-AzEventHubConsumerGroup
   -Name <String>
   -NamespaceName <String>
   -EventHubName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -UserMetadata <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzEventHubConsumerGroup
   -InputObject <IEventHubIdentity>
   -UserMetadata <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Define um grupo de consumidores do EventHub

Exemplos

Exemplo 1: Atualizar o grupo de consumidores do EventHub

Set-AzEventHubConsumerGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myConsumerGroup -UserMetadata "Example Metadata"

CreatedAt                    : 9/13/2022 9:20:47 AM
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
                               /eventhubs/eh1/consumergroups/myConsumerGroup
Location                     : australiaeast
Name                         : myConsumerGroup
ResourceGroupName            : myResourceGroup
UpdatedAt                    : 9/13/2022 9:20:47 AM
UserMetadata                 : Example Metadata

O grupo de consumidores atualiza myConsumerGroup criado na entidade EventHub myEventHub.

Exemplo 2: Atualizar o grupo de consumidores do EventHub usando o conjunto de parâmetros InputObject

$consumerGroup = Get-AzEventHubConsumerGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myConsumerGroup
Set-AzEventHubConsumerGroup -InputObject $consumerGroup -UserMetadata "Example Metadata"

CreatedAt                    : 9/13/2022 9:20:47 AM
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
                               /eventhubs/eh1/consumergroups/myConsumerGroup
Location                     : australiaeast
Name                         : myConsumerGroup
ResourceGroupName            : myResourceGroup
UpdatedAt                    : 9/13/2022 9:20:47 AM
UserMetadata                 : Example Metadata

O grupo de consumidores atualiza myConsumerGroup criado na entidade EventHub myEventHub.

Parâmetros

-AsJob

Executar o comando como um trabalho

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DefaultProfile

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

Tipo:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-EventHubName

O nome do EventHub

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-InputObject

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

Tipo:	IEventHubIdentity
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-Name

O nome do Grupo de Consumidores.

Tipo:	String
Aliases:	ConsumerGroupName
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-NamespaceName

O nome do namespace EventHub

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-NoWait

Execute o comando de forma assíncrona

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ResourceGroupName

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

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-SubscriptionId

A ID da assinatura de destino.

Tipo:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-UserMetadata

Metadados do usuário são um espaço reservado para armazenar dados de cadeia de caracteres definidos pelo usuário com comprimento máximo 1024. Por exemplo, ele pode ser usado para armazenar dados descritivos, como lista de equipes e suas informações de contato, também definições de configuração definidas pelo usuário podem ser armazenadas.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-WhatIf

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

Tipo:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

IEventHubIdentity

Saídas

IConsumerGroup

Partilhar via