Partilhar via


@azure/arm-eventhub package

Classes

EventHubManagementClient

Interfaces

AccessKeys

Espaço de Nomes/Cadeia de Ligação do EventHub

ArmDisasterRecovery

Item único na operação Listar ou Obter Alias (Configuração da Recuperação Após Desastre)

ArmDisasterRecoveryListResult

O resultado da operação Alias de Lista (Configuração da Recuperação Após Desastre).

AuthorizationRule

Item único numa operação List ou Get AuthorizationRule

AuthorizationRuleListResult

A resposta da operação Espaço de nomes de lista.

AvailableCluster

Contagem de Clusters de Hubs de Eventos pré-aprovisionados e prontamente disponíveis por região.

AvailableClustersList

A resposta da operação Lista de Clusters Disponíveis.

CaptureDescription

Propriedades para configurar a descrição da captura para o eventhub

CheckNameAvailabilityParameter

Parâmetro fornecido para verificar a operação de disponibilidade do nome do Espaço de Nomes

CheckNameAvailabilityResult

O Resultado da operação CheckNameAvailability

Cluster

Recurso de Cluster de Hubs de Eventos Únicos em Operações de Lista ou Obtenção.

ClusterListResult

A resposta da operação Listar Clusters de Hubs de Eventos.

ClusterQuotaConfigurationProperties

Contém todas as definições do cluster.

ClusterSku

Parâmetros de SKU específicos para uma instância de cluster.

Clusters

Interface que representa clusters.

ClustersCreateOrUpdateOptionalParams

Parâmetros opcionais.

ClustersDeleteOptionalParams

Parâmetros opcionais.

ClustersGetOptionalParams

Parâmetros opcionais.

ClustersListAvailableClusterRegionOptionalParams

Parâmetros opcionais.

ClustersListByResourceGroupNextOptionalParams

Parâmetros opcionais.

ClustersListByResourceGroupOptionalParams

Parâmetros opcionais.

ClustersListBySubscriptionNextOptionalParams

Parâmetros opcionais.

ClustersListBySubscriptionOptionalParams

Parâmetros opcionais.

ClustersListNamespacesOptionalParams

Parâmetros opcionais.

ClustersUpdateOptionalParams

Parâmetros opcionais.

Configuration

Interface que representa uma Configuração.

ConfigurationGetOptionalParams

Parâmetros opcionais.

ConfigurationPatchOptionalParams

Parâmetros opcionais.

ConnectionState

Informações de ConnectionState.

ConsumerGroup

Item único na operação Listar ou Obter Grupo de consumidores

ConsumerGroupListResult

O resultado da operação Listar Grupo de Consumidores.

ConsumerGroups

Interface que representa um ConsumerGroups.

ConsumerGroupsCreateOrUpdateOptionalParams

Parâmetros opcionais.

ConsumerGroupsDeleteOptionalParams

Parâmetros opcionais.

ConsumerGroupsGetOptionalParams

Parâmetros opcionais.

ConsumerGroupsListByEventHubNextOptionalParams

Parâmetros opcionais.

ConsumerGroupsListByEventHubOptionalParams

Parâmetros opcionais.

Destination

Capturar detalhes de armazenamento para a descrição da captura

DisasterRecoveryConfigs

Interface que representa uma DisasterRecoveryConfigs.

DisasterRecoveryConfigsBreakPairingOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsCreateOrUpdateOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsDeleteOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsFailOverOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsGetOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListAuthorizationRulesNextOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListAuthorizationRulesOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListKeysOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListNextOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListOptionalParams

Parâmetros opcionais.

EHNamespace

Item de Espaço de Nomes Único na Lista ou Em Operação Obter

EHNamespaceIdContainer

O ID do ARM completo de um Espaço de Nomes dos Hubs de Eventos

EHNamespaceIdListResult

A resposta da operação IDs do Espaço de Nomes de Lista

EHNamespaceListResult

