@azure/arm-mongocluster package

Klassen

MongoClusterManagementClient

Schnittstellen

CheckNameAvailabilityRequest	Der Anforderungstext der Überprüfung.
CheckNameAvailabilityResponse	Das Verfügbarkeitsergebnis der Überprüfung.
ConnectionString	Verbindungszeichenfolge für den Mongo-Cluster
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
FirewallRule	Stellt eine Mongo-Clusterfirewallregel dar.
FirewallRuleProperties	Die Eigenschaften einer Mongo-Clusterfirewallregel.
FirewallRulesCreateOrUpdateOptionalParams	Optionale Parameter.
FirewallRulesDeleteOptionalParams	Optionale Parameter.
FirewallRulesGetOptionalParams	Optionale Parameter.
FirewallRulesListByMongoClusterOptionalParams	Optionale Parameter.
FirewallRulesOperations	Schnittstelle, die firewallRules-Vorgänge darstellt.
ListConnectionStringsResult	Die Verbindungszeichenfolgen für den angegebenen Mongocluster.
MongoCluster	Stellt eine Mongo-Clusterressource dar.
MongoClusterManagementClientOptionalParams	Optionale Parameter für den Client.
MongoClusterProperties	Die Eigenschaften eines Mongoclusters.
MongoClusterRestoreParameters	Parameter, die für Wiederherstellungsvorgänge verwendet werden
MongoClusterUpdate	Der Typ, der für Aktualisierungsvorgänge des MongoCluster verwendet wird.
MongoClusterUpdateProperties	Die aktualisierbaren Eigenschaften des MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Optionale Parameter.
MongoClustersCreateOrUpdateOptionalParams	Optionale Parameter.
MongoClustersDeleteOptionalParams	Optionale Parameter.
MongoClustersGetOptionalParams	Optionale Parameter.
MongoClustersListByResourceGroupOptionalParams	Optionale Parameter.
MongoClustersListConnectionStringsOptionalParams	Optionale Parameter.
MongoClustersListOptionalParams	Optionale Parameter.
MongoClustersOperations	Schnittstelle, die eine MongoClusters-Vorgänge darstellt.
MongoClustersUpdateOptionalParams	Optionale Parameter.
NodeGroupSpec	Spezifikation für eine Knotengruppe.
Operation	Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird
OperationDisplay	Lokalisierte Anzeigeinformationen für und Den Betrieb.
OperationsListOptionalParams	Optionale Parameter.
OperationsOperations	Schnittstelle, die vorgänge darstellt.
PageSettings	Optionen für die byPage-Methode
PagedAsyncIterableIterator	Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die private Endpunktverbindungsressource
PrivateEndpointConnectionProperties	Eigenschaften der privaten Endpunktverbindung.
PrivateEndpointConnectionResource	Konkrete Proxyressourcentypen können durch Aliasing dieses Typs mithilfe eines bestimmten Eigenschaftstyps erstellt werden.
PrivateEndpointConnectionsCreateOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsDeleteOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsGetOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsOperations	Schnittstelle, die eine PrivateEndpointConnections-Vorgänge darstellt.
PrivateLinkResource	Konkrete Proxyressourcentypen können durch Aliasing dieses Typs mithilfe eines bestimmten Eigenschaftstyps erstellt werden.
PrivateLinkResourceProperties	Eigenschaften einer privaten Verknüpfungsressource.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
PrivateLinksListByMongoClusterOptionalParams	Optionale Parameter.
PrivateLinksOperations	Schnittstelle, die privateLinks-Vorgänge darstellt.
ProxyResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort.
Resource	Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden
RestorePollerOptions
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TrackedResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"

Typaliase

ActionType	Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten. KnownActionType- austauschbar mit ActionType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden internen
CheckNameAvailabilityReason	Mögliche Gründe dafür, dass ein Name nicht verfügbar ist. KnownCheckNameAvailabilityReason austauschbar mit CheckNameAvailabilityReason verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Ungültige Bereits vorhanden
ContinuablePage	Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.
CreateMode	Der Modus, mit dem der Mongo-Cluster erstellt wird. KnownCreateMode austauschbar mit CreateMode verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Standard- PointInTimeRestore-
CreatedByType	Die Art der Entität, die die Ressource erstellt hat. KnownCreatedByType austauschbar mit CreatedByType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Application ManagedIdentity- Key-
MongoClusterStatus	Der Status der Mongo-Clusterressource. KnownMongoClusterStatus- austauschbar mit MongoClusterStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Ready Bereitstellungs- Aktualisieren von Starten von beenden beendet ablegen
NodeKind	Die Art des Knotens auf dem Cluster. KnownNodeKind austauschbar mit NodeKind verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Shard-
Origin	Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System" KnownOrigin austauschbar mit Origin verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden System- Benutzer,System-
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus. KnownPrivateEndpointConnectionProvisioningState- austauschbar mit PrivateEndpointConnectionProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden erfolgreich Erstellen von Löschen von Fehlgeschlagene
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung. KnownPrivateEndpointServiceConnectionStatus austauschbar mit PrivateEndpointServiceConnectionStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden ausstehende genehmigte Abgelehnte
ProvisioningState	Alias für ProvisioningState
PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Mongo-Cluster zulässig ist. Der Wert ist optional, und der Standardwert ist "Aktiviert" KnownPublicNetworkAccess austauschbar mit PublicNetworkAccess verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Aktivierte Deaktiviert
ResourceProvisioningState	Der Bereitstellungsstatus eines Ressourcentyps. KnownResourceProvisioningState austauschbar mit ResourceProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden erfolgreich Fehlgeschlagene Abgebrochene
Versions	Die verfügbaren API-Versionen.

Enumerationen

KnownActionType	Bekannte Werte von ActionType, die der Dienst akzeptiert.
KnownCheckNameAvailabilityReason	Bekannte Werte von CheckNameAvailabilityReason, die der Dienst akzeptiert.
KnownCreateMode	Bekannte Werte von CreateMode, die der Dienst akzeptiert.
KnownCreatedByType	Bekannte Werte von CreatedByType, die der Dienst akzeptiert.
KnownMongoClusterStatus	Bekannte Werte von MongoClusterStatus, die der Dienst akzeptiert.
KnownNodeKind	Bekannte Werte von NodeKind, die der Dienst akzeptiert.
KnownOrigin	Bekannte Werte von Origin, die der Dienst akzeptiert.
KnownPrivateEndpointConnectionProvisioningState	Bekannte Werte von PrivateEndpointConnectionProvisioningState, die der Dienst akzeptiert.
KnownPrivateEndpointServiceConnectionStatus	Bekannte Werte von PrivateEndpointServiceConnectionStatus, die der Dienst akzeptiert.
KnownPublicNetworkAccess	Bekannte Werte von PublicNetworkAccess, die der Dienst akzeptiert.
KnownResourceProvisioningState	Bekannte Werte von ResourceProvisioningState, die der Dienst akzeptiert.

Functions

restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

Details zur Funktion

restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

function restorePoller<TResponse, TResult>(client: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameter

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Gibt zurück

PollerLike<OperationState<TResult>, TResult>