@azure/arm-eventhub package
Classes
| EventHubManagementClient |
Interfaces
| AccessKeys |
Cadeia de conexão Namespace/EventHub |
| ApplicationGroup |
O objeto Application Group |
| ApplicationGroupOperationsCreateOrUpdateApplicationGroupOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsDeleteOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsGetOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsListByNamespaceOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsOperations |
Interface representando uma operação ApplicationGroupOperations. |
| ApplicationGroupPolicy |
Propriedades da política de Grupo de Aplicativos |
| ApplicationGroupProperties |
interface do modelo Propriedades do Grupo de Aplicações |
| ArmDisasterRecovery |
Item único na operação List ou Get Alias (configuração de recuperação de desastres) |
| ArmDisasterRecoveryProperties |
Propriedades necessárias para o alias Criar ou atualizar (configurações de recuperação de desastre) |
| AuthorizationRule |
Item único em uma operação List ou Get AuthorizationRule |
| AuthorizationRuleProperties |
Propriedades fornecidas para criar ou atualizar AuthorizationRule |
| AvailableCluster |
Contagem de Clusters de Hubs de Eventos pré-provisionada e prontamente disponível por região. |
| AvailableClustersList |
A resposta da operação Listar Clusters Disponíveis. |
| CaptureDescription |
Propriedades para configurar a descrição de captura para eventhub |
| CaptureIdentity |
Um valor que indica se a descrição da captura está habilitada. |
| 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 Evento Único nas operações List ou Get. |
| ClusterProperties |
Hubs de Eventos Propriedades de cluster fornecidas nas respostas nas operações List ou Get. |
| ClusterQuotaConfigurationProperties |
Contém todas as configurações para o cluster. |
| ClusterSku |
Parâmetros de SKU específicos de uma instância de cluster. |
| ClustersCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| ClustersDeleteOptionalParams |
Parâmetros opcionais. |
| ClustersGetOptionalParams |
Parâmetros opcionais. |
| ClustersListAvailableClusterRegionOptionalParams |
Parâmetros opcionais. |
| ClustersListByResourceGroupOptionalParams |
Parâmetros opcionais. |
| ClustersListBySubscriptionOptionalParams |
Parâmetros opcionais. |
| ClustersListNamespacesOptionalParams |
Parâmetros opcionais. |
| ClustersOperations |
Interface que representa operações de Clusters. |
| ClustersUpdateOptionalParams |
Parâmetros opcionais. |
| ConfidentialCompute |
interface do modelo ConfidentialCompute |
| ConfigurationGetOptionalParams |
Parâmetros opcionais. |
| ConfigurationOperations |
Interface representando operações de Configuração. |
| ConfigurationPatchOptionalParams |
Parâmetros opcionais. |
| ConnectionState |
Informações de ConnectionState. |
| ConsumerGroup |
Item único na operação do grupo Listar ou Obter Consumidor |
| ConsumerGroupProperties |
Item único na operação do grupo Listar ou Obter Consumidor |
| ConsumerGroupsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| ConsumerGroupsDeleteOptionalParams |
Parâmetros opcionais. |
| ConsumerGroupsGetOptionalParams |
Parâmetros opcionais. |
| ConsumerGroupsListByEventHubOptionalParams |
Parâmetros opcionais. |
| ConsumerGroupsOperations |
Interface representando uma operação ConsumerGroups. |
| Destination |
Detalhes de armazenamento de captura para descrição da captura |
| DestinationProperties |
Propriedades que descrevem a conta de armazenamento, o contêiner de blob e o formato de nome de arquivo para o destino da captura |
| 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. |
| DisasterRecoveryConfigsListAuthorizationRulesOptionalParams |
Parâmetros opcionais. |
| DisasterRecoveryConfigsListKeysOptionalParams |
Parâmetros opcionais. |
| DisasterRecoveryConfigsListOptionalParams |
Parâmetros opcionais. |
| DisasterRecoveryConfigsOperations |
Interface representando uma operação DisasterRecoveryConfigs. |
| EHNamespace |
Item de namespace único em List ou Get Operation |
| EHNamespaceIdContainer |
A ID ARM completa de um namespace de Hubs de Eventos |
| EHNamespaceIdListResult |
A resposta da operação List Namespace IDs |
| EHNamespaceProperties |
Propriedades de namespace fornecidas para a operação de criação de namespace. |
| Encryption |
Propriedades para configurar a criptografia |
| ErrorAdditionalInfo |
O erro de gerenciamento de recursos informações adicionais. |
| ErrorDetail |
O detalhe 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. |
| EventHubManagementClientOptionalParams |
Parâmetros opcionais para o cliente. |
| EventHubsCreateOrUpdateAuthorizationRuleOptionalParams |
Parâmetros opcionais. |
| EventHubsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| EventHubsDeleteAuthorizationRuleOptionalParams |
Parâmetros opcionais. |
| EventHubsDeleteOptionalParams |
Parâmetros opcionais. |
| EventHubsGetAuthorizationRuleOptionalParams |
Parâmetros opcionais. |
| EventHubsGetOptionalParams |
Parâmetros opcionais. |
| EventHubsListAuthorizationRulesOptionalParams |
Parâmetros opcionais. |
| EventHubsListByNamespaceOptionalParams |
Parâmetros opcionais. |
| EventHubsListKeysOptionalParams |
Parâmetros opcionais. |
| EventHubsOperations |
Interface representando operações de EventHubs. |
| EventHubsRegenerateKeysOptionalParams |
Parâmetros opcionais. |
| Eventhub |
Item único na operação Listar ou Obter Hub de Eventos |
| EventhubProperties |
Propriedades fornecidas para a operação Criar ou atualizar Hub de Eventos. |
| FailOver |
FailOver da interface do modelo |
| FailOverProperties |
FailOverProperties da interface do modelo |
| GeoDataReplicationProperties |
Propriedades de replicação GeoDR |
| Identity |
Propriedades para configurar a identidade para trazer suas próprias chaves |
| KeyVaultProperties |
Propriedades para configurar as propriedades do keyVault |
| MessageTimestampDescription |
Propriedades de MessageTimestamp Descrição |
| NWRuleSetIpRules |
A resposta da operação de namespace List. |
| NWRuleSetVirtualNetworkRules |
A resposta da operação de namespace List. |
| NamespaceReplicaLocation |
Propriedades de replicação de namespace |
| NamespacesCheckNameAvailabilityOptionalParams |
Parâmetros opcionais. |
| NamespacesCreateOrUpdateAuthorizationRuleOptionalParams |
Parâmetros opcionais. |
| NamespacesCreateOrUpdateNetworkRuleSetOptionalParams |
Parâmetros opcionais. |
| NamespacesCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| NamespacesDeleteAuthorizationRuleOptionalParams |
Parâmetros opcionais. |
| NamespacesDeleteOptionalParams |
Parâmetros opcionais. |
| NamespacesFailoverOptionalParams |
Parâmetros opcionais. |
| NamespacesGetAuthorizationRuleOptionalParams |
Parâmetros opcionais. |
| NamespacesGetNetworkRuleSetOptionalParams |
Parâmetros opcionais. |
| NamespacesGetOptionalParams |
Parâmetros opcionais. |
| NamespacesListAuthorizationRulesOptionalParams |
Parâmetros opcionais. |
| NamespacesListByResourceGroupOptionalParams |
Parâmetros opcionais. |
| NamespacesListKeysOptionalParams |
Parâmetros opcionais. |
| NamespacesListNetworkRuleSetOptionalParams |
Parâmetros opcionais. |
| NamespacesListOptionalParams |
Parâmetros opcionais. |
| NamespacesOperations |
Interface que representa uma operação Namespaces. |
| NamespacesRegenerateKeysOptionalParams |
Parâmetros opcionais. |
| NamespacesUpdateOptionalParams |
Parâmetros opcionais. |
| NetworkRuleSet |
Descrição do recurso tópico. |
| NetworkRuleSetListResult |
Coleção paginada de itens NetworkRuleSet |
| NetworkRuleSetProperties |
Propriedades NetworkRuleSet |
| NetworkSecurityPerimeter |
Informações relacionadas ao NetworkSecurityPerimeter |
| NetworkSecurityPerimeterConfiguration |
Configurações relacionadas ao Perímetro de Segurança de Rede de um determinado namespace |
| NetworkSecurityPerimeterConfigurationList |
Resultado da operação List NetworkSecurityPerimeterConfiguration. |
| NetworkSecurityPerimeterConfigurationOperationsListOptionalParams |
Parâmetros opcionais. |
| NetworkSecurityPerimeterConfigurationOperationsOperations |
Interface representando operações de NetworkSecurityPerimeterConfigurationOperations. |
| NetworkSecurityPerimeterConfigurationProperties |
Propriedades do NetworkSecurityPerimeterConfiguration |
| NetworkSecurityPerimeterConfigurationPropertiesProfile |
Informações sobre o perfil de rede atual |
| NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation |
Informações sobre a associação de recursos |
| NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams |
Parâmetros opcionais. |
| NetworkSecurityPerimeterConfigurationsOperations |
Interface representando operações de NetworkSecurityPerimeterConfigurations. |
| NspAccessRule |
Informação da Regra de Acesso no Perfil de Rede |
| NspAccessRuleProperties |
Propriedades da regra de acesso |
| NspAccessRulePropertiesSubscriptionsItem |
Subscrição para regra de entrada |
| Operation |
Uma operação da API REST do Hub de Eventos |
| OperationDisplay |
Carga útil do visor da operação |
| OperationsListOptionalParams |
Parâmetros opcionais. |
| OperationsOperations |
Interface que representa uma operação de Operações. |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável até a conclusão e por página. |
| PlatformCapabilities |
interface de modelo PlataformaCapacidades |
| PrivateEndpoint |
Informações do PrivateEndpoint. |
| PrivateEndpointConnection |
Propriedades do PrivateEndpointConnection. |
| PrivateEndpointConnectionProperties |
Propriedades do recurso de ligação ao endpoint privado. |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Parâmetros opcionais. |
| PrivateEndpointConnectionsGetOptionalParams |
Parâmetros opcionais. |
| PrivateEndpointConnectionsListOptionalParams |
Parâmetros opcionais. |
| PrivateEndpointConnectionsOperations |
Interface que representa uma operação PrivateEndpointConnections. |
| PrivateLinkResource |
Informações do recurso de link privado. |
| PrivateLinkResourceProperties |
Propriedades do PrivateLinkResource |
| PrivateLinkResourcesGetOptionalParams |
Parâmetros opcionais. |
| PrivateLinkResourcesListResult |
Coleção paginada de itens PrivateLinkResource |
| PrivateLinkResourcesOperations |
Interface que representa uma operação PrivateLinkResources. |
| ProvisioningIssue |
Descreve o problema de provisionamento para determinado NetworkSecurityPerimeterConfiguration |
| ProvisioningIssueProperties |
Propriedades do problema de provisionamento |
| ProxyResource |
A definição de modelo de recurso para um recurso de proxy do Azure Resource Manager. Ele não terá tags e um local |
| RegenerateAccessKeyParameters |
Parâmetros fornecidos para a operação Regra de Autorização de Regeneração, especifica qual chave precisa ser redefinida. |
| Resource |
Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager |
| RestorePollerOptions | |
| RetentionDescription |
Propriedades para definir configurações de retenção para o eventhub |
| SchemaGroup |
Item único na operação Listar ou Obter Grupo de Esquemas |
| SchemaGroupProperties |
interface do modelo Propriedades do Grupo do Esquema |
| SchemaRegistryCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| SchemaRegistryDeleteOptionalParams |
Parâmetros opcionais. |
| SchemaRegistryGetOptionalParams |
Parâmetros opcionais. |
| SchemaRegistryListByNamespaceOptionalParams |
Parâmetros opcionais. |
| SchemaRegistryOperations |
Interface que representa operações de um SchemaRegistre. |
| SimplePollerLike |
Um poller simples que pode ser usado para sondar uma operação de longa duração. |
| Sku |
Parâmetros de SKU fornecidos para a operação create namespace |
| Subnet |
Propriedades fornecidas para Sub-rede |
| SystemData |
Metadados referentes à criação e última modificação do recurso. |
| ThrottlingPolicy |
Propriedades da política de limitação |
| UserAssignedIdentity |
Valor reconhecido do dicionário. |
| UserAssignedIdentityProperties |
interface do modelo UtilizadorAtribuidoIdentidadePropriedades |
Aliases de Tipo
| AccessRights |
Tipo de Direitos de Acesso |
| ApplicationGroupPolicyType |
Tipos de Políticas de Grupo de Aplicações Valores conhecidos suportados pelo serviçoThrottlingPolicy |
| ApplicationGroupPolicyUnion |
Alias para ApplicationGroupPolicyUnion |
| AzureSupportedClouds |
Os valores suportados para a configuração de nuvem como um tipo literal de cadeia de caracteres |
| CaptureIdentityType |
Tipo de Identidade Gerida do Azure Active Directory. |
| CleanupPolicyRetentionDescription |
Enumera os valores possíveis para a política de limpeza Valores conhecidos suportados pelo serviço
Excluir |
| ClusterSkuName |
Nome deste SKU. Valores conhecidos suportados pelo serviçoDedicado |
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| CreatedByType |
O tipo de entidade que criou o recurso. Valores conhecidos suportados pelo serviço
User: A entidade foi criada por um usuário. |
| DefaultAction |
Ação Padrão para Conjunto de Regras de Rede Valores conhecidos suportados pelo serviço
Permitir |
| EncodingCaptureDescription |
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 |
| EndPointProvisioningState |
Estado de provisionamento da Private Endpoint Connection. Valores conhecidos suportados pelo serviço
Criação de |
| EntityStatus |
Enumera os valores possíveis para o status do Hub de Eventos. |
| GeoDRRoleType |
Tipos de Funções GeoDR Valores conhecidos suportados pelo serviço
Primária |
| KeyType |
A chave de acesso para regenerar. Valores conhecidos suportados pelo serviço
PrimaryKey |
| ManagedServiceIdentityType |
Tipo de identidade de serviço gerenciado. |
| MetricId |
O Metric Id onde o limite de aceleração deve ser definido, o MetricId pode ser descoberto passando o cursor sobre o Metric na secção Metrics do Event Hub Namespace dentro do portal do Azure Valores conhecidos suportados pelo serviço
IncomingBytes |
| Mode |
Definição para Ativar ou Desabilitar a Computação Confidencial Valores conhecidos suportados pelo serviço
Deficientes |
| NetworkRuleIPAction |
A Ação do Filtro IP Valores conhecidos suportados pelo serviçoPermitir |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Estado de provisionamento da propagação da configuração do NetworkSecurityPerimeter Valores conhecidos suportados pelo serviço
Desconhecido |
| NspAccessRuleDirection |
Regra de Direção de Acesso Valores conhecidos suportados pelo serviço
de entrada |
| PrivateLinkConnectionStatus |
Status da conexão. Valores conhecidos suportados pelo serviço
pendente |
| ProvisioningState |
Estado de provisionamento do Cluster. Valores conhecidos suportados pelo serviço
Desconhecido |
| ProvisioningStateDR |
Estado de provisionamento do alias (configuração de recuperação de desastre) - valores possíveis 'Aceito' ou 'Aprovado' ou 'Falhou' |
| PublicNetworkAccess |
Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Valores conhecidos suportados pelo serviço
ativado |
| PublicNetworkAccessFlag |
Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Se o valor for SecuredByPerimeter, a comunicação de entrada e saída será controlada pelo perímetro de segurança de rede e pelas regras de acesso do perfil. Valores conhecidos suportados pelo serviço
ativado |
| ResourceAssociationAccessMode |
Modo de Acesso da associação de recursos Valores conhecidos suportados pelo serviço
NoAssociationMode |
| RoleDisasterRecovery |
função do namespace no GEO DR - valores possíveis 'Primário' ou 'PrimaryNotReplicating' ou 'Secundário' |
| SchemaCompatibility |
Tipo de Compatibilidade de Esquemas |
| SchemaType |
Tipo de SchemaType |
| SkuName |
Nome deste SKU. Valores conhecidos suportados pelo serviço
Básico |
| SkuTier |
O nível de faturamento dessa SKU específica. Valores conhecidos suportados pelo serviço
Básico |
| TimestampType |
Indica o tipo de carimbo de data/hora que a mensagem conterá. Dois tipos de carimbo de data/hora - "AppendTime" e "CreateTime". AppendTime refere-se à hora em que a mensagem foi anexada dentro do log do broker. CreateTime refere-se à hora em que a mensagem foi gerada no lado da origem e os produtores podem definir esse carimbo de data/hora ao enviar a mensagem. O valor padrão é AppendTime. Se você estiver usando o protocolo AMQP, CreateTime é igual a AppendTime e seu comportamento permanece o mesmo. Valores conhecidos suportados pelo serviço
LogAppend |
| TlsVersion |
A versão mínima de TLS para o cluster suportar, por exemplo, '1.2' Valores conhecidos suportados pelo serviço
1,0 |
| UnavailableReason |
Especifica o motivo da indisponibilidade do serviço. |
Enumerações
| AzureClouds |
Um enum para descrever ambientes Azure Cloud. |
| KnownAccessRights |
Os valores conhecidos de AccessRights que o serviço aceita. |
| KnownApplicationGroupPolicyType |
Tipos de Diretiva de Grupo de Aplicativo |
| KnownCleanupPolicyRetentionDescription |
Enumera os valores possíveis para a política de limpeza |
| KnownClusterSkuName |
Nome deste SKU. |
| KnownCreatedByType |
O tipo de entidade que criou o recurso. |
| KnownDefaultAction |
Ação padrão para o conjunto de regras de rede |
| KnownEndPointProvisioningState |
Estado de provisionamento da Private Endpoint Connection. |
| KnownGeoDRRoleType |
Tipos de função GeoDR |
| KnownKeyType |
A chave de acesso para regenerar. |
| KnownMetricId |
O Metric Id onde o limite de aceleração deve ser definido, o MetricId pode ser descoberto passando o cursor sobre o Metric na secção Metrics do Event Hub Namespace dentro do portal do Azure |
| KnownMode |
Configuração para habilitar ou desabilitar computação confidencial |
| KnownNetworkRuleIPAction |
A ação do filtro IP |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
Estado de provisionamento da propagação da configuração NetworkSecurityPerimeter |
| KnownNspAccessRuleDirection |
Direção da Regra de Acesso |
| KnownPrivateLinkConnectionStatus |
Status da conexão. |
| KnownProvisioningState |
Estado de provisionamento do Cluster. |
| KnownPublicNetworkAccess |
Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. |
| KnownPublicNetworkAccessFlag |
Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Se o valor for SecuredByPerimeter, a comunicação de entrada e saída será controlada pelo perímetro de segurança de rede e pelas regras de acesso do perfil. |
| KnownResourceAssociationAccessMode |
Modo de acesso da associação de recursos |
| KnownSchemaCompatibility |
Os valores conhecidos de SchemaCompatibility que o serviço aceita. |
| KnownSchemaType |
Os valores conhecidos de SchemaType que o serviço aceita. |
| KnownSkuName |
Nome deste SKU. |
| KnownSkuTier |
O nível de faturamento dessa SKU específica. |
| KnownTimestampType |
Indica o tipo de carimbo de data/hora que a mensagem conterá. Dois tipos de carimbo de data/hora - "AppendTime" e "CreateTime". AppendTime refere-se à hora em que a mensagem foi anexada dentro do log do broker. CreateTime refere-se à hora em que a mensagem foi gerada no lado da origem e os produtores podem definir esse carimbo de data/hora ao enviar a mensagem. O valor padrão é AppendTime. Se você estiver usando o protocolo AMQP, CreateTime é igual a AppendTime e seu comportamento permanece o mesmo. |
| KnownTlsVersion |
A versão TLS mínima para o cluster suportar, por exemplo, '1.2' |
| KnownVersions |
As versões de API disponíveis. |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes de Função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): eParâmetros
- e
-
unknown
Algo apanhado por uma cláusula de captura.
Devoluções
e
restorePoller<TResponse, TResult>(EventHubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.
function restorePoller<TResponse, TResult>(client: EventHubManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>Parâmetros
- client
- EventHubManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluções
PollerLike<OperationState<TResult>, TResult>
Detalhes das variáveis
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor