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

Atualiza o grupo de consumidores myConsumerGroup criado no myEventHubda entidade EventHub.

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

Atualiza o grupo de consumidores myConsumerGroup criado no myEventHubda entidade EventHub.

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

-Confirm

Solicita a 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

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para 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

-EventHubName

O nome do EventHub

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

-InputObject

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

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

-Name

O nome do Grupo de Consumidores.

Tipo:	String
Aliases:	ConsumerGroupName
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 EventHub

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

-NoWait

Executar 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 não 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

-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

-UserMetadata

Metadados de usuário é 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 podem ser armazenadas configurações definidas pelo usuário.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
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

IEventHubIdentity

Saídas

IConsumerGroup

Compartilhar via