A resposta da operação Espaço de Nomes de Lista

Encryption

Propriedades para configurar a Encriptação

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

A resposta a erros indica que o serviço hub de eventos não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

EventHubListResult

O resultado da operação Listar EventHubs.

EventHubManagementClientOptionalParams

Parâmetros opcionais.

EventHubs

Interface que representa um EventHubs.

EventHubsCreateOrUpdateAuthorizationRuleOptionalParams

Parâmetros opcionais.

EventHubsCreateOrUpdateOptionalParams

Parâmetros opcionais.

EventHubsDeleteAuthorizationRuleOptionalParams

Parâmetros opcionais.

EventHubsDeleteOptionalParams

Parâmetros opcionais.

EventHubsGetAuthorizationRuleOptionalParams

Parâmetros opcionais.

EventHubsGetOptionalParams

Parâmetros opcionais.

EventHubsListAuthorizationRulesNextOptionalParams

Parâmetros opcionais.

EventHubsListAuthorizationRulesOptionalParams

Parâmetros opcionais.

EventHubsListByNamespaceNextOptionalParams

Parâmetros opcionais.

EventHubsListByNamespaceOptionalParams

Parâmetros opcionais.

EventHubsListKeysOptionalParams

Parâmetros opcionais.

EventHubsRegenerateKeysOptionalParams

Parâmetros opcionais.

Eventhub

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

Identity

Propriedades para configurar a Identidade para Bring your Own Keys

KeyVaultProperties

Propriedades para configurar propriedades keyVault

NWRuleSetIpRules

A resposta da operação Espaço de nomes de lista.

NWRuleSetVirtualNetworkRules

A resposta da operação Espaço de nomes de lista.

Namespaces

Interface que representa espaços de nomes.

NamespacesCheckNameAvailabilityOptionalParams

Parâmetros opcionais.

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Parâmetros opcionais.

NamespacesCreateOrUpdateNetworkRuleSetOptionalParams

Parâmetros opcionais.

NamespacesCreateOrUpdateOptionalParams

Parâmetros opcionais.

NamespacesDeleteAuthorizationRuleOptionalParams

Parâmetros opcionais.

NamespacesDeleteOptionalParams

Parâmetros opcionais.

NamespacesGetAuthorizationRuleOptionalParams

Parâmetros opcionais.

NamespacesGetNetworkRuleSetOptionalParams

Parâmetros opcionais.

NamespacesGetOptionalParams

Parâmetros opcionais.

NamespacesListAuthorizationRulesNextOptionalParams

Parâmetros opcionais.

NamespacesListAuthorizationRulesOptionalParams

Parâmetros opcionais.

NamespacesListByResourceGroupNextOptionalParams

Parâmetros opcionais.

NamespacesListByResourceGroupOptionalParams

Parâmetros opcionais.

NamespacesListKeysOptionalParams

Parâmetros opcionais.

NamespacesListNetworkRuleSetOptionalParams

Parâmetros opcionais.

NamespacesListNextOptionalParams

Parâmetros opcionais.

NamespacesListOptionalParams

Parâmetros opcionais.

NamespacesRegenerateKeysOptionalParams

Parâmetros opcionais.

NamespacesUpdateOptionalParams

Parâmetros opcionais.

NetworkRuleSet

Descrição do recurso do tópico.

NetworkRuleSetListResult

A resposta da operação Listar NetworkRuleSet

Operation

Uma operação da API REST do Hub de Eventos

OperationDisplay

Payload de apresentação da operação

OperationListResult

Resultado do pedido para listar as operações do Hub de Eventos. Contém uma lista de operações e uma ligação de URL para obter o próximo conjunto de resultados.

Operations

Interface que representa uma Operação.

OperationsListNextOptionalParams

Parâmetros opcionais.

OperationsListOptionalParams

Parâmetros opcionais.

PrivateEndpoint

Informações do PrivateEndpoint.

PrivateEndpointConnection

