Set-AzEventHubConsumerGroup

Reference

Modul:: Az.EventHub

Nastaví skupinu příjemců EventHubu.

Syntaxe

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

Nastaví skupinu příjemců EventHubu.

Příklady

Příklad 1: Aktualizace skupiny příjemců EventHubu

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

Aktualizuje skupinu příjemců myConsumerGroup vytvořenou v rámci entity EventHub myEventHub.

Příklad 2: Aktualizace skupiny příjemců EventHubu pomocí sady parametrů 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

Aktualizuje skupinu příjemců myConsumerGroup vytvořenou v rámci entity EventHub myEventHub.

Parametry

-AsJob

Spuštění příkazu jako úlohy

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Confirm

Před spuštěním rutiny vás vyzve k potvrzení.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:	PSObject
Aliasy:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-EventHubName

Název EventHubu

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-InputObject

Parametr identity. Chcete-li vytvořit, přečtěte si část NOTES pro vlastnosti INPUTOBJECT a vytvořte tabulku hash.

Typ:	IEventHubIdentity
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-Name

Název skupiny příjemců.

Typ:	String
Aliasy:	ConsumerGroupName
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-NamespaceName

Název oboru názvů EventHubu

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-NoWait

Asynchronní spuštění příkazu

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ResourceGroupName

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-SubscriptionId

ID cílového předplatného.

Typ:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-UserMetadata

Metadata uživatele je zástupný symbol pro ukládání dat řetězce definovaných uživatelem s maximální délkou 1024. Například lze použít k ukládání popisných dat, jako je seznam týmů a jejich kontaktních údajů, lze uložit také uživatelsky definovaná nastavení konfigurace.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

Vstupy

IEventHubIdentity

Výstupy

IConsumerGroup

Sdílet prostřednictvím