@azure/arm-mongocluster package

Klassen

MongoClusterManagementClient

Interfaces

AdministratorProperties	De aanmeldingseigenschappen van de lokale beheerder.
AuthConfigProperties	De verificatieconfiguratie voor het Mongo-cluster.
BackupProperties	De back-upeigenschappen van het cluster. Dit omvat de vroegste hersteltijd en bewaarinstellingen.
CheckNameAvailabilityRequest	De hoofdtekst van de beschikbaarheidsaanvraag controleren.
CheckNameAvailabilityResponse	Het resultaat van de beschikbaarheid controleren.
ComputeProperties	De rekeneigenschappen van het cluster. Dit omvat de opties voor virtuele kernen/geheugen en schaalaanpassing die zijn toegepast op servers in het cluster.
ConnectionString	Verbindingsreeks voor het Mongo-cluster
CustomerManagedKeyEncryptionProperties	Door de klant beheerde sleutelversleutelingsinstellingen.
DataApiProperties	Eigenschappen van de gegevens-API.
DatabaseRole	Definitie van databaserol die is toegewezen aan een gebruiker.
EncryptionProperties	De versleutelingsconfiguratie voor het mongo-cluster.
EntraIdentityProvider	Definieert een Microsoft Entra-ID Mongo-gebruiker.
EntraIdentityProviderProperties	Eigenschappen van Microsoft Entra-id-provider.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen.
FirewallRule	Vertegenwoordigt een mongo-clusterfirewallregel.
FirewallRuleProperties	De eigenschappen van een mongo-clusterfirewallregel.
FirewallRulesCreateOrUpdateOptionalParams	Optionele parameters.
FirewallRulesDeleteOptionalParams	Optionele parameters.
FirewallRulesGetOptionalParams	Optionele parameters.
FirewallRulesListByMongoClusterOptionalParams	Optionele parameters.
FirewallRulesOperations	Interface die een FirewallRules-bewerking vertegenwoordigt.
HighAvailabilityProperties	De eigenschappen van hoge beschikbaarheid van het cluster.
IdentityProvider	Definieert de definitie van de identiteitsprovider van een gebruiker.
KeyEncryptionKeyIdentity	De identiteit die wordt gebruikt voor de sleutelcoderingssleutel.
ListConnectionStringsResult	De verbindingsreeksen voor het opgegeven Mongo-cluster.
ManagedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)
MongoCluster	Vertegenwoordigt een Mongo-clusterresource.
MongoClusterManagementClientOptionalParams	Optionele parameters voor de client.
MongoClusterProperties	De eigenschappen van een Mongo-cluster.
MongoClusterReplicaParameters	Parameters die worden gebruikt voor replicabewerkingen.
MongoClusterRestoreParameters	Parameters die worden gebruikt voor herstelbewerkingen
MongoClusterUpdate	Het type dat wordt gebruikt voor updatebewerkingen van het MongoCluster.
MongoClusterUpdateProperties	De updatable eigenschappen van het MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Optionele parameters.
MongoClustersCreateOrUpdateOptionalParams	Optionele parameters.
MongoClustersDeleteOptionalParams	Optionele parameters.
MongoClustersGetOptionalParams	Optionele parameters.
MongoClustersListByResourceGroupOptionalParams	Optionele parameters.
MongoClustersListConnectionStringsOptionalParams	Optionele parameters.
MongoClustersListOptionalParams	Optionele parameters.
MongoClustersOperations	Interface die een MongoClusters-bewerking vertegenwoordigt.
MongoClustersPromoteOptionalParams	Optionele parameters.
MongoClustersUpdateOptionalParams	Optionele parameters.
Operation	Details van een REST API-bewerking, geretourneerd door de Resource Provider Operations-API
OperationDisplay	Gelokaliseerde weergavegegevens voor en bewerkingen.
OperationsListOptionalParams	Optionele parameters.
OperationsOperations	Interface voor bewerkingen.
PageSettings	Opties voor de methode byPage
PagedAsyncIterableIterator	Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.
PrivateEndpoint	De privé-eindpuntresource.
PrivateEndpointConnection	De privé-eindpuntverbindingsresource
PrivateEndpointConnectionProperties	Eigenschappen van de privé-eindpuntverbinding.
PrivateEndpointConnectionResource	Concrete proxyresourcetypen kunnen worden gemaakt door dit type te aliasen met behulp van een specifiek eigenschapstype.
PrivateEndpointConnectionsCreateOptionalParams	Optionele parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optionele parameters.
PrivateEndpointConnectionsGetOptionalParams	Optionele parameters.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Optionele parameters.
PrivateEndpointConnectionsOperations	Interface die een PrivateEndpointConnections-bewerking vertegenwoordigt.
PrivateLinkResource	Concrete proxyresourcetypen kunnen worden gemaakt door dit type te aliasen met behulp van een specifiek eigenschapstype.
PrivateLinkResourceProperties	Eigenschappen van een private link-resource.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
PrivateLinksListByMongoClusterOptionalParams	Optionele parameters.
PrivateLinksOperations	Interface die een PrivateLinks-bewerking vertegenwoordigt.
PromoteReplicaRequest	Eigenschappen van replicaaanvragen promoveren.
ProxyResource	De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie
Replica	Vertegenwoordigt een mongo-clusterreplica.
ReplicasListByParentOptionalParams	Optionele parameters.
ReplicasOperations	Interface voor replicabewerkingen.
ReplicationProperties	Replica-eigenschappen van het Mongo-cluster.
Resource	Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources
RestorePollerOptions
ShardingProperties	De sharding-eigenschappen van het cluster. Dit omvat het aantal shards en schaalopties voor het cluster.
StorageProperties	De opslageigenschappen van het cluster. Dit omvat de grootte van de gegevensopslag en schaalaanpassing die is toegepast op servers in het cluster.
SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TrackedResource	De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie
User	Vertegenwoordigt een Mongo-clustergebruiker.
UserAssignedIdentity	Door de gebruiker toegewezen identiteitseigenschappen
UserProperties	Definitie van Mongo-gebruikersresource op een cluster.
UsersCreateOrUpdateOptionalParams	Optionele parameters.
UsersDeleteOptionalParams	Optionele parameters.
UsersGetOptionalParams	Optionele parameters.
UsersListByMongoClusterOptionalParams	Optionele parameters.
UsersOperations	Interface die de bewerkingen van een gebruiker vertegenwoordigt.

