@azure/arm-mongocluster package
Osztályok
| MongoClusterManagementClient |
Interfészek
| AdministratorProperties |
A helyi rendszergazda bejelentkezési tulajdonságai. |
| AuthConfigProperties |
A Mongo-fürt hitelesítési konfigurációja. |
| BackupProperties |
A fürt biztonsági mentési tulajdonságai. Ez magában foglalja a legkorábbi visszaállítási időt és a megőrzési beállításokat. |
| CheckNameAvailabilityRequest |
Az ellenőrzés rendelkezésre állási kérelem törzse. |
| CheckNameAvailabilityResponse |
Az ellenőrzés rendelkezésre állási eredménye. |
| ComputeProperties |
A fürt számítási tulajdonságai. Ez magában foglalja a fürt kiszolgálóira alkalmazott virtuális magokat/memóriát és skálázási beállításokat. |
| ConnectionString |
Kapcsolati sztring a mongo-fürthöz |
| CustomerManagedKeyEncryptionProperties |
Ügyfél által felügyelt kulcstitkosítási beállítások. |
| DataApiProperties |
Data API tulajdonságai. |
| DatabaseRole |
Felhasználóhoz rendelt adatbázis-szerepkör-definíció. |
| EncryptionProperties |
A mongo-fürt titkosítási konfigurációja. |
| EntraIdentityProvider |
Meghatároz egy Microsoft Entra ID Mongo-felhasználót. |
| EntraIdentityProviderProperties |
Microsoft Entra azonosító szolgáltató tulajdonságai. |
| ErrorAdditionalInfo |
Az erőforrás-kezelési hiba további információi. |
| ErrorDetail |
A hiba részletei. |
| ErrorResponse |
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. |
| FirewallRule |
Mongo-fürt tűzfalszabályát jelöli. |
| FirewallRuleProperties |
Mongo-fürt tűzfalszabályának tulajdonságai. |
| FirewallRulesCreateOrUpdateOptionalParams |
Nem kötelező paraméterek. |
| FirewallRulesDeleteOptionalParams |
Nem kötelező paraméterek. |
| FirewallRulesGetOptionalParams |
Nem kötelező paraméterek. |
| FirewallRulesListByMongoClusterOptionalParams |
Nem kötelező paraméterek. |
| FirewallRulesOperations |
FirewallRules-műveleteket képviselő felület. |
| HighAvailabilityProperties |
A fürt magas rendelkezésre állási tulajdonságai. |
| IdentityProvider |
Meghatározza a felhasználó identitásszolgáltatójának definícióját. |
| KeyEncryptionKeyIdentity |
A kulcstitkosítási kulcshoz használt identitás. |
| ListConnectionStringsResult |
Az adott mongo-fürt kapcsolati sztringjei. |
| ManagedServiceIdentity |
Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások) |
| MongoCluster |
Mongo-fürterőforrást jelöl. |
| MongoClusterManagementClientOptionalParams |
Az ügyfél opcionális paraméterei. |
| MongoClusterProperties |
Mongo-fürt tulajdonságai. |
| MongoClusterReplicaParameters |
A replikaműveletekhez használt paraméterek. |
| MongoClusterRestoreParameters |
Visszaállítási műveletekhez használt paraméterek |
| MongoClusterUpdate |
A MongoCluster frissítési műveleteihez használt típus. |
| MongoClusterUpdateProperties |
A MongoCluster frissíthető tulajdonságai. |
| MongoClustersCheckNameAvailabilityOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersCreateOrUpdateOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersDeleteOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersGetOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersListByResourceGroupOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersListConnectionStringsOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersListOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersOperations |
MongoClusters-műveleteket képviselő felület. |
| MongoClustersPromoteOptionalParams |
Nem kötelező paraméterek. |
| MongoClustersUpdateOptionalParams |
Nem kötelező paraméterek. |
| Operation |
Az Erőforrás-szolgáltató műveleti API-jából visszaadott REST API-művelet részletei |
| OperationDisplay |
Honosított megjelenítési információk a művelethez és a művelethez. |
| OperationsListOptionalParams |
Nem kötelező paraméterek. |
| OperationsOperations |
Műveleti műveleteket jelképező felület. |
| PageSettings |
A byPage metódus beállításai |
| PagedAsyncIterableIterator |
Egy felület, amely lehetővé teszi az aszinkron iterálást mind a befejezésig, mind az oldal szerint. |
| PrivateEndpoint |
A privát végpont erőforrása. |
| PrivateEndpointConnection |
A privát végpont kapcsolati erőforrása |
| PrivateEndpointConnectionProperties |
A privát végpontkapcsolat tulajdonságai. |
| PrivateEndpointConnectionResource |
A konkrét proxyerőforrás-típusok úgy hozhatók létre, hogy ezt a típust egy adott tulajdonságtípus használatával aliasként használják. |
| PrivateEndpointConnectionsCreateOptionalParams |
Nem kötelező paraméterek. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Nem kötelező paraméterek. |
| PrivateEndpointConnectionsGetOptionalParams |
Nem kötelező paraméterek. |
| PrivateEndpointConnectionsListByMongoClusterOptionalParams |
Nem kötelező paraméterek. |
| PrivateEndpointConnectionsOperations |
PrivateEndpointConnections-műveleteket képviselő felület. |
| PrivateLinkResource |
A konkrét proxyerőforrás-típusok úgy hozhatók létre, hogy ezt a típust egy adott tulajdonságtípus használatával aliasként használják. |
| PrivateLinkResourceProperties |
Egy privát kapcsolati erőforrás tulajdonságai. |
| PrivateLinkServiceConnectionState |
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye. |
| PrivateLinksListByMongoClusterOptionalParams |
Nem kötelező paraméterek. |
| PrivateLinksOperations |
PrivateLinks-műveleteket képviselő felület. |
| PromoteReplicaRequest |
A replikakérelmek tulajdonságainak előléptetése. |
| ProxyResource |
Az Azure Resource Manager-proxyerőforrás erőforrásmodell-definíciója. Nem lesznek címkék és hely |
| Replica |
Mongo-fürtreplikát jelöl. |
| ReplicasListByParentOptionalParams |
Nem kötelező paraméterek. |
| ReplicasOperations |
Replikaműveleteket képviselő felület. |
| ReplicationProperties |
A mongo-fürt replikatulajdonságai. |
| Resource |
Az Összes Azure Resource Manager-erőforrás válaszában visszaadott gyakori mezők |
| RestorePollerOptions | |
| ShardingProperties |
A fürt horizontális skálázási tulajdonságai. Ez magában foglalja a fürt szegmensszámát és skálázási beállításait. |
| StorageProperties |
A fürt tárolási tulajdonságai. Ez magában foglalja a fürt kiszolgálóira alkalmazott adattárolási méretet és skálázást. |
| SystemData |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
| TrackedResource |
Az Azure Resource Manager erőforrásmodell-definíciója nyomon követett legfelső szintű erőforráshoz, amely "címkéket" és "helyet" is biztosít |
| User |
Mongo-fürt felhasználóját jelöli. |
| UserAssignedIdentity |
Felhasználó által hozzárendelt identitástulajdonságok |
| UserProperties |
Mongo felhasználói erőforrás definíciója fürtön. |
| UsersCreateOrUpdateOptionalParams |
Nem kötelező paraméterek. |
| UsersDeleteOptionalParams |
Nem kötelező paraméterek. |
| UsersGetOptionalParams |
Nem kötelező paraméterek. |
| UsersListByMongoClusterOptionalParams |
Nem kötelező paraméterek. |
| UsersOperations |
A felhasználói műveleteket képviselő felület. |
Típusaliasok
| ActionType |
Bővíthető szám. A művelet típusát jelzi. A "belső" olyan műveletekre vonatkozik, amelyek csak belső API-kra vonatkoznak. A szolgáltatás által támogatott ismert értékekbelső: A műveletek csak belső API-khoz tartoznak. |
| AuthenticationMode |
A Mongo-fürtön támogatott hitelesítési módok. A szolgáltatás által támogatott ismert értékek
NativeAuth: Natív mongo hitelesítési mód felhasználónévvel és jelszóval a "SCRAM-SHA-256" hitelesítési mechanizmussal. |
| AzureSupportedClouds |
A felhőbeállítás támogatott értékei sztringkonstanstípusként |
| CheckNameAvailabilityReason |
A név nem érhető el lehetséges okai. A szolgáltatás által támogatott ismert értékek
Érvénytelen: A név érvénytelen. |
| ContinuablePage |
Egy találatoldalt leíró felület. |
| CreateMode |
A Mongo-fürt által létrehozott mód. A szolgáltatás által támogatott ismert értékek
Alapértelmezett: Hozzon létre egy új mongo-fürtöt. |
| CreatedByType |
Az erőforrást létrehozó entitás típusa. A szolgáltatás által támogatott ismert értékek
Felhasználó: Az entitást egy felhasználó hozta létre. |
| DataApiMode |
A Mongo Data API-ra alkalmazandó mód. A szolgáltatás által támogatott ismert értékek
Engedélyezve: A Mongo Data API engedélyezve van a fürthöz. |
| EntraPrincipalType |
A Mongo-felhasználók számára elérhető Microsoft Entra azonosító típusok. A szolgáltatás által támogatott ismert értékek
user: Entra felhasználói típus. |
| HighAvailabilityMode |
A fürt magas rendelkezésre állási módjai. A szolgáltatás által támogatott ismert értékek
Letiltva: A magas rendelkezésre állási mód le van tiltva. Ez a mód a rendelkezésre állás hatását látja a hibák vagy karbantartás során, és éles környezetben nem ajánlott. |
| IdentityProviderType |
Identitásszolgáltatói típusok, amelyekhez a felhasználói identitás tartozhat. A szolgáltatás által támogatott ismert értékekMicrosoftEntraID: Microsoft Entra azonosító szolgáltatója. |
| IdentityProviderUnion |
Az IdentityProviderUnion alia |
| KeyEncryptionKeyIdentityType |
A kulcstitkosítási kulcs identitásának típusa. A szolgáltatás által támogatott ismert értékekUserAssignedIdentity: Felhasználó által hozzárendelt identitás. |
| ManagedServiceIdentityType |
A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett). A szolgáltatás által támogatott ismert értékek
Nincs: Nincs felügyelt identitás. |
| MongoClusterStatus |
A Mongo-fürterőforrás állapota. A szolgáltatás által támogatott ismert értékek
Kész: A mongo-fürterőforrás használatra kész. |
| Origin |
A művelet tervezett végrehajtója; az erőforrás-alapú hozzáférés-vezérlés (RBAC) és a naplózási naplók UX-jához hasonlóan. Az alapértelmezett érték a "felhasználó,rendszer" A szolgáltatás által támogatott ismert értékek
felhasználó: Azt jelzi, hogy a műveletet egy felhasználó kezdeményezte. |
| PreviewFeature |
Mongo-fürtön engedélyezhető előzetes verziójú funkciók. A szolgáltatás által támogatott ismert értékekGeoReplicas: Engedélyezi a georeplikák előzetes verzióját. A funkciót a létrehozáskor kell beállítani az új fürtön, hogy lehetővé tegye a georeplika-fürt csatolását. |
| PrivateEndpointConnectionProvisioningState |
Az aktuális kiépítési állapot. A szolgáltatás által támogatott ismert értékek
Sikeres: A kapcsolat ki lett építve |
| PrivateEndpointServiceConnectionStatus |
A privát végpont kapcsolatának állapota. A szolgáltatás által támogatott ismert értékek
Függőben: Jóváhagyásra vagy elutasításra váró kapcsolat |
| PromoteMode |
Az előléptetési műveletre alkalmazandó mód. A szolgáltatás által támogatott ismert értékekVáltás: Az előléptetés az aktuális replikafürtöt az elsődleges szerepkörre, az eredeti elsődleges pedig replikaszerepkörre vált, megtartva a replikációs hivatkozást. |
| PromoteOption |
Az előléptetési műveletre való alkalmazás lehetősége. A szolgáltatás által támogatott ismert értékekKényszerített: Az előléptetési lehetőség kikényszeríti az előléptetést anélkül, hogy megvárná, amíg a replika utoléri az elsődlegest. Ez adatvesztést eredményezhet, ezért csak vészhelyreállítási forgatókönyvek során használható. |
| ProvisioningState |
Az utoljára elfogadott művelet kiépítési állapota. A szolgáltatás által támogatott ismert értékek
Sikeres: Az erőforrás létrejött. |
| PublicNetworkAccess |
Azt jelzi, hogy engedélyezett-e nyilvános végpont-hozzáférés ehhez a Mongo-fürthöz. Az érték nem kötelező, az alapértelmezett érték pedig "Engedélyezve" A szolgáltatás által támogatott ismert értékek
Engedélyezve: Ha be van állítva, a mongo-fürt privát és nyilvános módszerekkel érhető el. |
| ReplicationRole |
A mongo-fürt replikációs szerepköre. A szolgáltatás által támogatott ismert értékek
Elsődleges: A fürt egy elsődleges replika. |
| ReplicationState |
A replika és a forrásfürt közötti replikációs kapcsolat állapota. A szolgáltatás által támogatott ismert értékek
Aktív: A replikációs hivatkozás aktív. |
| StorageType |
A mongo-fürt kiépítéséhez szükséges tároló típusa. A szolgáltatás által támogatott ismert értékek
PremiumSSD: Prémium SSD nagy teljesítményű számítási feladatokhoz. |
| UserRole |
Beépített adatbázis-szerepkör, amely hozzárendelhető egy felhasználóhoz. A szolgáltatás által támogatott ismert értékekroot: Gyökérszerepkör-engedélyek a célhatókörön. |
Enumerációk
| AzureClouds |
Az Azure-felhőkörnyezeteket leíró felsorolás. |
| KnownActionType |
Bővíthető szám. A művelet típusát jelzi. A "belső" olyan műveletekre vonatkozik, amelyek csak belső API-kra vonatkoznak. |
| KnownAuthenticationMode |
A Mongo-fürtön támogatott hitelesítési módok. |
| KnownCheckNameAvailabilityReason |
A név nem érhető el lehetséges okai. |
| KnownCreateMode |
A Mongo-fürt által létrehozott mód. |
| KnownCreatedByType |
Az erőforrást létrehozó entitás típusa. |
| KnownDataApiMode |
A Mongo Data API-ra alkalmazandó mód. |
| KnownEntraPrincipalType |
A Mongo-felhasználók számára elérhető Microsoft Entra azonosító típusok. |
| KnownHighAvailabilityMode |
A fürt magas rendelkezésre állási módjai. |
| KnownIdentityProviderType |
Identitásszolgáltatói típusok, amelyekhez a felhasználói identitás tartozhat. |
| KnownKeyEncryptionKeyIdentityType |
A kulcstitkosítási kulcs identitásának típusa. |
| KnownManagedServiceIdentityType |
A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett). |
| KnownMongoClusterStatus |
A Mongo-fürterőforrás állapota. |
| KnownOrigin |
A művelet tervezett végrehajtója; az erőforrás-alapú hozzáférés-vezérlés (RBAC) és a naplózási naplók UX-jához hasonlóan. Az alapértelmezett érték a "felhasználó,rendszer" |
| KnownPreviewFeature |
Mongo-fürtön engedélyezhető előzetes verziójú funkciók. |
| KnownPrivateEndpointConnectionProvisioningState |
Az aktuális kiépítési állapot. |
| KnownPrivateEndpointServiceConnectionStatus |
A privát végpont kapcsolatának állapota. |
| KnownPromoteMode |
Az előléptetési műveletre alkalmazandó mód. |
| KnownPromoteOption |
Az előléptetési műveletre való alkalmazás lehetősége. |
| KnownProvisioningState |
Az utoljára elfogadott művelet kiépítési állapota. |
| KnownPublicNetworkAccess |
Azt jelzi, hogy engedélyezett-e nyilvános végpont-hozzáférés ehhez a Mongo-fürthöz. Az érték nem kötelező, az alapértelmezett érték pedig "Engedélyezve" |
| KnownReplicationRole |
A mongo-fürt replikációs szerepköre. |
| KnownReplicationState |
A replika és a forrásfürt közötti replikációs kapcsolat állapota. |
| KnownStorageType |
A mongo-fürt kiépítéséhez szükséges tároló típusa. |
| KnownUserRole |
Beépített adatbázis-szerepkör, amely hozzárendelhető egy felhasználóhoz. |
| KnownVersions |
Az elérhető API-verziók. |
Függvények
| restore |
Létrehoz egy pollert egy másik lekérdezés szerializált állapotából. Ez akkor lehet hasznos, ha egy másik gazdagépen szeretne lekérdezéseket létrehozni, vagy ha az eredeti nem tartozik a hatókörbe, létre kell hozni egy lekérdezést. |
Függvény adatai
restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Létrehoz egy pollert egy másik lekérdezés szerializált állapotából. Ez akkor lehet hasznos, ha egy másik gazdagépen szeretne lekérdezéseket létrehozni, vagy ha az eredeti nem tartozik a hatókörbe, létre kell hozni egy lekérdezést.
function restorePoller<TResponse, TResult>(client: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Paraméterek
- client
- MongoClusterManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Válaszok
PollerLike<OperationState<TResult>, TResult>