@azure/arm-mongocluster package
Klassen
| MongoClusterManagementClient |
Schnittstellen
| AdministratorProperties |
Die Anmeldeeigenschaften des lokalen Administrators. |
| AuthConfigProperties |
Die Authentifizierungskonfiguration für den Mongo-Cluster. |
| BackupProperties |
Die Sicherungseigenschaften des Clusters. Dazu gehören die frühesten Wiederherstellungszeit- und Aufbewahrungseinstellungen. |
| CheckNameAvailabilityRequest |
Der Anforderungstext der Überprüfung. |
| CheckNameAvailabilityResponse |
Das Verfügbarkeitsergebnis der Überprüfung. |
| ComputeProperties |
Die Computeeigenschaften des Clusters. Dazu gehören die virtual-cores/memory und skalierungsoptionen, die auf Server im Cluster angewendet werden. |
| ConnectionString |
Verbindungszeichenfolge für den Mongo-Cluster |
| CustomerManagedKeyEncryptionProperties |
Verschlüsselungseinstellungen für vom Kunden verwaltete Schlüssel. |
| DataApiProperties |
Daten-API-Eigenschaften. |
| DatabaseRole |
Definition einer Datenbankrolle, die einem Benutzer zugewiesen ist. |
| EncryptionProperties |
Die Verschlüsselungskonfiguration für den Mongo-Cluster. |
| EntraIdentityProvider |
Definiert einen Microsoft Entra ID Mongo-Benutzer. |
| EntraIdentityProviderProperties |
Eigenschaften des Microsoft Entra ID-Anbieters. |
| 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. |
| HighAvailabilityProperties |
Die Eigenschaften der hohen Verfügbarkeit des Clusters. |
| IdentityProvider |
Definiert die Definition des Identitätsanbieters eines Benutzers. |
| KeyEncryptionKeyIdentity |
Die Identität, die für den Schlüsselverschlüsselungsschlüssel verwendet wird. |
| ListConnectionStringsResult |
Die Verbindungszeichenfolgen für den angegebenen Mongocluster. |
| ManagedServiceIdentity |
Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten) |
| MongoCluster |
Stellt eine Mongo-Clusterressource dar. |
| MongoClusterManagementClientOptionalParams |
Optionale Parameter für den Client. |
| MongoClusterProperties |
Die Eigenschaften eines Mongoclusters. |
| MongoClusterReplicaParameters |
Parameter, die für Replikatvorgänge verwendet werden. |
| 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. |
| MongoClustersPromoteOptionalParams |
Optionale Parameter. |
| MongoClustersUpdateOptionalParams |
Optionale Parameter. |
| 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 Endpunktressource. |
| 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. |
| PromoteReplicaRequest |
Heraufstufen von Replikatanforderungseigenschaften. |
| ProxyResource |
Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort. |
| Replica |
Stellt ein Mongo-Clusterreplikat dar. |
| ReplicasListByParentOptionalParams |
Optionale Parameter. |
| ReplicasOperations |
Schnittstelle, die replizierbare Vorgänge darstellt. |
| ReplicationProperties |
Replikateigenschaften des Mongoclusters. |
| Resource |
Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden |
| RestorePollerOptions | |
| ShardingProperties |
Die sharding-Eigenschaften des Clusters. Dazu gehören die Shardanzahl und Skalierungsoptionen für den Cluster. |
| StorageProperties |
Die Speichereigenschaften des Clusters. Dazu gehören die Größe des Datenspeichers und die Skalierung, die auf Server im Cluster angewendet wird. |
| 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" |
| User |
Stellt einen Mongo-Clusterbenutzer dar. |
| UserAssignedIdentity |
Benutzer zugewiesene Identitätseigenschaften |
| UserProperties |
Definition der Mongo-Benutzerressource in einem Cluster. |
| UsersCreateOrUpdateOptionalParams |
Optionale Parameter. |
| UsersDeleteOptionalParams |
Optionale Parameter. |
| UsersGetOptionalParams |
Optionale Parameter. |
| UsersListByMongoClusterOptionalParams |
Optionale Parameter. |
| UsersOperations |
Schnittstelle, die die Operationen eines Benutzers darstellt. |
Typaliase
| ActionType |
Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten. Bekannte Werte, die vom Dienst unterstützt werdenInterne: Aktionen gelten nur für interne APIs. |
| AuthenticationMode |
Die Authentifizierungsmodi, die auf dem Mongo-Cluster unterstützt werden. Bekannte Werte, die vom Dienst unterstützt werden
NativeAuth: Nativer Mongo-Authentifizierungsmodus unter Verwendung von Benutzername und Kennwort mit dem Authentifizierungsmechanismus "SCRAM-SHA-256". |
| AzureSupportedClouds |
Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp |
| CheckNameAvailabilityReason |
Mögliche Gründe dafür, dass ein Name nicht verfügbar ist. Bekannte Werte, die vom Dienst unterstützt werden
Ungültige: Name ist ungültig. |
| ContinuablePage |
Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt. |
| CreateMode |
Der Modus, mit dem der Mongo-Cluster erstellt wird. Bekannte Werte, die vom Dienst unterstützt werden
Standard: Erstellen Sie einen neuen Mongo-Cluster. |
| CreatedByType |
Die Art der Entität, die die Ressource erstellt hat. Bekannte Werte, die vom Dienst unterstützt werden
Benutzer-: Die Entität wurde von einem Benutzer erstellt. |
| DataApiMode |
Der Modus, der auf die Mongo Data API angewendet werden soll. Bekannte Werte, die vom Dienst unterstützt werden
Aktiviert: Die Mongo-Daten-API ist für den Cluster aktiviert. |
| EntraPrincipalType |
Microsoft Entra ID-Prinzipaltypen, die für einen Mongo-Benutzer verfügbar sind. Bekannte Werte, die vom Dienst unterstützt werden
user: Benutzertyp Entra. |
| HighAvailabilityMode |
Die Modi für hohe Verfügbarkeit für einen Cluster. Bekannte Werte, die vom Dienst unterstützt werden
Deaktiviert: Der Hochverfügbarkeitsmodus ist deaktiviert. Dieser Modus kann sich bei Fehlern oder Wartungsarbeiten auf die Verfügbarkeit auswirken und wird für die Produktion nicht empfohlen. |
| IdentityProviderType |
Identitätsanbietertypen, zu denen eine Benutzeridentität gehören kann. Bekannte Werte, die vom Dienst unterstützt werdenMicrosoftEntraID: Microsoft Entra ID-Anbieter. |
| IdentityProviderUnion |
Alias für IdentityProviderUnion |
| KeyEncryptionKeyIdentityType |
Der Identitätstyp für den Schlüsselverschlüsselungsschlüssel. Bekannte Werte, die vom Dienst unterstützt werdenUserAssignedIdentity: Vom Benutzer zugewiesene Identität. |
| ManagedServiceIdentityType |
Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). Bekannte Werte, die vom Dienst unterstützt werden
Keine: Keine verwaltete Identität. |
| MongoClusterStatus |
Der Status der Mongo-Clusterressource. Bekannte Werte, die vom Dienst unterstützt werden
Bereit: Die mongo-Clusterressource kann verwendet werden. |
| 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" Bekannte Werte, die vom Dienst unterstützt werden
Benutzer-: Gibt an, dass der Vorgang von einem Benutzer initiiert wird. |
| PreviewFeature |
Vorschaufeatures, die in einem Mongocluster aktiviert werden können. Bekannte Werte, die vom Dienst unterstützt werdenGeoReplicas: Aktiviert die Vorschaufunktion für Geo-Replikate. Die Funktion muss zur Erstellungszeit auf einem neuen Cluster festgelegt werden, um das Verknüpfen eines Georeplikatclusters mit dem Cluster zu ermöglichen. |
| PrivateEndpointConnectionProvisioningState |
Der aktuelle Bereitstellungsstatus. Bekannte Werte, die vom Dienst unterstützt werden
Erfolgreich: Die Verbindung wurde bereitgestellt. |
| PrivateEndpointServiceConnectionStatus |
Der Status der privaten Endpunktverbindung. Bekannte Werte, die vom Dienst unterstützt werden
Ausstehend: Verbindung wartet auf Genehmigung oder Ablehnung |
| PromoteMode |
Der Modus, der auf einen Höherstufenvorgang angewendet werden soll. Bekannte Werte, die vom Dienst unterstützt werdenSwitchover: Durch die Heraufstufung wird der aktuelle Replikatcluster auf die primäre Rolle umgestellt, und der ursprüngliche primäre Cluster wird auf eine Replikatrolle umgestellt, wobei die Replikationsverbindung beibehalten wird. |
| PromoteOption |
Die Option, die auf einen Heraufstufenvorgang angewendet werden soll. Bekannte Werte, die vom Dienst unterstützt werdenErzwungen: Die Option "Heraufstufen" erzwingt die Heraufstufung, ohne darauf zu warten, dass das Replikat mit dem primären Replikat verbunden ist. Dies kann zu Datenverlust führen und sollte daher nur in Notfallwiederherstellungsszenarien verwendet werden. |
| ProvisioningState |
Der Bereitstellungsstatus des letzten akzeptierten Vorgangs. Bekannte Werte, die vom Dienst unterstützt werden
Erfolgreich: Ressource wurde erstellt. |
| 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" Bekannte Werte, die vom Dienst unterstützt werden
Aktiviert: Wenn diese Option festgelegt ist, kann über private und öffentliche Methoden auf den Mongo-Cluster zugegriffen werden. |
| ReplicationRole |
Replikationsrolle des Mongoclusters. Bekannte Werte, die vom Dienst unterstützt werden
Primär: Bei dem Cluster handelt es sich um ein primäres Replikat. |
| ReplicationState |
Der Status der Replikationsverbindung zwischen dem Replikat und dem Quellcluster. Bekannte Werte, die vom Dienst unterstützt werden
Aktiv: Der Replikationslink ist aktiv. |
| StorageType |
Der Speichertyp, mit dem ein Mongo-Cluster bereitgestellt werden kann. Bekannte Werte, die vom Dienst unterstützt werden
PremiumSSD: SSD Premium für Hochleistungsworkloads. |
| UserRole |
Integrierte Datenbankrolle, die einem Benutzer zugewiesen werden kann. Bekannte Werte, die vom Dienst unterstützt werdenroot: Berechtigungen der Stammrolle für den Zielbereich. |
Enumerationen
| AzureClouds |
Eine Enumeration zur Beschreibung von Azure Cloud-Umgebungen. |
| KnownActionType |
Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten. |
| KnownAuthenticationMode |
Die Authentifizierungsmodi, die auf dem Mongo-Cluster unterstützt werden. |
| KnownCheckNameAvailabilityReason |
Mögliche Gründe dafür, dass ein Name nicht verfügbar ist. |
| KnownCreateMode |
Der Modus, mit dem der Mongo-Cluster erstellt wird. |
| KnownCreatedByType |
Die Art der Entität, die die Ressource erstellt hat. |
| KnownDataApiMode |
Der Modus, der auf die Mongo Data API angewendet werden soll. |
| KnownEntraPrincipalType |
Microsoft Entra ID-Prinzipaltypen, die für einen Mongo-Benutzer verfügbar sind. |
| KnownHighAvailabilityMode |
Die Modi für hohe Verfügbarkeit für einen Cluster. |
| KnownIdentityProviderType |
Identitätsanbietertypen, zu denen eine Benutzeridentität gehören kann. |
| KnownKeyEncryptionKeyIdentityType |
Der Identitätstyp für den Schlüsselverschlüsselungsschlüssel. |
| KnownManagedServiceIdentityType |
Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). |
| KnownMongoClusterStatus |
Der Status der Mongo-Clusterressource. |
| KnownOrigin |
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" |
| KnownPreviewFeature |
Vorschaufeatures, die in einem Mongocluster aktiviert werden können. |
| KnownPrivateEndpointConnectionProvisioningState |
Der aktuelle Bereitstellungsstatus. |
| KnownPrivateEndpointServiceConnectionStatus |
Der Status der privaten Endpunktverbindung. |
| KnownPromoteMode |
Der Modus, der auf einen Höherstufenvorgang angewendet werden soll. |
| KnownPromoteOption |
Die Option, die auf einen Heraufstufenvorgang angewendet werden soll. |
| KnownProvisioningState |
Der Bereitstellungsstatus des letzten akzeptierten Vorgangs. |
| KnownPublicNetworkAccess |
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". |
| KnownReplicationRole |
Replikationsrolle des Mongoclusters. |
| KnownReplicationState |
Der Status der Replikationsverbindung zwischen dem Replikat und dem Quellcluster. |
| KnownStorageType |
Der Speichertyp, mit dem ein Mongo-Cluster bereitgestellt werden kann. |
| KnownUserRole |
Integrierte Datenbankrolle, die einem Benutzer zugewiesen werden kann. |
| KnownVersions |
Die verfügbaren API-Versionen. |
Functions
| restore |
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>