Compartilhar via


@azure/arm-eventhub package

Classes

EventHubManagementClient

Interfaces

AccessKeys

Cadeia de conexão do Namespace/EventHub

ArmDisasterRecovery

Item único na operação Listar ou Obter Alias (Configuração de Recuperação de Desastre)

ArmDisasterRecoveryListResult

O resultado da operação Listar alias (configuração de recuperação de desastre).

AuthorizationRule

Item único em uma operação List ou Get AuthorizationRule

AuthorizationRuleListResult

A resposta da operação de namespace Listar.

AvailableCluster

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

AvailableClustersList

A resposta da operação Listar 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 namespace

CheckNameAvailabilityResult

O resultado da operação CheckNameAvailability

Cluster

Recurso de Cluster de Hubs de Eventos Únicos nas operações Listar ou Obter.

ClusterListResult

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

ClusterQuotaConfigurationProperties

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

ClusterSku

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

Clusters

Interface que representa um 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 de grupo Listar ou Obter Consumidor

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 um 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 namespace único na lista ou operação get

EHNamespaceIdContainer

A ID completa do ARM de um namespace dos Hubs de Eventos

EHNamespaceIdListResult

A resposta da operação Listar IDs de Namespace

EHNamespaceListResult

A resposta da operação Listar Namespace

Encryption

Propriedades para configurar a criptografia

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

Os detalhes do erro.

ErrorResponse

A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. 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 as propriedades do keyVault

NWRuleSetIpRules

A resposta da operação de namespace Listar.

NWRuleSetVirtualNetworkRules

A resposta da operação de namespace Listar.

Namespaces

Interface que representa um Namespaces.

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 de tópico.

NetworkRuleSetListResult

A resposta da operação List NetworkRuleSet

Operation

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

OperationDisplay

Carga de exibição da operação

OperationListResult

Resultado da solicitação para listar as operações do Hub de Eventos. Ele contém uma lista de operações e um link 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 de PrivateEndpoint.

PrivateEndpointConnection

Propriedades do PrivateEndpointConnection.

PrivateEndpointConnectionListResult

Resultado da lista de todas as operações de conexões de ponto de extremidade 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 link privado.

PrivateLinkResources

Interface que representa um PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Parâmetros opcionais.

PrivateLinkResourcesListResult

Resultado da operação Listar recursos de link privado.

ProxyResource

Campos comuns retornados na resposta para todos os recursos de Resource Manager do Azure

RegenerateAccessKeyParameters

Os parâmetros fornecidos para a operação Regenerar Regra de Autorização especifica qual chave precisa ser redefinida.

Resource

Campos comuns retornados na resposta para todos os recursos de Resource Manager do Azure

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 namespace

Subnet

Propriedades fornecidas para Sub-rede

SystemData

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

TrackedResource

Definição de recurso.

UserAssignedIdentity

Valor reconhecido do Dicionário.

UserAssignedIdentityProperties

Aliases de tipo

AccessRights

Define valores para AccessRights.
KnownAccessRights pode ser usado de forma intercambiável com AccessRights, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Gerenciar
Enviar
Escutar

ClusterSkuName

Define valores para ClusterSkuName.
KnownClusterSkuName pode ser usado de forma intercambiável com ClusterSkuName, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Dedicado

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 usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Usuário
Aplicativo
ManagedIdentity
Chave

DefaultAction

Define valores para DefaultAction.
KnownDefaultAction pode ser usado de forma intercambiável com DefaultAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Permitir
Deny

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 usado de forma intercambiável com EndPointProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Criando
Atualizar
Excluir
Êxito
Cancelado
Com falha

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 usado de forma intercambiável com KeyType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

PrimaryKey
SecondaryKey

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 usado intercambiável com NetworkRuleIPAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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 usado intercambiável com PrivateLinkConnectionStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Pendente
Aprovado
Rejeitado
Desconectado

PrivateLinkResourcesGetResponse

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

ProvisioningStateDR

Define valores para ProvisioningStateDR.

PublicNetworkAccessFlag

Define valores para PublicNetworkAccessFlag.
KnownPublicNetworkAccessFlag pode ser usado intercambiável com PublicNetworkAccessFlag, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Enabled
Desabilitado

RoleDisasterRecovery

Define valores para RoleDisasterRecovery.

SchemaCompatibility

Define valores para SchemaCompatibility.
KnownSchemaCompatibility pode ser usado intercambiável com SchemaCompatibility, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Nenhuma
Para Trás
Encaminhar

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 usado intercambiável com SchemaType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Desconhecido
Avro

SkuName

Define valores para SkuName.
KnownSkuName pode ser usado de forma intercambiável com SkuName, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Basic
Standard
Premium

SkuTier

Define valores para SkuTier.
KnownSkuTier pode ser usado intercambiável com SkuTier, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Basic
Standard
Premium

UnavailableReason

Define valores para UnavailableReason.

Enumerações

KnownAccessRights

Valores conhecidos de 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 de 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, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de resultado de chamar .byPage() em uma operação paginada.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage().