Set-AzEventHub

Ссылка

Модуль:: Az.EventHub

Обновления сущности EventHub

Синтаксис

Set-AzEventHub
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-CaptureEnabled]
   [-Encoding <String>]
   [-IntervalInSeconds <Int32>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-RetentionTimeInHour <Int64>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-Status <String>]
   [-DestinationName <String>]
   [-IdentityType <String>]
   [-UserAssignedIdentityId <String>]
   [-PartitionCount <Int64>]
   [-StorageAccountResourceId <String>]
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzEventHub
   -InputObject <IEventHubIdentity>
   [-CaptureEnabled]
   [-Encoding <String>]
   [-IntervalInSeconds <Int32>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-RetentionTimeInHour <Int64>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-Status <String>]
   [-DestinationName <String>]
   [-IdentityType <String>]
   [-UserAssignedIdentityId <String>]
   [-PartitionCount <Int64>]
   [-StorageAccountResourceId <String>]
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Обновления сущности EventHub

Примеры

Пример 1. Настройка записи для существующей сущности EventHub

Set-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -BlobContainer container -CaptureEnabled -DestinationName EventHubArchive.AzureBlockBlob -Encoding Avro -IntervalInSeconds 600 -SizeLimitInBytes 11000000 -SkipEmptyArchive -StorageAccountResourceId "/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"

ArchiveNameFormat            : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer                : container
CaptureEnabled               : True
CleanupPolicy                : Delete
CreatedAt                    : 1/1/0001 12:00:00 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              : EventHubArchive.AzureBlockBlob
Encoding                     : Avro
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/namespace3/eventhubs/myEventHub
IntervalInSeconds            : 600
Location                     : eastus
MessageRetentionInDay        : 7
Name                         : myEventHub
PartitionCount               : 5
PartitionId                  : {}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 168
SizeLimitInBytes             : 11000000
SkipEmptyArchive             : True
Status                       : Active
StorageAccountResourceId     : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 1/1/0001 12:00:00 AM

Обновления сущность myEventHub EventHub из пространства myNamespace имен, чтобы включить запись в ней.

Пример 2. Обновление сущности EventHub EventHub с помощью набора параметров InputObject

$eventhub = Get-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace
Set-AzEventHub -InputObject $eventhub -RetentionTimeInHour 72

ArchiveNameFormat            : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer                : container1entHub]>
CaptureEnabled               : True
CleanupPolicy                : Delete
CreatedAt                    : 1/1/0001 12:00:00 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              : EventHubArchive.AzureBlockBlob
Encoding                     : Avro
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            : 600
Location                     : eastus
MessageRetentionInDay        : 3
Name                         : myEventHub
PartitionCount               : 5
PartitionId                  : {}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 72
SizeLimitInBytes             : 11000000
SkipEmptyArchive             : True
Status                       : Active
StorageAccountResourceId     : /subscriptions/subscriptionId/resourceGroups/myResourcegroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount
                               1
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 1/1/0001 12:00:00 AM

RetentionTimeInHour Обновления в сущности myEventHub EventHub до 72 часов.

Параметры

-ArchiveNameFormat

Соглашение об именовании BLOB-объектов для архива, например {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Здесь все параметры (пространство имен, EventHub и т. д.) являются обязательными независимо от порядка.

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

-AsJob

Выполнение команды в качестве задания

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

-BlobContainer

Имя контейнера BLOB-объектов

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

-CaptureEnabled

Значение, указывающее, включено ли описание записи.

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

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

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

-DestinationName

Имя назначения записи

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

-Encoding

Перечисляет возможные значения для формата кодирования описания записи. Примечание. AvroDeflate не рекомендуется использовать новую версию API.

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

-IdentityType

Тип управляемого удостоверения службы.

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

-InputObject

Параметр удостоверения. Сведения о создании см. в разделе NOTES для свойств INPUTOBJECT и создания хэш-таблицы.

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

-IntervalInSeconds

Период времени позволяет задать частоту, с которой будет выполняться запись больших двоичных объектов Azure, значение должно составлять от 60 до 900 секунд.

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

-Name

Имя сущности EventHub.

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

-NamespaceName

Имя пространства имен EventHub.

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

-NoWait

Асинхронное выполнение команды

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

-PartitionCount

Количество секций, созданных для концентратора событий. Допустимые значения — от 1 до 32 секций.

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

-ResourceGroupName

Имя группы ресурсов. Имя не учитывает регистр.

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

-RetentionTimeInHour

Количество часов для сохранения событий для этого концентратора событий. Это значение используется только в том случае, если параметр cleanupPolicy — Delete. Если cleanupPolicy — Compaction возвращаемое значение этого свойства— Long.MaxValue

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

-SizeLimitInBytes

Окно размера определяет объем данных, созданных в Концентраторе событий перед операцией записи, значение должно находиться между 10485760 до 524288000 байтов.

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

-SkipEmptyArchive

Значение, указывающее, следует ли пропускать пустые архивы

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

-Status

Перечисляет возможные значения состояния концентратора событий.

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

-StorageAccountResourceId

Идентификатор ресурса учетной записи хранения, используемой для создания больших двоичных объектов

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

-SubscriptionId

Идентификатор целевой подписки.

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

-TombstoneRetentionTimeInHour

Количество часов для хранения маркеров сложенного концентратора событий. Это значение используется только в том случае, если cleanupPolicy — Compaction. Потребитель должен завершить чтение маркера могилы в течение указанного периода времени, если потребитель начинает с начала смещения, чтобы убедиться, что они получают допустимый моментальный снимок для определенного ключа, описанного маркером могилы в сжатом концентраторе событий.

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

-UserAssignedIdentityId

Свойства назначенных пользователем удостоверений

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

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

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

Входные данные

IEventHubIdentity

Выходные данные

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventhub

Share via