@azure/arm-eventhub package
Classes
| EventHubManagementClient |
Interfaces
| AccessKeys |
Chaîne de connexion d’espace de noms/EventHub |
| ApplicationGroup |
Objet Application Group |
| ApplicationGroupOperationsCreateOrUpdateApplicationGroupOptionalParams |
Paramètres facultatifs. |
| ApplicationGroupOperationsDeleteOptionalParams |
Paramètres facultatifs. |
| ApplicationGroupOperationsGetOptionalParams |
Paramètres facultatifs. |
| ApplicationGroupOperationsListByNamespaceOptionalParams |
Paramètres facultatifs. |
| ApplicationGroupOperationsOperations |
Interface représentant une opération ApplicationGroupOperations. |
| ApplicationGroupPolicy |
Propriétés de la stratégie de groupe d’applications |
| ApplicationGroupProperties |
interface de modèle ApplicationsGroupProperties |
| ArmDisasterRecovery |
Élément unique dans l’opération Liste ou Obtenir un alias (configuration de récupération d’urgence) |
| ArmDisasterRecoveryProperties |
Propriétés requises pour créer ou mettre à jour un alias (configurations de récupération d’urgence) |
| AuthorizationRule |
Élément unique dans une opération List ou Get AuthorizationRule |
| AuthorizationRuleProperties |
Propriétés fournies pour créer ou mettre à jour AuthorizationRule |
| AvailableCluster |
Nombre de clusters Event Hubs préprovisionnés et facilement disponibles par région. |
| AvailableClustersList |
Réponse de l’opération Répertorier les clusters disponibles. |
| CaptureDescription |
Propriétés permettant de configurer la description de capture pour eventhub |
| CaptureIdentity |
Valeur qui indique si la description de capture est activée. |
| CheckNameAvailabilityParameter |
Paramètre fourni pour vérifier l’opération de disponibilité du nom de l’espace de noms |
| CheckNameAvailabilityResult |
Résultat de l’opération CheckNameAvailability |
| Cluster |
Ressource de cluster Event Hubs unique dans les opérations Liste ou Obtenir. |
| ClusterProperties |
Propriétés du cluster Event Hubs fournies dans les réponses dans les opérations Liste ou Obtenir. |
| ClusterQuotaConfigurationProperties |
Contient tous les paramètres du cluster. |
| ClusterSku |
Paramètres de référence SKU particuliers à une instance de cluster. |
| ClustersCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| ClustersDeleteOptionalParams |
Paramètres facultatifs. |
| ClustersGetOptionalParams |
Paramètres facultatifs. |
| ClustersListAvailableClusterRegionOptionalParams |
Paramètres facultatifs. |
| ClustersListByResourceGroupOptionalParams |
Paramètres facultatifs. |
| ClustersListBySubscriptionOptionalParams |
Paramètres facultatifs. |
| ClustersListNamespacesOptionalParams |
Paramètres facultatifs. |
| ClustersOperations |
Interface représentant une opération Clusters. |
| ClustersUpdateOptionalParams |
Paramètres facultatifs. |
| ConfidentialCompute |
interface modèle ConfidentialCompute |
| ConfigurationGetOptionalParams |
Paramètres facultatifs. |
| ConfigurationOperations |
Interface représentant une opération de configuration. |
| ConfigurationPatchOptionalParams |
Paramètres facultatifs. |
| ConnectionState |
Informations ConnectionState. |
| ConsumerGroup |
Élément unique dans l’opération Liste ou Obtenir un groupe consommateur |
| ConsumerGroupProperties |
Élément unique dans l’opération Liste ou Obtenir un groupe consommateur |
| ConsumerGroupsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| ConsumerGroupsDeleteOptionalParams |
Paramètres facultatifs. |
| ConsumerGroupsGetOptionalParams |
Paramètres facultatifs. |
| ConsumerGroupsListByEventHubOptionalParams |
Paramètres facultatifs. |
| ConsumerGroupsOperations |
Interface représentant une opération ConsumerGroups. |
| Destination |
Détails du stockage de capture pour la description de la capture |
| DestinationProperties |
Propriétés décrivant le compte de stockage, le conteneur d’objets blob et le format de nom d’archive pour la destination de capture |
| DisasterRecoveryConfigsBreakPairingOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsDeleteOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsFailOverOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsGetOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsListAuthorizationRulesOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsListKeysOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsListOptionalParams |
Paramètres facultatifs. |
| DisasterRecoveryConfigsOperations |
Interface représentant une opération DisasterRecoveryConfigs. |
| EHNamespace |
Élément d’espace de noms unique dans l’opération Liste ou Obtenir |
| EHNamespaceIdContainer |
ID ARM complet d’un espace de noms Event Hubs |
| EHNamespaceIdListResult |
Réponse de l’opération ID d’espace de noms de liste |
| EHNamespaceProperties |
Propriétés d’espace de noms fournies pour l’opération de création d’espace de noms. |
| Encryption |
Propriétés pour configurer le chiffrement |
| ErrorAdditionalInfo |
Informations supplémentaires sur l’erreur de gestion des ressources. |
| ErrorDetail |
Détail de l’erreur. |
| ErrorResponse |
La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur. |
| EventHubManagementClientOptionalParams |
Paramètres facultatifs pour le client. |
| EventHubsCreateOrUpdateAuthorizationRuleOptionalParams |
Paramètres facultatifs. |
| EventHubsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| EventHubsDeleteAuthorizationRuleOptionalParams |
Paramètres facultatifs. |
| EventHubsDeleteOptionalParams |
Paramètres facultatifs. |
| EventHubsGetAuthorizationRuleOptionalParams |
Paramètres facultatifs. |
| EventHubsGetOptionalParams |
Paramètres facultatifs. |
| EventHubsListAuthorizationRulesOptionalParams |
Paramètres facultatifs. |
| EventHubsListByNamespaceOptionalParams |
Paramètres facultatifs. |
| EventHubsListKeysOptionalParams |
Paramètres facultatifs. |
| EventHubsOperations |
Interface représentant une opération EventHubs. |
| EventHubsRegenerateKeysOptionalParams |
Paramètres facultatifs. |
| Eventhub |
Élément unique dans l’opération List ou Get Event Hub |
| EventhubProperties |
Propriétés fournies à l’opération Créer ou mettre à jour Event Hub. |
| FailOver |
Basculement d’interface de modèle |
| FailOverProperties |
Propriétés de bascule de l’interface du modèle |
| GeoDataReplicationProperties |
Propriétés de réplication GeoDR |
| Identity |
Propriétés permettant de configurer Identity for Bring your Own Keys |
| KeyVaultProperties |
Propriétés pour configurer les propriétés keyVault |
| MessageTimestampDescription |
Propriétés de La description de MessageTimestamp |
| NWRuleSetIpRules |
Réponse de l’opération d’espace de noms De liste. |
| NWRuleSetVirtualNetworkRules |
Réponse de l’opération d’espace de noms De liste. |
| NamespaceReplicaLocation |
Propriétés de réplication d’espace de noms |
| NamespacesCheckNameAvailabilityOptionalParams |
Paramètres facultatifs. |
| NamespacesCreateOrUpdateAuthorizationRuleOptionalParams |
Paramètres facultatifs. |
| NamespacesCreateOrUpdateNetworkRuleSetOptionalParams |
Paramètres facultatifs. |
| NamespacesCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| NamespacesDeleteAuthorizationRuleOptionalParams |
Paramètres facultatifs. |
| NamespacesDeleteOptionalParams |
Paramètres facultatifs. |
| NamespacesFailoverOptionalParams |
Paramètres facultatifs. |
| NamespacesGetAuthorizationRuleOptionalParams |
Paramètres facultatifs. |
| NamespacesGetNetworkRuleSetOptionalParams |
Paramètres facultatifs. |
| NamespacesGetOptionalParams |
Paramètres facultatifs. |
| NamespacesListAuthorizationRulesOptionalParams |
Paramètres facultatifs. |
| NamespacesListByResourceGroupOptionalParams |
Paramètres facultatifs. |
| NamespacesListKeysOptionalParams |
Paramètres facultatifs. |
| NamespacesListNetworkRuleSetOptionalParams |
Paramètres facultatifs. |
| NamespacesListOptionalParams |
Paramètres facultatifs. |
| NamespacesOperations |
Interface représentant une opération d’espaces de noms. |
| NamespacesRegenerateKeysOptionalParams |
Paramètres facultatifs. |
| NamespacesUpdateOptionalParams |
Paramètres facultatifs. |
| NetworkRuleSet |
Description de la ressource de rubrique. |
| NetworkRuleSetListResult |
Collection paginée d’éléments NetworkRuleSet |
| NetworkRuleSetProperties |
Propriétés NetworkRuleSet |
| NetworkSecurityPerimeter |
Informations associées à NetworkSecurityPerimeter |
| NetworkSecurityPerimeterConfiguration |
Configurations liées au périmètre de sécurité réseau d’un espace de noms donné |
| NetworkSecurityPerimeterConfigurationList |
Résultat de l’opération List NetworkSecurityPerimeterConfiguration. |
| NetworkSecurityPerimeterConfigurationOperationsListOptionalParams |
Paramètres facultatifs. |
| NetworkSecurityPerimeterConfigurationOperationsOperations |
Interface représentant une opération RéseauSécuritéPérimètreConfigurationOpérations. |
| NetworkSecurityPerimeterConfigurationProperties |
Propriétés de NetworkSecurityPerimeterConfiguration |
| NetworkSecurityPerimeterConfigurationPropertiesProfile |
Informations sur le profil réseau actuel |
| NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation |
Informations sur l’association de ressources |
| NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams |
Paramètres facultatifs. |
| NetworkSecurityPerimeterConfigurationsOperations |
Interface représentant une opération NetworkSecurityPerimeterConfigurations. |
| NspAccessRule |
Informations sur la règle d’accès dans le profil réseau |
| NspAccessRuleProperties |
Propriétés de la règle d’accès |
| NspAccessRulePropertiesSubscriptionsItem |
Abonnement pour la règle de trafic entrant |
| Operation |
Une opération d’API REST Event Hub |
| OperationDisplay |
Charge utile d’affichage de l’opération |
| OperationsListOptionalParams |
Paramètres facultatifs. |
| OperationsOperations |
Interface représentant des opérations. |
| PageSettings |
Options de la méthode byPage |
| PagedAsyncIterableIterator |
Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page. |
| PlatformCapabilities |
interface de modèle PlateformesCapacités |
| PrivateEndpoint |
Informations PrivateEndpoint. |
| PrivateEndpointConnection |
Propriétés de PrivateEndpointConnection. |
| PrivateEndpointConnectionProperties |
Propriétés de la ressource de connexion du point de terminaison privé. |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Paramètres facultatifs. |
| PrivateEndpointConnectionsGetOptionalParams |
Paramètres facultatifs. |
| PrivateEndpointConnectionsListOptionalParams |
Paramètres facultatifs. |
| PrivateEndpointConnectionsOperations |
Interface représentant des opérations PrivateEndpointConnections. |
| PrivateLinkResource |
Informations sur la ressource de liaison privée. |
| PrivateLinkResourceProperties |
Propriétés de PrivateLinkResource |
| PrivateLinkResourcesGetOptionalParams |
Paramètres facultatifs. |
| PrivateLinkResourcesListResult |
Collection paginée d’éléments PrivateLinkResource |
| PrivateLinkResourcesOperations |
Interface représentant une opération PrivateLinkResources. |
| ProvisioningIssue |
Décrit le problème d’approvisionnement pour networkSecurityPerimeterConfiguration donné |
| ProvisioningIssueProperties |
Propriétés du problème d’approvisionnement |
| ProxyResource |
Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement |
| RegenerateAccessKeyParameters |
Les paramètres fournis à l’opération Régénérer la règle d’autorisation spécifient la clé à réinitialiser. |
| Resource |
Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager |
| RestorePollerOptions | |
| RetentionDescription |
Propriétés permettant de configurer les paramètres de rétention pour eventhub |
| SchemaGroup |
Élément unique dans l’opération Liste ou Obtenir le groupe de schémas |
| SchemaGroupProperties |
interface du modèle Propriétés du groupe du schéma |
| SchemaRegistryCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| SchemaRegistryDeleteOptionalParams |
Paramètres facultatifs. |
| SchemaRegistryGetOptionalParams |
Paramètres facultatifs. |
| SchemaRegistryListByNamespaceOptionalParams |
Paramètres facultatifs. |
| SchemaRegistryOperations |
Interface représentant une opération de SchemaRegistre. |
| SimplePollerLike |
Un polleur simple qui peut être utilisé pour interroger une opération de longue durée. |
| Sku |
Paramètres de référence SKU fournis à l’opération de création d’espace de noms |
| Subnet |
Propriétés fournies pour le sous-réseau |
| SystemData |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
| ThrottlingPolicy |
Propriétés de la stratégie de limitation |
| UserAssignedIdentity |
Valeur de dictionnaire reconnue. |
| UserAssignedIdentityProperties |
Interface de modèle PropriétairesIdentitatAssignéesUtilisateur |
Alias de type
| AccessRights |
Type de droits d’accès |
| ApplicationGroupPolicyType |
Types de Politiques de Groupe d’Applications Valeurs connues prises en charge par le servicethrottlingPolicy |
| ApplicationGroupPolicyUnion |
Alias pour ApplicationGroupPolicyUnion |
| AzureSupportedClouds |
Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne |
| CaptureIdentityType |
Type d’identité managée Azure Active Directory. |
| CleanupPolicyRetentionDescription |
Énumère les valeurs possibles pour la politique de nettoyage Valeurs connues prises en charge par le service
Supprimer |
| ClusterSkuName |
Nom de cette référence SKU. Valeurs connues prises en charge par le servicedédié |
| ContinuablePage |
Interface qui décrit une page de résultats. |
| CreatedByType |
Type d’entité qui a créé la ressource. Valeurs connues prises en charge par le service
'utilisateur: l’entité a été créée par un utilisateur. |
| DefaultAction |
Action par défaut pour l’ensemble de règles réseau Valeurs connues prises en charge par le service
Autoriser |
| EncodingCaptureDescription |
Énumère les valeurs possibles pour le format d’encodage de la description de capture. Remarque : « AvroDeflate » sera déconseillé dans la nouvelle version de l’API |
| EndPointProvisioningState |
État d’approvisionnement de la connexion de point de terminaison privé. Valeurs connues prises en charge par le service
création d' |
| EntityStatus |
Énumère les valeurs possibles pour l’état du hub d’événements. |
| GeoDRRoleType |
Types de rôles GeoDR Valeurs connues prises en charge par le service
Primary |
| KeyType |
Clé d’accès à régénérer. Valeurs connues prises en charge par le service
PrimaryKey |
| ManagedServiceIdentityType |
Type d’identité de service managé. |
| MetricId |
Metric Id sur lequel la limite d’accélération doit être fixée, MetricId peut être découvert en survolant Metric dans la section Métriques de l’espace de noms Event Hub à l’intérieur d’Portail Azure Valeurs connues prises en charge par le service
d’octets entrants |
| Mode |
Paramètres pour activer ou désactiver le calcul confidentiel Valeurs connues prises en charge par le service
désactivé |
| NetworkRuleIPAction |
L’action du filtre IP Valeurs connues prises en charge par le serviceAutoriser |
| NetworkSecurityPerimeterConfigurationProvisioningState |
État de provisionnement de la propagation de la configuration de NetworkSecurityPerimeter Valeurs connues prises en charge par le service
inconnu |
| NspAccessRuleDirection |
Règle de direction d’accès Valeurs connues prises en charge par le service
entrant |
| PrivateLinkConnectionStatus |
État de la connexion. Valeurs connues prises en charge par le service
en attente |
| ProvisioningState |
État d’approvisionnement du cluster. Valeurs connues prises en charge par le service
inconnu |
| ProvisioningStateDR |
État d’approvisionnement de l’alias (configuration de récupération d’urgence) : valeurs possibles « Accepté » ou « Réussi » ou « Échec » |
| PublicNetworkAccess |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. Valeurs connues prises en charge par le service
activé |
| PublicNetworkAccessFlag |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. Si la valeur est SecuredByPerimeter, la communication entrante et sortante est contrôlée par le périmètre de sécurité réseau et les règles d’accès du profil. Valeurs connues prises en charge par le service
activé |
| ResourceAssociationAccessMode |
Mode d’accès de l’association de ressources Valeurs connues prises en charge par le service
NoAssociationMode |
| RoleDisasterRecovery |
rôle d’espace de noms dans GEO DR : valeurs possibles « Primary » ou « PrimaryNotReplicating » ou « Secondary » |
| SchemaCompatibility |
Type de schéma Compatibilité |
| SchemaType |
Type de schéma type |
| SkuName |
Nom de cette référence SKU. Valeurs connues prises en charge par le service
de base |
| SkuTier |
Niveau de facturation de cette référence SKU particulière. Valeurs connues prises en charge par le service
de base |
| TimestampType |
Indique le type d’horodatage que le message contiendra. Deux types d’horodatages : « AppendTime » et « CreateTime ». AppendTime fait référence à l’heure dans laquelle le message a été ajouté dans le journal broker. CreateTime fait référence à l’heure dans laquelle le message a été généré côté source et les producteurs peuvent définir cet horodatage lors de l’envoi du message. La valeur par défaut est AppendTime. Si vous utilisez le protocole AMQP, CreateTime est égal à AppendTime et son comportement reste le même. Valeurs connues prises en charge par le service
logAppend |
| TlsVersion |
La version TLS minimale que le cluster doit supporter, par exemple « 1.2 » Valeurs connues prises en charge par le service
1.0 |
| UnavailableReason |
Spécifie la raison de l’indisponibilité du service. |
Énumérations
| AzureClouds |
Un enum pour décrire les environnements Azure Cloud. |
| KnownAccessRights |
Valeurs connues de AccessRights que le service accepte. |
| KnownApplicationGroupPolicyType |
Types de stratégie de groupe d’applications |
| KnownCleanupPolicyRetentionDescription |
Énumère les valeurs possibles pour la stratégie de nettoyage |
| KnownClusterSkuName |
Nom de cette référence SKU. |
| KnownCreatedByType |
Type d’entité qui a créé la ressource. |
| KnownDefaultAction |
Action par défaut pour l’ensemble de règles réseau |
| KnownEndPointProvisioningState |
État d’approvisionnement de la connexion de point de terminaison privé. |
| KnownGeoDRRoleType |
Types de rôles GeoDR |
| KnownKeyType |
Clé d’accès à régénérer. |
| KnownMetricId |
ID de métrique sur lequel la limite de limitation doit être définie, MetricId peut être découvert en pointant sur Métrique dans la section Métriques de l’espace de noms Event Hub dans Portail Azure |
| KnownMode |
Paramètre d’activation ou de désactivation du calcul confidentiel |
| KnownNetworkRuleIPAction |
Action de filtre IP |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
État d’approvisionnement de la propagation de la configuration NetworkSecurityPerimeter |
| KnownNspAccessRuleDirection |
Règle de direction d’accès |
| KnownPrivateLinkConnectionStatus |
État de la connexion. |
| KnownProvisioningState |
État d’approvisionnement du cluster. |
| KnownPublicNetworkAccess |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. |
| KnownPublicNetworkAccessFlag |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. Si la valeur est SecuredByPerimeter, la communication entrante et sortante est contrôlée par le périmètre de sécurité réseau et les règles d’accès du profil. |
| KnownResourceAssociationAccessMode |
Mode d’accès de l’association de ressources |
| KnownSchemaCompatibility |
Valeurs connues de SchemaCompatibility que le service accepte. |
| KnownSchemaType |
Valeurs connues de SchemaType que le service accepte. |
| KnownSkuName |
Nom de cette référence SKU. |
| KnownSkuTier |
Niveau de facturation de cette référence SKU particulière. |
| KnownTimestampType |
Indique le type d’horodatage que le message contiendra. Deux types d’horodatages : « AppendTime » et « CreateTime ». AppendTime fait référence à l’heure dans laquelle le message a été ajouté dans le journal broker. CreateTime fait référence à l’heure dans laquelle le message a été généré côté source et les producteurs peuvent définir cet horodatage lors de l’envoi du message. La valeur par défaut est AppendTime. Si vous utilisez le protocole AMQP, CreateTime est égal à AppendTime et son comportement reste le même. |
| KnownTlsVersion |
Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ». |
| KnownVersions |
Versions d’API disponibles. |
Functions
| is |
Typeguard pour RestError |
| restore |
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue. |
Variables
| Rest |
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué. |
Informations relatives à la fonction
isRestError(unknown)
Typeguard pour RestError
function isRestError(e: unknown): e
Paramètres
- e
-
unknown
Quelque chose d’intercepté par une clause catch.
Retours
e
restorePoller<TResponse, TResult>(EventHubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.
function restorePoller<TResponse, TResult>(client: EventHubManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Paramètres
- client
- EventHubManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retours
PollerLike<OperationState<TResult>, TResult>
Détails de variable
RestError
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
RestError: RestErrorConstructor