Type-aliassen

ActionType	Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn. KnownActionType kan door elkaar worden gebruikt met ActionType, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Intern: Acties zijn voor interne API's.
AuthenticationMode	De authenticatiemodi die ondersteuning bieden op het Mongo-cluster. KnownAuthenticationMode kan door elkaar worden gebruikt met AuthenticationMode, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund NativeAuth: Native mongo-authenticatiemodus met behulp van gebruikersnaam en wachtwoord met authenticatiemechanisme 'SCRAM-SHA-256'. MicrosoftEntraID: Microsoft Entra ID-verificatiemodus met behulp van Entra-gebruikers die zijn toegewezen aan het cluster- en auth-mechanisme 'MONGODB-OIDC'.
AzureSupportedClouds	De ondersteunde waarden voor cloudinstelling als een letterlijk tekenreekstype
CheckNameAvailabilityReason	Mogelijke redenen waarom een naam niet beschikbaar is. KnownCheckNameAvailabilityReason kan door elkaar worden gebruikt met CheckNameAvailabilityReason, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Ongeldige: de naam is ongeldig. AlreadyExists: Naam bestaat al.
ContinuablePage	Een interface die een pagina met resultaten beschrijft.
CreateMode	De modus waarmee het Mongo-cluster wordt gemaakt. KnownCreateMode kan door elkaar worden gebruikt met CreateMode, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Standaardinstelling: Maak een nieuw mongo-cluster. PointInTimeRestore: Maak een mongo-cluster op basis van een herstelpunt in de tijd. GeoReplica: Maak een replicacluster in een andere geografische regio dan de broncluster. Replica: maak een replicacluster in dezelfde geografische regio als het broncluster.
CreatedByType	Het type entiteit dat de resource heeft gemaakt. KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType, bevat deze enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Gebruiker: De entiteit is gemaakt door een gebruiker. Toepassing: De entiteit is gemaakt door een toepassing. ManagedIdentity: de entiteit is gemaakt door een beheerde identiteit. Sleutel: De entiteit is gemaakt door een sleutel.
DataApiMode	De modus die moet worden toegepast op de Mongo Data API. KnownDataApiMode kan door elkaar worden gebruikt met DataApiMode, deze enum bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Ingeschakeld: Mongo Data API is ingeschakeld voor het cluster. Uitgeschakeld: Mongo Data API is uitgeschakeld voor het cluster.
EntraPrincipalType	Microsoft Entra ID-hoofdtypen beschikbaar voor een Mongo-gebruiker. KnownEntraPrincipalType kan door elkaar worden gebruikt met EntraPrincipalType, deze enum bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund gebruiker: Entra gebruikerstype. servicePrincipal: Type Entra-service-principal.
HighAvailabilityMode	De modi voor hoge beschikbaarheid voor een cluster. KnownHighAvailabilityMode kan door elkaar worden gebruikt met HighAvailabilityMode, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Uitgeschakeld: De modus voor hoge beschikbaarheid is uitgeschakeld. Deze modus kan de impact van de beschikbaarheid zien tijdens storingen of onderhoud en wordt niet aanbevolen voor productie. SameZone: de modus voor hoge beschikbaarheid is ingeschakeld, waarbij elke server in een shard in dezelfde beschikbaarheidszone wordt geplaatst. ZoneRedundantPreferred: de modus voor hoge beschikbaarheid is ingeschakeld en voorkeuren voor ZoneRedundant als de capaciteit van de beschikbaarheidszones beschikbaar is in de regio, anders valt u terug op provisioning met SameZone.
IdentityProviderType	Typen identiteitsproviders waartoe een gebruikersidentiteit kan behoren. KnownIdentityProviderType kan door elkaar worden gebruikt met IdentityProviderType, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund MicrosoftEntraID: Microsoft Entra ID-provider.
IdentityProviderUnion	Alias voor IdentityProviderUnion
KeyEncryptionKeyIdentityType	Het type identiteit voor de sleutelcoderingssleutel. KnownKeyEncryptionKeyIdentityType kan door elkaar worden gebruikt met KeyEncryptionKeyIdentityType, deze enum bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund UserAssignedIdentity: Door de gebruiker toegewezen identiteit.
ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). KnownManagedServiceIdentityType kan door elkaar worden gebruikt met ManagedServiceIdentityType, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Geen: Geen beheerde identiteit. SystemAssigned: Door het systeem toegewezen beheerde identiteit. UserAssigned: door de gebruiker toegewezen beheerde identiteit. SystemAssigned, UserAssigned: Door het systeem toegewezen beheerde identiteit.
MongoClusterStatus	De status van de Mongo-clusterresource. KnownMongoClusterStatus kan door elkaar worden gebruikt met MongoClusterStatus, bevat deze enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Klaar: de mongo-clusterresource is klaar voor gebruik. Inrichting: de mongo-clusterresource wordt ingericht. Bijgewerkt: De bron van het mongocluster wordt bijgewerkt. Starten: De mongo-clusterresource wordt gestart. Stoppen: De mongo-clusterbron wordt gestopt. Gestopt: de mongo-clusterresource is gestopt. Dropping: De mongo-clusterbron wordt gedropt.
Origin	De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem' KnownOrigin- kan door elkaar worden gebruikt met Origin, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund gebruiker: Geeft aan dat de bewerking wordt gestart door een gebruiker. systeem: Geeft aan dat de bewerking wordt gestart door een systeem. gebruiker,systeem: Geeft aan dat de bewerking wordt gestart door een gebruiker of systeem.
PreviewFeature	Preview-functies die kunnen worden ingeschakeld op een Mongo-cluster. KnownPreviewFeature kan door elkaar worden gebruikt met PreviewFeature, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund GeoReplicas: Schakelt de voorbeeldfunctie voor georeplica's in. De functie moet worden ingesteld op het tijdstip van maken op een nieuw cluster om er een georeplica-cluster aan te kunnen koppelen.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus. KnownPrivateEndpointConnectionProvisioningState kan door elkaar worden gebruikt met PrivateEndpointConnectionProvisioningState, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund geslaagde: verbinding is ingericht Maken van: Er wordt een verbinding gemaakt verwijderen: verbinding wordt verwijderd mislukte: het inrichten van verbindingen is mislukt
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt. KnownPrivateEndpointServiceConnectionStatus kan door elkaar worden gebruikt met PrivateEndpointServiceConnectionStatus, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund In behandeling: Verbinding in afwachting van goedkeuring of afwijzing Goedgekeurd: Verbinding goedgekeurd geweigerde: verbinding geweigerd
PromoteMode	De modus die moet worden toegepast op een promotiebewerking. KnownPromoteMode kan door elkaar worden gebruikt met PromoteMode, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Omschakeling: bij promotie wordt het huidige replicacluster overgeschakeld naar de primaire rol en wordt de oorspronkelijke primaire rol overgeschakeld naar een replicarol, waarbij de replicatiekoppeling behouden blijft.
PromoteOption	De optie om toe te passen op een promotiebewerking. KnownPromoteOption kan door elkaar worden gebruikt met PromoteOption, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Geforceerd: de optie Promotie dwingt de promotie af zonder te wachten tot de replica is ingehaald voor de primaire. Dit kan leiden tot gegevensverlies en mag daarom alleen worden gebruikt tijdens scenario's voor noodherstel.
ProvisioningState	De inrichtingsstatus van de laatst geaccepteerde bewerking. KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund geslaagde: resource is gemaakt. mislukt: het maken van resources is mislukt. Geannuleerd: het maken van resources is geannuleerd. InProgress: er wordt een bewerking uitgevoerd voor de resource. Bijwerken: er wordt een updatebewerking uitgevoerd op de bron. Dropping: er wordt een drop-operatie uitgevoerd op de resource.
PublicNetworkAccess	Of openbare eindpunttoegang wel of niet is toegestaan voor dit Mongo-cluster. De waarde is optioneel en de standaardwaarde is ingeschakeld KnownPublicNetworkAccess- kan door elkaar worden gebruikt met PublicNetworkAccess, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Ingeschakeld: indien ingesteld, kan mongo cluster worden geopend via privé- en openbare methoden. Uitgeschakeld: indien ingesteld, zijn de privé-eindpunten de exclusieve toegangsmethode.
ReplicationRole	Replicatierol van het Mongo-cluster. KnownReplicationRole kan door elkaar worden gebruikt met ReplicationRole, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Primair: Het cluster is een primaire replica. AsyncReplica: Het cluster is een lokale asynchrone replica. GeoAsyncReplica: Het cluster is een geo-asynchrone replica.
ReplicationState	De status van de replicatiekoppeling tussen de replica en het broncluster. KnownReplicationState kan door elkaar worden gebruikt met ReplicationState, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Actief: de replicatielink is actief. Inhaalslag: Replica is bezig met een inhaalslag ten opzichte van de primaire. Dit kan gebeuren nadat de replica is gemaakt of nadat een promotie is geactiveerd. Inrichting: er wordt een replica- en replicatiekoppeling naar de primaire gemaakt. Updaten: de replicatielink wordt bijgewerkt vanwege een wijziging in de replica of een upgrade. Verbroken: de replicatielink is verbroken en de replica moet mogelijk opnieuw worden gemaakt. Opnieuw configureren: de replicatielink wordt opnieuw geconfigureerd vanwege een promotie-evenement.
StorageType	Het type opslag waarmee een mongo-cluster kan worden ingericht. KnownStorageType kan door elkaar worden gebruikt met StorageType, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund PremiumSSD: Premium SSD voor workloads met hoge prestaties. PremiumSSDv2: Premium SSD v2 voor zeer IO-intensieve workloads. Dit is een voorbeeldoptie en heeft extra beperkingen.
UserRole	Ingebouwde databaserol die aan een gebruiker kan worden toegewezen. KnownUserRole kan door elkaar worden gebruikt met UserRole, deze enum bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund root: Machtigingen voor de rootrol voor het doelbereik.