Propriedades do PrivateEndpointConnection.

PrivateEndpointConnectionListResult

Resultado da lista de todas as operações de ligações de ponto final privado.

PrivateEndpointConnections

Interface que representa um PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsDeleteOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsGetOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsListNextOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsListOptionalParams

Parâmetros opcionais.

PrivateLinkResource

Informações do recurso de ligação privada.

PrivateLinkResources

Interface que representa um PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Parâmetros opcionais.

PrivateLinkResourcesListResult

Resultado da operação Listar recursos de ligação privada.

ProxyResource

Campos comuns que são devolvidos na resposta para todos os recursos do Azure Resource Manager

RegenerateAccessKeyParameters

Os parâmetros fornecidos para a operação Regenerar Regra de Autorização especificam a chave que tem de ser reposta.

Resource

Campos comuns que são devolvidos na resposta para todos os recursos do Azure Resource Manager

SchemaGroup

Item único na operação Listar ou Obter Grupo de Esquemas

SchemaGroupListResult

O resultado da operação List SchemaGroup.

SchemaRegistry

Interface que representa um SchemaRegistry.

SchemaRegistryCreateOrUpdateOptionalParams

Parâmetros opcionais.

SchemaRegistryDeleteOptionalParams

Parâmetros opcionais.

SchemaRegistryGetOptionalParams

Parâmetros opcionais.

SchemaRegistryListByNamespaceNextOptionalParams

Parâmetros opcionais.

SchemaRegistryListByNamespaceOptionalParams

Parâmetros opcionais.

Sku

Parâmetros de SKU fornecidos para a operação criar espaço de nomes

Subnet

Propriedades fornecidas para a Sub-rede

SystemData

Metadados relativos à criação e última modificação do recurso.

TrackedResource

Definição de recurso.

UserAssignedIdentity

Valor do Dicionário Reconhecido.

UserAssignedIdentityProperties

Aliases de Tipo

AccessRights

Define valores para AccessRights.
KnownAccessRights pode ser utilizado alternadamente com AccessRights. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Gerir
Enviar
Escutar

ClusterSkuName

Define valores para ClusterSkuName.
KnownClusterSkuName pode ser utilizado alternadamente com ClusterSkuName. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Dedicada

ClustersCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

ClustersGetResponse

Contém dados de resposta para a operação get.

ClustersListAvailableClusterRegionResponse

Contém dados de resposta para a operação listAvailableClusterRegion.

ClustersListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.

ClustersListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.

ClustersListBySubscriptionNextResponse

Contém dados de resposta para a operação listBySubscriptionNext.

ClustersListBySubscriptionResponse

Contém dados de resposta para a operação listBySubscription.

ClustersListNamespacesResponse

Contém dados de resposta para a operação listNamespaces.

ClustersUpdateResponse

Contém dados de resposta para a operação de atualização.

ConfigurationGetResponse

Contém dados de resposta para a operação get.

ConfigurationPatchResponse

Contém dados de resposta para a operação de patch.

ConsumerGroupsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

ConsumerGroupsGetResponse

Contém dados de resposta para a operação get.

ConsumerGroupsListByEventHubNextResponse

Contém dados de resposta para a operação listByEventHubNext.

ConsumerGroupsListByEventHubResponse

Contém dados de resposta para a operação listByEventHub.

CreatedByType

Define valores para CreatedByType.
KnownCreatedByType pode ser utilizado alternadamente com CreatedByType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Utilizador
Aplicação
ManagedIdentity
Chave

DefaultAction

Define valores para DefaultAction.
KnownDefaultAction pode ser utilizado alternadamente com DefaultAction. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Permitir
Negar

DisasterRecoveryConfigsCheckNameAvailabilityResponse

Contém dados de resposta para a operação checkNameAvailability.

DisasterRecoveryConfigsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

DisasterRecoveryConfigsGetAuthorizationRuleResponse

Contém dados de resposta para a operação getAuthorizationRule.

