@azure/arm-eventhub package
Classes
| EventHubManagementClient |
Interfaces
| AccessKeys |
Cadeia de conexão do Namespace/EventHub |
| ApplicationGroup |
O objeto Grupo de Aplicativos |
| ApplicationGroupOperationsCreateOrUpdateApplicationGroupOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsDeleteOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsGetOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsListByNamespaceOptionalParams |
Parâmetros opcionais. |
| ApplicationGroupOperationsOperations |
Interface representando uma operação do ApplicationGroupOperations. |
| ApplicationGroupPolicy |
Propriedades da política de Grupo de Aplicativos |
| ApplicationGroupProperties |
interface do modelo ApplicationGroupProperties |
| ArmDisasterRecovery |
Item único na operação Lista ou Obter Alias (Configuração de Recuperação de Desastre) |
| ArmDisasterRecoveryProperties |
Propriedades necessárias para criar ou atualizar alias (configurações de recuperação de desastre) |
| AuthorizationRule |
Item único em uma operação List or Get AuthorizationRule |
| AuthorizationRuleProperties |
Propriedades fornecidas para criar ou atualizar AuthorizationRule |
| 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 |
| 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 Eventos Únicos em Operações de Lista ou Obtenção. |
| ClusterProperties |
Propriedades do Cluster de Hubs de Eventos fornecidas em respostas nas operações List ou Get. |
| ClusterQuotaConfigurationProperties |
Contém todas as configurações do cluster. |
| ClusterSku |
Parâmetros de SKU específicos para 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 uma operação de Clusters. |
| ClustersUpdateOptionalParams |
Parâmetros opcionais. |
| ConfidentialCompute |
interface de modelo ConfidentialCompute |
| ConfigurationGetOptionalParams |
Parâmetros opcionais. |
| ConfigurationOperations |
Interface representando uma Configuração de operações. |
| ConfigurationPatchOptionalParams |
Parâmetros opcionais. |
| ConnectionState |
Informações do ConnectionState. |
| ConsumerGroup |
Item único na operação de grupo Listar ou Obter Consumidor |
| ConsumerGroupProperties |
Item único na operação de 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 de ConsumerGroups. |
| Destination |
Capturar detalhes de armazenamento para a descrição da captura |
| DestinationProperties |
Propriedades que descrevem a conta de armazenamento, o contêiner de blob e o formato de nome de arquivo morto para o destino de 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 Lista ou Operação de Obtenção |
| EHNamespaceIdContainer |
A ID completa do ARM de um namespace dos Hubs de Eventos |
| EHNamespaceIdListResult |
A resposta da operação listar IDs de namespace |
| EHNamespaceProperties |
Propriedades de namespace fornecidas para criar operação de namespace. |
| Encryption |
Propriedades para configurar a Criptografia |
| ErrorAdditionalInfo |
As informações adicionais do erro de gerenciamento de recursos. |
| 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 uma operação 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 |
Interface de modelo Propriedades de FailOverS |
| GeoDataReplicationProperties |
Propriedades de Replicação de GeoDR |
| Identity |
Propriedades para configurar a identidade para trazer suas próprias chaves |
| KeyVaultProperties |
Propriedades para configurar propriedades keyVault |
| MessageTimestampDescription |
Propriedades da descrição messageTimestamp |
| NWRuleSetIpRules |
A resposta da operação namespace Lista. |
| NWRuleSetVirtualNetworkRules |
A resposta da operação namespace Lista. |
| 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 de Namespaces. |
| NamespacesRegenerateKeysOptionalParams |
Parâmetros opcionais. |
| NamespacesUpdateOptionalParams |
Parâmetros opcionais. |
| NetworkRuleSet |
Descrição do recurso de tópico. |
| NetworkRuleSetListResult |
Coleção paginada de itens NetworkRuleSet |
| NetworkRuleSetProperties |
Propriedades de NetworkRuleSet |
| NetworkSecurityPerimeter |
Informações relacionadas a 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 da RedeSegurançaConfiguração do Perímetro |
| NetworkSecurityPerimeterConfigurationPropertiesProfile |
Informações sobre o perfil de rede atual |
| NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation |
Informações sobre associação de recursos |
| NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams |
Parâmetros opcionais. |
| NetworkSecurityPerimeterConfigurationsOperations |
Interface representando operações de NetworkSecurityPerimeterConfigurations. |
| NspAccessRule |
Informações da regra de acesso no perfil de rede |
| NspAccessRuleProperties |
Propriedades da regra de acesso |
| NspAccessRulePropertiesSubscriptionsItem |
Assinatura da regra de entrada |
| Operation |
Uma operação de API REST do Hub de Eventos |
| OperationDisplay |
Conteúdo de exibição da operação |
| OperationsListOptionalParams |
Parâmetros opcionais. |
| OperationsOperations |
Interface que representa operações de operações. |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página. |
| PlatformCapabilities |
interface de modelo Plataformas Capacidades |
| PrivateEndpoint |
Informações do PrivateEndpoint. |
| PrivateEndpointConnection |
Propriedades do PrivateEndpointConnection. |
| PrivateEndpointConnectionProperties |
Propriedades do recurso de conexão do 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 do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local |
| RegenerateAccessKeyParameters |
Parâmetros fornecidos para a operação Regra de Autorização regenerada 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 as 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 representando operações de um SchemaRegistrer. |
| SimplePollerLike |
Um sondador simples que pode ser usado para sondar uma operação de longa execução. |
| 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. |
| ThrottlingPolicy |
Propriedades da política de limitação |
| UserAssignedIdentity |
Valor reconhecido do Dicionário. |
| UserAssignedIdentityProperties |
interface de modelo ProprietáriosIdentidadeAtribuidosUsuários |
Aliases de tipo
| AccessRights |
Tipo de Direitos de Acesso |
| ApplicationGroupPolicyType |
Tipos de Políticas de Grupo de Aplicações Valores conhecidos compatíveis com o serviçoThrottlingPolicy |
| ApplicationGroupPolicyUnion |
Alias para ApplicationGroupPolicyUnion |
| AzureSupportedClouds |
Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres |
| CaptureIdentityType |
Tipo de identidade gerenciada Azure Active Directory. |
| CleanupPolicyRetentionDescription |
Enumera os valores possíveis para a política de limpeza Valores conhecidos compatíveis com o serviço
excluir |
| ClusterSkuName |
Nome dessa SKU. Valores conhecidos compatíveis com o serviçodedicado |
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| CreatedByType |
O tipo de entidade que criou o recurso. Valores conhecidos compatíveis com o serviço
User: a entidade foi criada por um usuário. |
| DefaultAction |
Ação Padrão para o Conjunto de Regras de Rede Valores conhecidos compatíveis com o serviço
Permitir |
| EncodingCaptureDescription |
Enumera os valores possíveis para o formato de codificação da descrição da captura. Observação: 'AvroDeflate' será preterido na nova versão da API |
| EndPointProvisioningState |
Estado de provisionamento da Conexão de Ponto de Extremidade Privado. Valores conhecidos compatíveis com o serviço
criando |
| EntityStatus |
Enumera os valores possíveis para o status do Hub de Eventos. |
| GeoDRRoleType |
Tipos de Função do GeoDR Valores conhecidos compatíveis com o serviço
Primary |
| KeyType |
A chave de acesso a ser regenerada. Valores conhecidos compatíveis com o serviço
PrimaryKey |
| ManagedServiceIdentityType |
Tipo de identidade de serviço gerenciado. |
| MetricId |
O Metric Id no qual o limite de aceleração deve ser definido, o MetricId pode ser descoberto passando o mouse sobre o Metric na seção Metrics do Event Hub Namespace dentro do portal do Azure Valores conhecidos compatíveis com o serviço
IncomingBytes |
| Mode |
Configuração para Habilitar ou Desabilitar o Comput Confidencial Valores conhecidos compatíveis com o serviço
desabilitado |
| NetworkRuleIPAction |
A ação do filtro IP Valores conhecidos compatíveis com o serviçoPermitir |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Estado de provisionamento da propagação da configuração do NetworkSecurityPerimeter Valores conhecidos compatíveis com o serviço
Desconhecido |
| NspAccessRuleDirection |
Regra de Direção de Acesso Valores conhecidos compatíveis com o serviço
de entrada |
| PrivateLinkConnectionStatus |
Status da conexão. Valores conhecidos compatíveis com o serviço
pendente |
| ProvisioningState |
Estado de provisionamento do Cluster. Valores conhecidos compatíveis com o serviço
Desconhecido |
| ProvisioningStateDR |
Estado de provisionamento do Alias(configuração de recuperação de desastre) – valores possíveis 'Aceitos' ou 'Bem-sucedidos' ou 'Com falha' |
| PublicNetworkAccess |
Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Valores conhecidos compatíveis com o serviço
habilitado |
| PublicNetworkAccessFlag |
Isso determina se o tráfego é permitido pela 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 compatíveis com o serviço
habilitado |
| ResourceAssociationAccessMode |
Modo de acesso da associação de recursos Valores conhecidos compatíveis com o serviço
NoAssociationMode |
| RoleDisasterRecovery |
função de namespace na RECUPERAÇÃO GEOGRÁFICA – valores possíveis 'Primary' ou 'PrimaryNotReplicating' ou 'Secondary' |
| SchemaCompatibility |
Tipo de Compatibilidade de Esquemas |
| SchemaType |
Tipo de SchemaType |
| SkuName |
Nome dessa SKU. Valores conhecidos compatíveis com o serviço
Básico |
| SkuTier |
A camada de cobrança deste SKU específico. Valores conhecidos compatíveis com o serviço
Básico |
| TimestampType |
Denota o tipo de carimbo de data/hora que a mensagem conterá. Dois tipos de tipos de carimbo de data/hora : "AppendTime" e "CreateTime". AppendTime refere-se ao tempo em que a mensagem foi acrescentada dentro do log do agente. CreateTime refere-se ao tempo 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 será igual a AppendTime e seu comportamento permanecerá o mesmo. Valores conhecidos compatíveis com o serviço
do LogAppend |
| TlsVersion |
A versão mínima de TLS para o cluster suportar, por exemplo, '1.2' Valores conhecidos compatíveis com o serviço
1.0 |
| UnavailableReason |
Especifica o motivo da indisponibilidade do serviço. |
Enumerações
| AzureClouds |
Um enum para descrever ambientes de nuvem Azure. |
| KnownAccessRights |
Valores conhecidos de AccessRights que o serviço aceita. |
| KnownApplicationGroupPolicyType |
Tipos de Política de Grupo de Aplicativos |
| KnownCleanupPolicyRetentionDescription |
Enumera os valores possíveis para a política de limpeza |
| KnownClusterSkuName |
Nome dessa 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 Conexão de Ponto de Extremidade Privado. |
| KnownGeoDRRoleType |
Tipos de função GeoDR |
| KnownKeyType |
A chave de acesso a ser regenerada. |
| KnownMetricId |
ID de métrica na qual o limite de limitação deve ser definido, MetricId pode ser descoberto passando o mouse sobre a Métrica na seção Métricas do Namespace do Hub de Eventos dentro de portal do Azure |
| KnownMode |
Configuração para habilitar ou desabilitar a computação confidencial |
| KnownNetworkRuleIPAction |
A ação filtro IP |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
Estado de provisionamento da propagação de configuração de NetworkSecurityPerimeter |
| KnownNspAccessRuleDirection |
Regra de direção de acesso |
| KnownPrivateLinkConnectionStatus |
Status da conexão. |
| KnownProvisioningState |
Estado de provisionamento do Cluster. |
| KnownPublicNetworkAccess |
Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. |
| KnownPublicNetworkAccessFlag |
Isso determina se o tráfego é permitido pela 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 |
Valores conhecidos de SchemaCompatibility que o serviço aceita. |
| KnownSchemaType |
Valores conhecidos de SchemaType que o serviço aceita. |
| KnownSkuName |
Nome dessa SKU. |
| KnownSkuTier |
A camada de cobrança deste SKU específico. |
| KnownTimestampType |
Denota o tipo de carimbo de data/hora que a mensagem conterá. Dois tipos de tipos de carimbo de data/hora : "AppendTime" e "CreateTime". AppendTime refere-se ao tempo em que a mensagem foi acrescentada dentro do log do agente. CreateTime refere-se ao tempo 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 será igual a AppendTime e seu comportamento permanecerá o mesmo. |
| KnownTlsVersion |
A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2' |
| KnownVersions |
As versões de API disponíveis. |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes da função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parâmetros
- e
-
unknown
Algo pego por uma cláusula catch.
Retornos
e
restorePoller<TResponse, TResult>(EventHubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver 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>
Retornos
PollerLike<OperationState<TResult>, TResult>
Detalhes da variável
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor