@azure/arm-eventhub package
Clases
| EventHubManagementClient |
Interfaces
| AccessKeys |
Espacio de nombres/Cadena de conexión de EventHub |
| ApplicationGroup |
El objeto Grupo de aplicaciones |
| ApplicationGroupOperationsCreateOrUpdateApplicationGroupOptionalParams |
Parámetros opcionales. |
| ApplicationGroupOperationsDeleteOptionalParams |
Parámetros opcionales. |
| ApplicationGroupOperationsGetOptionalParams |
Parámetros opcionales. |
| ApplicationGroupOperationsListByNamespaceOptionalParams |
Parámetros opcionales. |
| ApplicationGroupOperationsOperations |
Interfaz que representa una operación de ApplicationGroupOperations. |
| ApplicationGroupPolicy |
Propiedades de la directiva de grupo de aplicaciones |
| ApplicationGroupProperties |
interfaz de modelo AplicacionesPropiedades de Grupo de Aplicación |
| ArmDisasterRecovery |
Elemento único en la operación List or Get Alias(Disaster Recovery Configuration) |
| ArmDisasterRecoveryProperties |
Propiedades necesarias para crear o actualizar alias (configuraciones de recuperación ante desastres) |
| AuthorizationRule |
Elemento único en una operación List o Get AuthorizationRule |
| AuthorizationRuleProperties |
Propiedades proporcionadas para crear o actualizar AuthorizationRule |
| AvailableCluster |
Recuento de clústeres de Event Hubs previamente aprovisionados y disponibles fácilmente por región. |
| AvailableClustersList |
Respuesta de la operación Enumerar clústeres disponibles. |
| CaptureDescription |
Propiedades para configurar la descripción de captura para eventhub |
| CaptureIdentity |
Valor que indica si la descripción de captura está habilitada. |
| CheckNameAvailabilityParameter |
Parámetro proporcionado para comprobar la operación de disponibilidad del nombre del espacio de nombres |
| CheckNameAvailabilityResult |
Resultado de la operación CheckNameAvailability |
| Cluster |
Recurso de clúster de Event Hubs único en operaciones De lista o obtención. |
| ClusterProperties |
Propiedades del clúster de Event Hubs proporcionadas en las respuestas de las operaciones List o Get. |
| ClusterQuotaConfigurationProperties |
Contiene toda la configuración del clúster. |
| ClusterSku |
Parámetros de SKU específicos de una instancia de clúster. |
| ClustersCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| ClustersDeleteOptionalParams |
Parámetros opcionales. |
| ClustersGetOptionalParams |
Parámetros opcionales. |
| ClustersListAvailableClusterRegionOptionalParams |
Parámetros opcionales. |
| ClustersListByResourceGroupOptionalParams |
Parámetros opcionales. |
| ClustersListBySubscriptionOptionalParams |
Parámetros opcionales. |
| ClustersListNamespacesOptionalParams |
Parámetros opcionales. |
| ClustersOperations |
Interfaz que representa las operaciones de Clusters. |
| ClustersUpdateOptionalParams |
Parámetros opcionales. |
| ConfidentialCompute |
interfaz de modelo ConfidentialCompute |
| ConfigurationGetOptionalParams |
Parámetros opcionales. |
| ConfigurationOperations |
Interfaz que representa una operación de configuración. |
| ConfigurationPatchOptionalParams |
Parámetros opcionales. |
| ConnectionState |
Información de ConnectionState. |
| ConsumerGroup |
Elemento único en la operación Lista o Obtención de grupos de consumidores |
| ConsumerGroupProperties |
Elemento único en la operación Lista o Obtención de grupos de consumidores |
| ConsumerGroupsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| ConsumerGroupsDeleteOptionalParams |
Parámetros opcionales. |
| ConsumerGroupsGetOptionalParams |
Parámetros opcionales. |
| ConsumerGroupsListByEventHubOptionalParams |
Parámetros opcionales. |
| ConsumerGroupsOperations |
Interfaz que representa una operación de ConsumerGroups. |
| Destination |
Detalles de almacenamiento de captura para la descripción de captura |
| DestinationProperties |
Propiedades que describen la cuenta de almacenamiento, el contenedor de blobs y el formato de nombre de archivo para el destino de captura |
| DisasterRecoveryConfigsBreakPairingOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsDeleteOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsFailOverOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsGetOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsListAuthorizationRulesOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsListKeysOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsListOptionalParams |
Parámetros opcionales. |
| DisasterRecoveryConfigsOperations |
Interfaz que representa una operación de DisasterRecoveryConfigs. |
| EHNamespace |
Elemento de espacio de nombres único en la operación List or Get |
| EHNamespaceIdContainer |
El identificador de ARM completo de un espacio de nombres de Event Hubs |
| EHNamespaceIdListResult |
La respuesta de la operación List Namespace IDs (Identificadores de espacio de nombres de lista) |
| EHNamespaceProperties |
Propiedades de espacio de nombres proporcionadas para la operación de creación del espacio de nombres. |
| Encryption |
Propiedades para configurar el cifrado |
| ErrorAdditionalInfo |
Información adicional sobre el error de administración de recursos. |
| ErrorDetail |
Detalle del error. |
| ErrorResponse |
La respuesta de error indica que el servicio Event Hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. |
| EventHubManagementClientOptionalParams |
Parámetros opcionales para el cliente. |
| EventHubsCreateOrUpdateAuthorizationRuleOptionalParams |
Parámetros opcionales. |
| EventHubsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| EventHubsDeleteAuthorizationRuleOptionalParams |
Parámetros opcionales. |
| EventHubsDeleteOptionalParams |
Parámetros opcionales. |
| EventHubsGetAuthorizationRuleOptionalParams |
Parámetros opcionales. |
| EventHubsGetOptionalParams |
Parámetros opcionales. |
| EventHubsListAuthorizationRulesOptionalParams |
Parámetros opcionales. |
| EventHubsListByNamespaceOptionalParams |
Parámetros opcionales. |
| EventHubsListKeysOptionalParams |
Parámetros opcionales. |
| EventHubsOperations |
Interfaz que representa una operación de EventHubs. |
| EventHubsRegenerateKeysOptionalParams |
Parámetros opcionales. |
| Eventhub |
Elemento único en la operación List or Get Event Hubs |
| EventhubProperties |
Propiedades proporcionadas a la operación Crear o actualizar centro de eventos. |
| FailOver |
FailOver de interfaz de modelo |
| FailOverProperties |
Interfaz de modelo FailOverProperties |
| GeoDataReplicationProperties |
Propiedades de replicación de GeoDR |
| Identity |
Propiedades para configurar identity for Bring Your Own Keys |
| KeyVaultProperties |
Propiedades para configurar las propiedades de keyVault |
| MessageTimestampDescription |
Propiedades de la descripción de MessageTimestamp |
| NWRuleSetIpRules |
Respuesta de la operación Enumerar espacio de nombres. |
| NWRuleSetVirtualNetworkRules |
Respuesta de la operación Enumerar espacio de nombres. |
| NamespaceReplicaLocation |
Propiedades de replicación del espacio de nombres |
| NamespacesCheckNameAvailabilityOptionalParams |
Parámetros opcionales. |
| NamespacesCreateOrUpdateAuthorizationRuleOptionalParams |
Parámetros opcionales. |
| NamespacesCreateOrUpdateNetworkRuleSetOptionalParams |
Parámetros opcionales. |
| NamespacesCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| NamespacesDeleteAuthorizationRuleOptionalParams |
Parámetros opcionales. |
| NamespacesDeleteOptionalParams |
Parámetros opcionales. |
| NamespacesFailoverOptionalParams |
Parámetros opcionales. |
| NamespacesGetAuthorizationRuleOptionalParams |
Parámetros opcionales. |
| NamespacesGetNetworkRuleSetOptionalParams |
Parámetros opcionales. |
| NamespacesGetOptionalParams |
Parámetros opcionales. |
| NamespacesListAuthorizationRulesOptionalParams |
Parámetros opcionales. |
| NamespacesListByResourceGroupOptionalParams |
Parámetros opcionales. |
| NamespacesListKeysOptionalParams |
Parámetros opcionales. |
| NamespacesListNetworkRuleSetOptionalParams |
Parámetros opcionales. |
| NamespacesListOptionalParams |
Parámetros opcionales. |
| NamespacesOperations |
Interfaz que representa una operación de espacios de nombres. |
| NamespacesRegenerateKeysOptionalParams |
Parámetros opcionales. |
| NamespacesUpdateOptionalParams |
Parámetros opcionales. |
| NetworkRuleSet |
Descripción del recurso de tema. |
| NetworkRuleSetListResult |
Colección paginada de elementos NetworkRuleSet |
| NetworkRuleSetProperties |
Propiedades networkRuleSet |
| NetworkSecurityPerimeter |
Información relacionada con NetworkSecurityPerimeter |
| NetworkSecurityPerimeterConfiguration |
Configuraciones relacionadas con el perímetro de seguridad de red de un espacio de nombres determinado |
| NetworkSecurityPerimeterConfigurationList |
Resultado de la operación List NetworkSecurityPerimeterConfiguration. |
| NetworkSecurityPerimeterConfigurationOperationsListOptionalParams |
Parámetros opcionales. |
| NetworkSecurityPerimeterConfigurationOperationsOperations |
Interfaz que representa una operación de NetworkSecurityPerimeterConfigurationOperations. |
| NetworkSecurityPerimeterConfigurationProperties |
Propiedades de NetworkSecurityPerimeterConfiguration |
| NetworkSecurityPerimeterConfigurationPropertiesProfile |
Información sobre el perfil de red actual |
| NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation |
Información sobre la asociación de recursos |
| NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams |
Parámetros opcionales. |
| NetworkSecurityPerimeterConfigurationsOperations |
Interfaz que representa una operación de NetworkSecurityPerimeterConfigurations. |
| NspAccessRule |
Información de la regla de acceso en el perfil de red |
| NspAccessRuleProperties |
Propiedades de la regla de acceso |
| NspAccessRulePropertiesSubscriptionsItem |
Suscripción para la regla de entrada |
| Operation |
Una operación de API REST del centro de eventos |
| OperationDisplay |
Carga de visualización de la operación |
| OperationsListOptionalParams |
Parámetros opcionales. |
| OperationsOperations |
Interfaz que representa una operación de operaciones. |
| PageSettings |
Opciones para el método byPage |
| PagedAsyncIterableIterator |
Interfaz que permite la iteración asincrónica tanto a la finalización como a la página. |
| PlatformCapabilities |
interfaz de modelo Capacidades de la plataforma |
| PrivateEndpoint |
Información de PrivateEndpoint. |
| PrivateEndpointConnection |
Propiedades de PrivateEndpointConnection. |
| PrivateEndpointConnectionProperties |
Propiedades del recurso de conexión de punto final privado. |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsGetOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsListOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsOperations |
Interfaz que representa una operación PrivateEndpointConnections. |
| PrivateLinkResource |
Información del recurso private link. |
| PrivateLinkResourceProperties |
Propiedades de PrivateLinkResource |
| PrivateLinkResourcesGetOptionalParams |
Parámetros opcionales. |
| PrivateLinkResourcesListResult |
Colección paginada de elementos PrivateLinkResource |
| PrivateLinkResourcesOperations |
Interfaz que representa una operación PrivateLinkResources. |
| ProvisioningIssue |
Describe el problema de aprovisionamiento para networkSecurityPerimeterConfiguration determinado. |
| ProvisioningIssueProperties |
Propiedades del problema de aprovisionamiento |
| ProxyResource |
Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación |
| RegenerateAccessKeyParameters |
Los parámetros proporcionados a la operación Regenerar regla de autorización especifican qué clave debe restablecerse. |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| RestorePollerOptions | |
| RetentionDescription |
Propiedades para configurar las opciones de retención para el centro de eventos |
| SchemaGroup |
Elemento único en la operación Lista o Obtener grupo de esquemas |
| SchemaGroupProperties |
interfaz de modelo Propiedades del Grupo de Esquema |
| SchemaRegistryCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| SchemaRegistryDeleteOptionalParams |
Parámetros opcionales. |
| SchemaRegistryGetOptionalParams |
Parámetros opcionales. |
| SchemaRegistryListByNamespaceOptionalParams |
Parámetros opcionales. |
| SchemaRegistryOperations |
Interfaz que representa operaciones de un SchemaRegistro. |
| SimplePollerLike |
Un sondeo sencillo que se puede usar para sondear una operación de larga duración. |
| Sku |
Parámetros de SKU proporcionados a la operación de creación del espacio de nombres |
| Subnet |
Propiedades proporcionadas para subred |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| ThrottlingPolicy |
Propiedades de la directiva de limitación |
| UserAssignedIdentity |
Valor de diccionario reconocido. |
| UserAssignedIdentityProperties |
interfaz de modelo UsuariosAsignadoPropiedadesIdentidad |
Alias de tipos
| AccessRights |
Tipo de derechos de acceso |
| ApplicationGroupPolicyType |
Tipos de Políticas de Grupos de Aplicaciones Valores conocidos admitidos por el servicioThrottlingPolicy |
| ApplicationGroupPolicyUnion |
Alias para ApplicationGroupPolicyUnion |
| AzureSupportedClouds |
Los valores admitidos para la configuración de nube como un tipo literal de cadena |
| CaptureIdentityType |
Tipo de identidad administrada de Azure Active Directory. |
| CleanupPolicyRetentionDescription |
Enumera los posibles valores para la política de limpieza Valores conocidos admitidos por el servicio
Eliminar |
| ClusterSkuName |
Nombre de esta SKU. Valores conocidos admitidos por el serviciodedicado |
| ContinuablePage |
Interfaz que describe una página de resultados. |
| CreatedByType |
Tipo de entidad que creó el recurso. Valores conocidos admitidos por el servicio
Usuario: un usuario creó la entidad. |
| DefaultAction |
Acción predeterminada para el conjunto de reglas de red Valores conocidos admitidos por el servicio
Permitir |
| EncodingCaptureDescription |
Enumera los valores posibles para el formato de codificación de la descripción de captura. Nota: "AvroDeflate" quedará en desuso en la nueva versión de LA API |
| EndPointProvisioningState |
Estado de aprovisionamiento de la conexión de punto de conexión privado. Valores conocidos admitidos por el servicio
Crear |
| EntityStatus |
Enumera los valores posibles para el estado del centro de eventos. |
| GeoDRRoleType |
Tipos de rol en GeoDR Valores conocidos admitidos por el servicio
Primary |
| KeyType |
Clave de acceso que se va a regenerar. Valores conocidos admitidos por el servicio
PrimaryKey |
| ManagedServiceIdentityType |
Tipo de identidad de servicio administrada. |
| MetricId |
El Metric Id en el que debe establecerse el límite de aceleración, MetricId puede descubrirse pasando el cursor sobre Metric en la sección Métricas del espacio de nombres Event Hub dentro de Azure Portal Valores conocidos admitidos por el servicio
IncomingBytes |
| Mode |
Configuración para habilitar o desactivar el cálculo confidencial Valores conocidos admitidos por el servicio
deshabilitado |
| NetworkRuleIPAction |
La acción del filtro IP Valores conocidos admitidos por el servicioPermitir |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Estado de provisión de la propagación de configuración de NetworkSecurityPerimeter Valores conocidos admitidos por el servicio
desconocido |
| NspAccessRuleDirection |
Regla de Dirección de Acceso Valores conocidos admitidos por el servicio
de entrada |
| PrivateLinkConnectionStatus |
Estado de la conexión. Valores conocidos admitidos por el servicio
pendiente |
| ProvisioningState |
Estado de aprovisionamiento del clúster. Valores conocidos admitidos por el servicio
desconocido |
| ProvisioningStateDR |
Estado de aprovisionamiento del alias (configuración de recuperación ante desastres): valores posibles "Aceptados" o "Correctos" o "Failed" |
| PublicNetworkAccess |
Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Valores conocidos admitidos por el servicio
habilitado para |
| PublicNetworkAccessFlag |
Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Si el valor es SecuredByPerimeter, la comunicación entrante y saliente se controla mediante las reglas de acceso del perímetro de seguridad de red y del perfil. Valores conocidos admitidos por el servicio
habilitado para |
| ResourceAssociationAccessMode |
Modo de acceso de la asociación de recursos Valores conocidos admitidos por el servicio
NoAssociationMode |
| RoleDisasterRecovery |
rol del espacio de nombres en GEO DR: valores posibles "Primary" o "PrimaryNotReplicating" o "Secondary" |
| SchemaCompatibility |
Tipo de Compatibilidad de Esquemas |
| SchemaType |
Tipo de SchemaType |
| SkuName |
Nombre de esta SKU. Valores conocidos admitidos por el servicio
Básico |
| SkuTier |
Nivel de facturación de esta SKU determinada. Valores conocidos admitidos por el servicio
Básico |
| TimestampType |
Indica el tipo de marca de tiempo que contendrá el mensaje. Dos tipos de tipos de marca de tiempo: "AppendTime" y "CreateTime". AppendTime hace referencia a la hora en la que se anexó el mensaje dentro del registro del agente. CreateTime hace referencia a la hora en la que se generó el mensaje en el lado de origen y los productores pueden establecer esta marca de tiempo al enviar el mensaje. El valor predeterminado es AppendTime. Si usa el protocolo AMQP, CreateTime es igual a AppendTime y su comportamiento sigue siendo el mismo. Valores conocidos admitidos por el servicio
LogAppend |
| TlsVersion |
La versión mínima TLS que el clúster debe soportar, por ejemplo, '1.2' Valores conocidos admitidos por el servicio
1.0 |
| UnavailableReason |
Especifica el motivo de la falta de disponibilidad del servicio. |
Enumeraciones
| AzureClouds |
Un enum para describir los entornos de Azure Cloud. |
| KnownAccessRights |
Los valores conocidos de AccessRights que acepta el servicio. |
| KnownApplicationGroupPolicyType |
Tipos de directiva de grupo de aplicaciones |
| KnownCleanupPolicyRetentionDescription |
Enumera los valores posibles para la directiva de limpieza |
| KnownClusterSkuName |
Nombre de esta SKU. |
| KnownCreatedByType |
Tipo de entidad que creó el recurso. |
| KnownDefaultAction |
Acción predeterminada para el conjunto de reglas de red |
| KnownEndPointProvisioningState |
Estado de aprovisionamiento de la conexión de punto de conexión privado. |
| KnownGeoDRRoleType |
Tipos de roles de GeoDR |
| KnownKeyType |
Clave de acceso que se va a regenerar. |
| KnownMetricId |
Identificador de métrica en el que se debe establecer el límite, se puede detectar MetricId al mantener el puntero sobre la métrica en la sección Métricas del espacio de nombres del centro de eventos dentro de Azure Portal |
| KnownMode |
Configuración para habilitar o deshabilitar el proceso confidencial |
| KnownNetworkRuleIPAction |
Acción de filtro IP |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
Estado de aprovisionamiento de la propagación de la configuración NetworkSecurityPerimeter |
| KnownNspAccessRuleDirection |
Dirección de la regla de acceso |
| KnownPrivateLinkConnectionStatus |
Estado de la conexión. |
| KnownProvisioningState |
Estado de aprovisionamiento del clúster. |
| KnownPublicNetworkAccess |
Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. |
| KnownPublicNetworkAccessFlag |
Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Si el valor es SecuredByPerimeter, la comunicación entrante y saliente se controla mediante las reglas de acceso del perímetro de seguridad de red y del perfil. |
| KnownResourceAssociationAccessMode |
Modo de acceso de la asociación de recursos |
| KnownSchemaCompatibility |
Valores conocidos de SchemaCompatibility que acepta el servicio. |
| KnownSchemaType |
Valores conocidos de SchemaType que acepta el servicio. |
| KnownSkuName |
Nombre de esta SKU. |
| KnownSkuTier |
Nivel de facturación de esta SKU determinada. |
| KnownTimestampType |
Indica el tipo de marca de tiempo que contendrá el mensaje. Dos tipos de tipos de marca de tiempo: "AppendTime" y "CreateTime". AppendTime hace referencia a la hora en la que se anexó el mensaje dentro del registro del agente. CreateTime hace referencia a la hora en la que se generó el mensaje en el lado de origen y los productores pueden establecer esta marca de tiempo al enviar el mensaje. El valor predeterminado es AppendTime. Si usa el protocolo AMQP, CreateTime es igual a AppendTime y su comportamiento sigue siendo el mismo. |
| KnownTlsVersion |
Versión mínima de TLS para que el clúster admita, por ejemplo, "1.2". |
| KnownVersions |
Las versiones de API disponibles. |
Funciones
| is |
Typeguard para RestError |
| restore |
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito. |
Variables
| Rest |
Tipo de error personalizado para solicitudes de canalización con error. |
Detalles de la función
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parámetros
- e
-
unknown
Algo capturado por una cláusula catch.
Devoluciones
e
restorePoller<TResponse, TResult>(EventHubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.
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>
Devoluciones
PollerLike<OperationState<TResult>, TResult>
Detalles de variables
RestError
Tipo de error personalizado para solicitudes de canalización con error.
RestError: RestErrorConstructor