Set-AzEventHub
Atualiza uma entidade do EventHub
Syntax
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>] Description
Atualiza uma entidade do EventHub
Exemplos
Exemplo 1: Definir a captura em uma entidade EventHub existente
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 AMAtualiza a entidade myEventHub EventHub do namespace myNamespace para habilitar a captura nele.
Exemplo 2: Atualizar a entidade EventHub do EventHub usando o conjunto de parâmetros 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 AMAtualizações RetentionTimeInHour na entidade myEventHub EventHub para 72 horas.
Parâmetros
-ArchiveNameFormat
Convenção de nomenclatura de blob para arquivamento, por exemplo, {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Aqui todos os parâmetros (Namespace, EventHub, .. etc) são obrigatórios, independentemente da ordem
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Executar o comando como um trabalho
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BlobContainer
Nome do contêiner de blob
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CaptureEnabled
Um valor que indica se a descrição da captura está habilitada.
| Type: | SwitchParameter |
| 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 |
-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 |
-DestinationName
Nome para o destino de captura
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encoding
Enumera os valores possíveis para o formato de codificação da descrição da captura. Nota: 'AvroDeflate' será preterido na Nova Versão da API
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityType
Tipo de identidade de serviço gerenciado.
| 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: | IEventHubIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IntervalInSeconds
A janela de tempo permite que você defina a frequência com que a captura para Blobs do Azure acontecerá, valor deve entre 60 a 900 segundos
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
O nome da entidade EventHub.
| Type: | String |
| Aliases: | EventHubName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NamespaceName
O nome do namespace EventHub.
| 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 |
-PartitionCount
Número de partições criadas para o Hub de Eventos. Os valores permitidos são de 1 a 32 partições.
| Type: | Int64 |
| 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 |
-RetentionTimeInHour
Número de horas para reter os eventos deste Hub de Eventos. Esse valor só é usado quando cleanupPolicy é Delete. Se cleanupPolicy for Compactação, o valor retornado dessa propriedade será Long.MaxValue
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SizeLimitInBytes
A janela de tamanho define a quantidade de dados acumulados no Hub de Eventos antes de uma operação de captura, o valor deve estar entre 10485760 a 524288000 bytes
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipEmptyArchive
Um valor que indica se Ignorar arquivos vazios deve ser ignorado
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Status
Enumera os valores possíveis para o status do Hub de Eventos.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageAccountResourceId
ID de recurso da conta de armazenamento a ser usada para criar os blobs
| Type: | String |
| 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 |
-TombstoneRetentionTimeInHour
Número de horas para reter os marcadores de lápide de um Hub de Eventos compactado. Esse valor só é usado quando cleanupPolicy é Compaction. O consumidor deve concluir a leitura do marcador de marca de exclusão dentro desse período de tempo especificado se o consumidor começar a partir do deslocamento inicial para garantir que obtenha um instantâneo válido para a chave específica descrita pelo marcador de marca de exclusão no Hub de Eventos compactado
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAssignedIdentityId
Propriedades para identidades atribuídas pelo usuário
| Type: | String |
| Position: | Named |
| Default value: | None |
| 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
Saídas
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventhub
Azure PowerShell
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de