Partager via


@azure/arm-mongocluster package

Classes

MongoClusterManagementClient

Interfaces

CheckNameAvailabilityRequest

Corps de la demande de disponibilité de vérification.

CheckNameAvailabilityResponse

Résultat de la vérification de la disponibilité.

ConnectionString

Chaîne de connexion pour le cluster mongo

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué.

FirewallRule

Représente une règle de pare-feu de cluster mongo.

FirewallRuleProperties

Propriétés d’une règle de pare-feu de cluster mongo.

FirewallRulesCreateOrUpdateOptionalParams

Paramètres facultatifs.

FirewallRulesDeleteOptionalParams

Paramètres facultatifs.

FirewallRulesGetOptionalParams

Paramètres facultatifs.

FirewallRulesListByMongoClusterOptionalParams

Paramètres facultatifs.

FirewallRulesOperations

Interface représentant des opérations FirewallRules.

ListConnectionStringsResult

Chaînes de connexion pour le cluster mongo donné.

MongoCluster

Représente une ressource de cluster mongo.

MongoClusterManagementClientOptionalParams

Paramètres facultatifs pour le client.

MongoClusterProperties

Propriétés d’un cluster mongo.

MongoClusterRestoreParameters

Paramètres utilisés pour les opérations de restauration

MongoClusterUpdate

Type utilisé pour les opérations de mise à jour du MongoCluster.

MongoClusterUpdateProperties

Propriétés pouvant être mises à jour du MongoCluster.

MongoClustersCheckNameAvailabilityOptionalParams

Paramètres facultatifs.

MongoClustersCreateOrUpdateOptionalParams

Paramètres facultatifs.

MongoClustersDeleteOptionalParams

Paramètres facultatifs.

MongoClustersGetOptionalParams

Paramètres facultatifs.

MongoClustersListByResourceGroupOptionalParams

Paramètres facultatifs.

MongoClustersListConnectionStringsOptionalParams

Paramètres facultatifs.

MongoClustersListOptionalParams

Paramètres facultatifs.

MongoClustersOperations

Interface représentant des opérations MongoClusters.

MongoClustersUpdateOptionalParams

Paramètres facultatifs.

NodeGroupSpec

Spécification d’un groupe de nœuds.

Operation

Détails d’une opération d’API REST, retournée par l’API d’opérations du fournisseur de ressources

OperationDisplay

Informations d’affichage localisées pour et 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.

PrivateEndpoint

Ressource de point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé

PrivateEndpointConnectionProperties

Propriétés de la connexion de point de terminaison privé.

PrivateEndpointConnectionResource

Les types de ressources proxy concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique.

PrivateEndpointConnectionsCreateOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsDeleteOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsGetOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsListByMongoClusterOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsOperations

Interface représentant des opérations PrivateEndpointConnections.

PrivateLinkResource

Les types de ressources proxy concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique.

PrivateLinkResourceProperties

Propriétés d’une ressource de liaison privée.

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

PrivateLinksListByMongoClusterOptionalParams

Paramètres facultatifs.

PrivateLinksOperations

Interface représentant des opérations PrivateLinks.

ProxyResource

Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement

Resource

Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager

RestorePollerOptions
SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

TrackedResource

Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement »

Alias de type

ActionType

Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement.
KnownActionType peut être utilisé de manière interchangeable avec ActionType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

interne

CheckNameAvailabilityReason

Raisons possibles d’un nom non disponible.
KnownCheckNameAvailabilityReason pouvez être utilisé de manière interchangeable avec CheckNameAvailabilityReason, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

non valide
alreadyExists

ContinuablePage

Interface qui décrit une page de résultats.

CreateMode

Mode avec lequel le cluster Mongo est créé.
KnownCreateMode peut être utilisé de manière interchangeable avec CreateMode, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

par défaut
PointInTimeRestore

CreatedByType

Type d’entité qui a créé la ressource.
KnownCreatedByType peut être utilisé de manière interchangeable avec CreatedByType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

utilisateur
application
managedIdentity
clé

MongoClusterStatus

État de la ressource de cluster Mongo.
KnownMongoClusterStatus peut être utilisé de manière interchangeable avec MongoClusterStatus, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Prêt
provisionnement
mise à jour
démarrage
arrêter
arrêté
suppression de

NodeKind

Type du nœud sur le cluster.
KnownNodeKind peut être utilisé de manière interchangeable avec NodeKind, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

de partition

Origin

Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système »
KnownOrigin peut être utilisé de manière interchangeable avec Origin, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

utilisateur
système
utilisateur,système

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.
KnownPrivateEndpointConnectionProvisioningState peut être utilisé de manière interchangeable avec PrivateEndpointConnectionProvisioningState, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

réussi
création d'
suppression de
échec

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.
KnownPrivateEndpointServiceConnectionStatus peut être utilisé de manière interchangeable avec PrivateEndpointServiceConnectionStatus, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

en attente
approuvé
rejeté

ProvisioningState

Alias pour ProvisioningState

PublicNetworkAccess

Indique si l’accès au point de terminaison public est autorisé pour ce cluster Mongo. La valeur est facultative et la valeur par défaut est « Enabled »
KnownPublicNetworkAccess peuvent être utilisés de manière interchangeable avec PublicNetworkAccess, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

activé
désactivé

ResourceProvisioningState

État d’approvisionnement d’un type de ressource.
KnownResourceProvisioningState peut être utilisé de manière interchangeable avec ResourceProvisioningState, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

réussi
échec
annulé

Versions

Versions d’API disponibles.

Énumérations

KnownActionType

Valeurs connues de ActionType que le service accepte.

KnownCheckNameAvailabilityReason

Valeurs connues de CheckNameAvailabilityReason que le service accepte.

KnownCreateMode

Valeurs connues de CreateMode que le service accepte.

KnownCreatedByType

Valeurs connues de CreatedByType que le service accepte.

KnownMongoClusterStatus

Valeurs connues de MongoClusterStatus que le service accepte.

KnownNodeKind

Valeurs connues de NodeKind que le service accepte.

KnownOrigin

Valeurs connues de Origin que le service accepte.

KnownPrivateEndpointConnectionProvisioningState

Valeurs connues de PrivateEndpointConnectionProvisioningState que le service accepte.

KnownPrivateEndpointServiceConnectionStatus

Valeurs connues de PrivateEndpointServiceConnectionStatus que le service accepte.

KnownPublicNetworkAccess

Valeurs connues de PublicNetworkAccess que le service accepte.

KnownResourceProvisioningState

Valeurs connues de ResourceProvisioningState que le service accepte.

Functions

restorePoller<TResponse, TResult>(MongoClusterManagementClient, 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.

Informations relatives à la fonction

restorePoller<TResponse, TResult>(MongoClusterManagementClient, 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: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Paramètres

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Retours

PollerLike<OperationState<TResult>, TResult>