DisasterRecoveryConfigsGetResponse

Contém dados de resposta para a operação get.

DisasterRecoveryConfigsListAuthorizationRulesNextResponse

Contém dados de resposta para a operação listAuthorizationRulesNext.

DisasterRecoveryConfigsListAuthorizationRulesResponse

Contém dados de resposta para a operação listAuthorizationRules.

DisasterRecoveryConfigsListKeysResponse

Contém dados de resposta para a operação listKeys.

DisasterRecoveryConfigsListNextResponse

Contém dados de resposta para a operação listNext.

DisasterRecoveryConfigsListResponse

Contém dados de resposta para a operação de lista.

EncodingCaptureDescription

Define valores para EncodingCaptureDescription.

EndPointProvisioningState

Define valores para EndPointProvisioningState.
KnownEndPointProvisioningState pode ser utilizado alternadamente com EndPointProvisioningState. Este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Criação
Atualização
Eliminar
Com êxito
Cancelado
Com falhas

EntityStatus

Define valores para EntityStatus.

EventHubsCreateOrUpdateAuthorizationRuleResponse

Contém dados de resposta para a operação createOrUpdateAuthorizationRule.

EventHubsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

EventHubsGetAuthorizationRuleResponse

Contém dados de resposta para a operação getAuthorizationRule.

EventHubsGetResponse

Contém dados de resposta para a operação get.

EventHubsListAuthorizationRulesNextResponse

Contém dados de resposta para a operação listAuthorizationRulesNext.

EventHubsListAuthorizationRulesResponse

Contém dados de resposta para a operação listAuthorizationRules.

EventHubsListByNamespaceNextResponse

Contém dados de resposta para a operação listByNamespaceNext.

EventHubsListByNamespaceResponse

Contém dados de resposta para a operação listByNamespace.

EventHubsListKeysResponse

Contém dados de resposta para a operação listKeys.

EventHubsRegenerateKeysResponse

Contém dados de resposta para a operação regenerateKeys.

KeyType

Define valores para KeyType.
KnownKeyType pode ser utilizado alternadamente com KeyType. Este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Chave Primária
Chave Secundária

ManagedServiceIdentityType

Define valores para ManagedServiceIdentityType.

NamespacesCheckNameAvailabilityResponse

Contém dados de resposta para a operação checkNameAvailability.

NamespacesCreateOrUpdateAuthorizationRuleResponse

Contém dados de resposta para a operação createOrUpdateAuthorizationRule.

NamespacesCreateOrUpdateNetworkRuleSetResponse

Contém dados de resposta para a operação createOrUpdateNetworkRuleSet.

NamespacesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

NamespacesGetAuthorizationRuleResponse

Contém dados de resposta para a operação getAuthorizationRule.

NamespacesGetNetworkRuleSetResponse

Contém dados de resposta para a operação getNetworkRuleSet.

NamespacesGetResponse

Contém dados de resposta para a operação get.

NamespacesListAuthorizationRulesNextResponse

Contém dados de resposta para a operação listAuthorizationRulesNext.

NamespacesListAuthorizationRulesResponse

Contém dados de resposta para a operação listAuthorizationRules.

NamespacesListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.

NamespacesListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.

NamespacesListKeysResponse

Contém dados de resposta para a operação listKeys.

NamespacesListNetworkRuleSetResponse

Contém dados de resposta para a operação listNetworkRuleSet.

NamespacesListNextResponse

Contém dados de resposta para a operação listNext.

NamespacesListResponse

Contém dados de resposta para a operação de lista.

NamespacesRegenerateKeysResponse

Contém dados de resposta para a operação regenerateKeys.

NamespacesUpdateResponse

Contém dados de resposta para a operação de atualização.

NetworkRuleIPAction

Define valores para NetworkRuleIPAction.
KnownNetworkRuleIPAction pode ser utilizado alternadamente com NetworkRuleIPAction. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Permitir

