@azure/arm-mongocluster package

Klasser

MongoClusterManagementClient

Gränssnitt

CheckNameAvailabilityRequest	Kontrollera brödtexten för tillgänglighetsbegäran.
CheckNameAvailabilityResponse	Kontrollera tillgänglighetsresultatet.
ConnectionString	Anslutningssträng för mongo-klustret
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder.
FirewallRule	Representerar en brandväggsregel för mongo-kluster.
FirewallRuleProperties	Egenskaperna för en mongo-klusterbrandväggsregel.
FirewallRulesCreateOrUpdateOptionalParams	Valfria parametrar.
FirewallRulesDeleteOptionalParams	Valfria parametrar.
FirewallRulesGetOptionalParams	Valfria parametrar.
FirewallRulesListByMongoClusterOptionalParams	Valfria parametrar.
FirewallRulesOperations	Gränssnitt som representerar en FirewallRules-åtgärder.
ListConnectionStringsResult	Anslutningssträngarna för det angivna mongo-klustret.
MongoCluster	Representerar en mongo-klusterresurs.
MongoClusterManagementClientOptionalParams	Valfria parametrar för klienten.
MongoClusterProperties	Egenskaperna för ett mongo-kluster.
MongoClusterRestoreParameters	Parametrar som används för återställningsåtgärder
MongoClusterUpdate	Den typ som används för uppdateringsåtgärder för MongoCluster.
MongoClusterUpdateProperties	De uppdateringsbara egenskaperna för MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Valfria parametrar.
MongoClustersCreateOrUpdateOptionalParams	Valfria parametrar.
MongoClustersDeleteOptionalParams	Valfria parametrar.
MongoClustersGetOptionalParams	Valfria parametrar.
MongoClustersListByResourceGroupOptionalParams	Valfria parametrar.
MongoClustersListConnectionStringsOptionalParams	Valfria parametrar.
MongoClustersListOptionalParams	Valfria parametrar.
MongoClustersOperations	Gränssnitt som representerar en MongoClusters-åtgärder.
MongoClustersUpdateOptionalParams	Valfria parametrar.
NodeGroupSpec	Specifikation för en nodgrupp.
Operation	Information om en REST API-åtgärd som returneras från API:et för resursprovideråtgärder
OperationDisplay	Lokaliserad visningsinformation för och åtgärd.
OperationsListOptionalParams	Valfria parametrar.
OperationsOperations	Gränssnitt som representerar åtgärder.
PageSettings	Alternativ för byPage-metoden
PagedAsyncIterableIterator	Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.
PrivateEndpoint	Den privata slutpunktsresursen.
PrivateEndpointConnection	Den privata slutpunktsanslutningsresursen
PrivateEndpointConnectionProperties	Egenskaper för den privata slutpunktsanslutningen.
PrivateEndpointConnectionResource	Konkreta proxyresurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.
PrivateEndpointConnectionsCreateOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsDeleteOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsGetOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsOperations	Gränssnitt som representerar en PrivateEndpointConnections-åtgärder.
PrivateLinkResource	Konkreta proxyresurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.
PrivateLinkResourceProperties	Egenskaper för en privat länkresurs.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
PrivateLinksListByMongoClusterOptionalParams	Valfria parametrar.
PrivateLinksOperations	Gränssnitt som representerar en PrivateLinks-verksamhet.
ProxyResource	Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats
Resource	Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser
RestorePollerOptions
SystemData	Metadata som rör skapande och senaste ändring av resursen.
TrackedResource	Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

Typalias

ActionType	Utökningsbar uppräkning. Anger åtgärdstypen. "Intern" avser åtgärder som endast gäller interna API:er. KnownActionType- kan användas utbytbart med ActionType innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Intern
CheckNameAvailabilityReason	Möjliga orsaker till att ett namn inte är tillgängligt. KnownCheckNameAvailabilityReason kan användas omväxlande med CheckNameAvailabilityReason innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Ogiltig AlreadyExists
ContinuablePage	Ett gränssnitt som beskriver en resultatsida.
CreateMode	Läget som Mongo-klustret skapas med. KnownCreateMode kan användas utbytbart med CreateMode innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten standard PointInTimeRestore
CreatedByType	Den typ av entitet som skapade resursen. KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten användare Program ManagedIdentity nyckel
MongoClusterStatus	Status för Mongo-klusterresursen. KnownMongoClusterStatus kan användas utbytbart med MongoClusterStatus innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten redo Etablering uppdaterar startar stoppa har stoppats släpper
NodeKind	Typen av nod i klustret. KnownNodeKind- kan användas utbytbart med NodeKind innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Shard
Origin	Den avsedda utföraren av åtgärden; som i Resursbaserad åtkomstkontroll (RBAC) och granskningsloggar UX. Standardvärdet är "user,system" KnownOrigin- kan användas omväxlande med Origin innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten användare system användare, system
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet. KnownPrivateEndpointConnectionProvisioningState kan användas utbytbart med PrivateEndpointConnectionProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten lyckades Skapa ta bort misslyckades
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt. KnownPrivateEndpointServiceConnectionStatus kan användas utbytbart med PrivateEndpointServiceConnectionStatus innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten väntar på Godkänd avvisade
ProvisioningState	Alias för ProvisioningState
PublicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för det här Mongo-klustret eller inte. Värdet är valfritt och standardvärdet är "Aktiverat" KnownPublicNetworkAccess kan användas utbytbart med PublicNetworkAccess innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten aktiverat inaktiverad
ResourceProvisioningState	Etableringstillståndet för en resurstyp. KnownResourceProvisioningState kan användas utbytbart med ResourceProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten lyckades misslyckades avbröts
Versions	Tillgängliga API-versioner.

Uppräkningar

KnownActionType	Kända värden för ActionType- som tjänsten accepterar.
KnownCheckNameAvailabilityReason	Kända värden för CheckNameAvailabilityReason som tjänsten accepterar.
KnownCreateMode	Kända värden för CreateMode som tjänsten accepterar.
KnownCreatedByType	Kända värden för CreatedByType- som tjänsten accepterar.
KnownMongoClusterStatus	Kända värden för MongoClusterStatus som tjänsten accepterar.
KnownNodeKind	Kända värden för NodeKind- som tjänsten accepterar.
KnownOrigin	Kända värden för Origin som tjänsten accepterar.
KnownPrivateEndpointConnectionProvisioningState	Kända värden för PrivateEndpointConnectionProvisioningState som tjänsten accepterar.
KnownPrivateEndpointServiceConnectionStatus	Kända värden för PrivateEndpointServiceConnectionStatus som tjänsten accepterar.
KnownPublicNetworkAccess	Kända värden för PublicNetworkAccess som tjänsten accepterar.
KnownResourceProvisioningState	Kända värden för ResourceProvisioningState som tjänsten accepterar.

Funktioner

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

Funktionsinformation

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

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

Parametrar

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returer

PollerLike<OperationState<TResult>, TResult>