Compartilhar via

New-AzEventHub

  • Referência
Módulo:
Az.EventHub

Crie um novo Hub de Eventos como um recurso aninhado em um Namespace.

Sintaxe

New-AzEventHub
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-CaptureEnabled]
   [-CleanupPolicy <String>]
   [-DestinationName <String>]
   [-Encoding <String>]
   [-IdentityType <String>]
   [-IntervalInSeconds <Int32>]
   [-PartitionCount <Int64>]
   [-RetentionTimeInHour <Int64>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-Status <String>]
   [-StorageAccountResourceId <String>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-UserAssignedIdentityId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventHub
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-CaptureEnabled]
   [-CleanupPolicy <String>]
   [-DestinationName <String>]
   [-Encoding <String>]
   [-IdentityType <String>]
   [-IntervalInSeconds <Int32>]
   [-PartitionCount <Int64>]
   [-RetentionTimeInHour <Int64>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-Status <String>]
   [-StorageAccountResourceId <String>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-UserAssignedIdentityId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventHub
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   -Parameter <IEventhub>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Crie um novo Hub de Eventos como um recurso aninhado em um Namespace.

Exemplos

Exemplo 1: Criar uma entidade do EventHub

New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -RetentionTimeInHour 168 -PartitionCount 5 -CleanupPolicy Delete

ArchiveNameFormat            :
BlobContainer                :
CaptureEnabled               :
CleanupPolicy                : Delete
CreatedAt                    : 4/25/2023 3:55:45 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     :
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            :
Location                     : eastus
MessageRetentionInDay        : 7
Name                         : myEventHub
PartitionCount               : 5
PartitionId                  : {0, 1, 2, 3�}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 168
SizeLimitInBytes             :
SkipEmptyArchive             :
Status                       : Active
StorageAccountResourceId     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 4/25/2023 3:55:46 AM

Cria uma nova entidade myEventHub eventhub no namespace myNamespace com CleaupPolicy Delete.

Exemplo 2: Criar o EventHub com o Capture habilitado

New-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 -CleanupPolicy Delete"

ArchiveNameFormat            : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer                : container
CaptureEnabled               : true
CreatedAt                    : 9/1/2022 5:55:46 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     : Avro
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myFirstEventHub
IntervalInSeconds            : 600
Location                     : centralus
MessageRetentionInDays       : 6
Name                         : myFirstEventHub
PartitionCount               : 5
PartitionId                  : {0}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 24
SizeLimitInBytes             : 11000000
SkipEmptyArchive             : true
Status                       : Active

Cria uma nova entidade myEventHub eventhub no namespace myNamespace com a captura habilitada.

Exemplo 3: Criar uma entidade do EventHub

New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -CleanupPolicy Compact

ArchiveNameFormat            :
BlobContainer                :
CaptureEnabled               :
CleanupPolicy                : Compact
CreatedAt                    : 4/25/2023 4:05:57 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     :
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            :
Location                     : eastus
MessageRetentionInDay        : 9223372036854775807
Name                         : myEventHub
PartitionCount               : 4
PartitionId                  : {0, 1, 2, 3}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          :
SizeLimitInBytes             :
SkipEmptyArchive             :
Status                       : Active
StorageAccountResourceId     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 4/25/2023 4:05:58 AM

Cria uma nova entidade myEventHub eventhub no namespace myNamespace com CleaupPolicy Compact.

Parâmetros

-ArchiveNameFormat

Convenção de nomenclatura de blob para arquivo, 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

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

-BlobContainer

Nome do contêiner de blob

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

-CaptureEnabled

Um valor que indica se a descrição da captura está habilitada.

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

-CleanupPolicy

Enumera os valores possíveis para a política de limpeza

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

-Confirm

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

O parâmetro DefaultProfile não está funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Tipo:PSObject
Aliases:AzureRMContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DestinationName

Nome do destino de captura

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

-Encoding

Enumera os valores possíveis para o formato de codificação da descrição da captura. Observação: o uso de "AvroDeflate" será descontinuado na nova versão da API

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

-IdentityType

Tipo de identidade gerenciada do Azure Active Directory.

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

-IntervalInSeconds

A janela de tempo permite que você defina a frequência com que a captura para Blobs do Azure acontecerá, o valor deve estar entre 60 e 900 segundos

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

-Name

O nome do Hub de Eventos

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

-NamespaceInputObject

Parâmetro de identidade

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

-NamespaceName

O nome do namespace

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

-Parameter

Item único na operação Listar ou Obter Hub de Eventos

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

-PartitionCount

Número de partições criadas para o Hub de Eventos, os valores permitidos são de 1 a 32 partições.

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

-ResourceGroupName

Nome do grupo de recursos na assinatura do Azure.

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

-RetentionTimeInHour

Número de horas para reter os eventos deste Hub de Eventos. Esse valor só é usado quando cleanupPolicy é Delete. Se cleanupPolicy for Compact, o valor retornado dessa propriedade será Long.MaxValue

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

-SizeLimitInBytes

A janela de tamanho define a quantidade de dados criados em seu Hub de Eventos antes de uma operação de captura, o valor deve estar entre 10485760 e 524288000 bytes

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

-SkipEmptyArchive

Um valor que indica se os arquivos vazios devem ser ignorados

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

-Status

Enumera os valores possíveis para o status do Hub de Eventos.

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

-StorageAccountResourceId

ID do recurso da conta de armazenamento a ser usada para criar os blobs

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

-SubscriptionId

Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

Tipo:String
Cargo:Named
Valor padrão:(Get-AzContext).Subscription.Id
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-TombstoneRetentionTimeInHour

Número de horas para reter os marcadores de marca de exclusão de um Hub de Eventos compactado. Esse valor só é usado quando cleanupPolicy é Compact. 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 ele obtenha um instantâneo válido para a chave específica descrita pelo marcador de marca de exclusão no Hub de Eventos compactado

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

-UserAssignedIdentityId

ID do ARM da Identidade do Usuário Gerenciado. Essa propriedade é necessária se o tipo for UserAssignedIdentity. Se type for SystemAssigned, a Identidade Atribuída pelo Sistema Associada ao namespace será usada.

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

IEventhub

IEventHubIdentity

Saídas

IEventhub