Enums

AzureClouds	Een enum om Azure Cloud-omgevingen te beschrijven.
KnownActionType	Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn.
KnownAuthenticationMode	De authenticatiemodi die ondersteuning bieden op het Mongo-cluster.
KnownCheckNameAvailabilityReason	Mogelijke redenen waarom een naam niet beschikbaar is.
KnownCreateMode	De modus waarmee het Mongo-cluster wordt gemaakt.
KnownCreatedByType	Het type entiteit dat de resource heeft gemaakt.
KnownDataApiMode	De modus die moet worden toegepast op de Mongo Data API.
KnownEntraPrincipalType	Microsoft Entra ID-hoofdtypen beschikbaar voor een Mongo-gebruiker.
KnownHighAvailabilityMode	De modi voor hoge beschikbaarheid voor een cluster.
KnownIdentityProviderType	Typen identiteitsproviders waartoe een gebruikersidentiteit kan behoren.
KnownKeyEncryptionKeyIdentityType	Het type identiteit voor de sleutelcoderingssleutel.
KnownManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).
KnownMongoClusterStatus	De status van de Mongo-clusterresource.
KnownOrigin	De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem'
KnownPreviewFeature	Preview-functies die kunnen worden ingeschakeld op een Mongo-cluster.
KnownPrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
KnownPrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
KnownPromoteMode	De modus die moet worden toegepast op een promotiebewerking.
KnownPromoteOption	De optie om toe te passen op een promotiebewerking.
KnownProvisioningState	De inrichtingsstatus van de laatst geaccepteerde bewerking.
KnownPublicNetworkAccess	Of openbare eindpunttoegang wel of niet is toegestaan voor dit Mongo-cluster. Waarde is optioneel en de standaardwaarde is 'Ingeschakeld'
KnownReplicationRole	Replicatierol van het Mongo-cluster.
KnownReplicationState	De status van de replicatiekoppeling tussen de replica en het broncluster.
KnownStorageType	Het type opslag waarmee een mongo-cluster kan worden ingericht.
KnownUserRole	Ingebouwde databaserol die aan een gebruiker kan worden toegewezen.
KnownVersions	De beschikbare API-versies.

Functies

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

Functiedetails

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

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

Parameters

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Retouren

PollerLike<OperationState<TResult>, TResult>