OperationsListNextResponse

Contém dados de resposta para a operação listNext.

OperationsListResponse

Contém dados de resposta para a operação de lista.

PrivateEndpointConnectionsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

PrivateEndpointConnectionsGetResponse

Contém dados de resposta para a operação get.

PrivateEndpointConnectionsListNextResponse

Contém dados de resposta para a operação listNext.

PrivateEndpointConnectionsListResponse

Contém dados de resposta para a operação de lista.

PrivateLinkConnectionStatus

Define valores para PrivateLinkConnectionStatus.
KnownPrivateLinkConnectionStatus pode ser utilizado alternadamente com PrivateLinkConnectionStatus. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Pendente
Aprovado
Rejeitado
Desligado

PrivateLinkResourcesGetResponse

Contém dados de resposta para a operação get.

ProvisioningStateDR

Define valores para ProvisioningStateDR.

PublicNetworkAccessFlag

Define valores para PublicNetworkAccessFlag.
KnownPublicNetworkAccessFlag pode ser utilizado alternadamente com PublicNetworkAccessFlag. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Ativado
Desativado

RoleDisasterRecovery

Define valores para RoleDisasterRecovery.

SchemaCompatibility

Define valores para SchemaCompatibility.
A KnownSchemaCompatibility pode ser utilizada alternadamente com SchemaCompatibility. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Nenhuma
para trás
a frente

SchemaRegistryCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

SchemaRegistryGetResponse

Contém dados de resposta para a operação get.

SchemaRegistryListByNamespaceNextResponse

Contém dados de resposta para a operação listByNamespaceNext.

SchemaRegistryListByNamespaceResponse

Contém dados de resposta para a operação listByNamespace.

SchemaType

Define valores para SchemaType.
KnownSchemaType pode ser utilizado alternadamente com SchemaType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Desconhecido
Avro

SkuName

Define valores para SkuName.
KnownSkuName pode ser utilizado alternadamente com o SkuName. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Básica
Standard
Premium

SkuTier

Define valores para SkuTier.
KnownSkuTier pode ser utilizado alternadamente com SkuTier. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Básica
Standard
Premium

UnavailableReason

Define valores para UnavailableReason.

Enumerações

KnownAccessRights

Valores conhecidos do AccessRights que o serviço aceita.

KnownClusterSkuName

Valores conhecidos de ClusterSkuName que o serviço aceita.

KnownCreatedByType

Valores conhecidos de CreatedByType que o serviço aceita.

KnownDefaultAction

Valores conhecidos de DefaultAction que o serviço aceita.

KnownEndPointProvisioningState

Valores conhecidos de EndPointProvisioningState que o serviço aceita.

KnownKeyType

Valores conhecidos de KeyType que o serviço aceita.

KnownNetworkRuleIPAction

Valores conhecidos de NetworkRuleIPAction que o serviço aceita.

KnownPrivateLinkConnectionStatus

Valores conhecidos de PrivateLinkConnectionStatus que o serviço aceita.

KnownPublicNetworkAccessFlag

Valores conhecidos de PublicNetworkAccessFlag que o serviço aceita.

KnownSchemaCompatibility

Valores conhecidos de SchemaCompatibility que o serviço aceita.

KnownSchemaType

Valores conhecidos de SchemaType que o serviço aceita.

KnownSkuName

Valores conhecidos do SkuName que o serviço aceita.

KnownSkuTier

Valores conhecidos de SkuTier que o serviço aceita.

Funções

getContinuationToken(unknown)

Dada uma página de resultado de uma operação paginável, devolve um token de continuação que pode ser utilizado para começar a paginação a partir desse ponto mais tarde.

Detalhes de Função

getContinuationToken(unknown)

Dada uma página de resultado de uma operação paginável, devolve um token de continuação que pode ser utilizado para começar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de resultado da chamada .byPage() numa operação paginada.

Devoluções

string | undefined

O token de continuação que pode ser transmitido porPage().