@azure/arm-mongocluster package
Classes
MongoClusterManagementClient |
Interfaces
CheckNameAvailabilityRequest |
The check availability request body. |
CheckNameAvailabilityResponse |
The check availability result. |
ConnectionString |
Connection string for the mongo cluster |
FirewallRule |
Represents a mongo cluster firewall rule. |
FirewallRuleProperties |
The properties of a mongo cluster firewall rule. |
FirewallRulesCreateOrUpdateOptionalParams |
Optional parameters. |
FirewallRulesDeleteOptionalParams |
Optional parameters. |
FirewallRulesGetOptionalParams |
Optional parameters. |
FirewallRulesListByMongoClusterOptionalParams |
Optional parameters. |
FirewallRulesOperations |
Interface representing a FirewallRules operations. |
ListConnectionStringsResult |
The connection strings for the given mongo cluster. |
MongoCluster |
Represents a mongo cluster resource. |
MongoClusterManagementClientOptionalParams |
Optional parameters for the client. |
MongoClusterProperties |
The properties of a mongo cluster. |
MongoClusterReplicaParameters |
Parameters used for replica operations. |
MongoClusterRestoreParameters |
Parameters used for restore operations |
MongoClusterUpdate |
The type used for update operations of the MongoCluster. |
MongoClusterUpdateProperties |
The updatable properties of the MongoCluster. |
MongoClustersCheckNameAvailabilityOptionalParams |
Optional parameters. |
MongoClustersCreateOrUpdateOptionalParams |
Optional parameters. |
MongoClustersDeleteOptionalParams |
Optional parameters. |
MongoClustersGetOptionalParams |
Optional parameters. |
MongoClustersListByResourceGroupOptionalParams |
Optional parameters. |
MongoClustersListConnectionStringsOptionalParams |
Optional parameters. |
MongoClustersListOptionalParams |
Optional parameters. |
MongoClustersOperations |
Interface representing a MongoClusters operations. |
MongoClustersPromoteOptionalParams |
Optional parameters. |
MongoClustersUpdateOptionalParams |
Optional parameters. |
NodeGroupSpec |
Specification for a node group. |
Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
OperationDisplay |
Localized display information for and operation. |
OperationsListOptionalParams |
Optional parameters. |
OperationsOperations |
Interface representing a Operations operations. |
PageSettings |
Options for the byPage method |
PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
PrivateEndpoint |
The Private Endpoint resource. |
PrivateEndpointConnection |
The private endpoint connection resource |
PrivateEndpointConnectionProperties |
Properties of the private endpoint connection. |
PrivateEndpointConnectionResource |
Concrete proxy resource types can be created by aliasing this type using a specific property type. |
PrivateEndpointConnectionsCreateOptionalParams |
Optional parameters. |
PrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
PrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
PrivateEndpointConnectionsListByMongoClusterOptionalParams |
Optional parameters. |
PrivateEndpointConnectionsOperations |
Interface representing a PrivateEndpointConnections operations. |
PrivateLinkResource |
Concrete proxy resource types can be created by aliasing this type using a specific property type. |
PrivateLinkResourceProperties |
Properties of a private link resource. |
PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
PrivateLinksListByMongoClusterOptionalParams |
Optional parameters. |
PrivateLinksOperations |
Interface representing a PrivateLinks operations. |
PromoteReplicaRequest |
Promote replica request properties. |
ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
Replica |
Represents a mongo cluster replica. |
ReplicasListByParentOptionalParams |
Optional parameters. |
ReplicasOperations |
Interface representing a Replicas operations. |
ReplicationProperties |
Replica properties of the mongo cluster. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
RestorePollerOptions | |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
Type Aliases
ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal |
CheckNameAvailabilityReason |
Possible reasons for a name not being available. Known values supported by the serviceInvalid |
ContinuablePage |
An interface that describes a page of results. |
CreateMode |
The mode that the Mongo Cluster is created with. Known values supported by the serviceDefault |
CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser |
MongoClusterStatus |
The status of the Mongo cluster resource. Known values supported by the serviceReady |
NodeKind |
The kind of the node on the cluster. Known values supported by the serviceShard |
Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser |
PreviewFeature |
Preview features that can be enabled on a mongo cluster. Known values supported by the serviceGeoReplicas |
PrivateEndpointConnectionProvisioningState |
The current provisioning state. Known values supported by the serviceSucceeded |
PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. Known values supported by the servicePending |
PromoteMode |
The mode to apply to a promote operation. Known values supported by the serviceSwitchover |
PromoteOption |
The option to apply to a promote operation. Known values supported by the serviceForced |
ProvisioningState |
The provisioning state of a resource type. Known values supported by the serviceSucceeded |
PublicNetworkAccess |
Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is 'Enabled' Known values supported by the serviceEnabled |
ReplicationRole |
Replication role of the mongo cluster. Known values supported by the servicePrimary |
ReplicationState |
The state of the replication link between the replica and source cluster. Known values supported by the serviceActive |
Enums
KnownActionType |
Known values of ActionType that the service accepts. |
KnownCheckNameAvailabilityReason |
Known values of CheckNameAvailabilityReason that the service accepts. |
KnownCreateMode |
Known values of CreateMode that the service accepts. |
KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
KnownMongoClusterStatus |
Known values of MongoClusterStatus that the service accepts. |
KnownNodeKind |
Known values of NodeKind that the service accepts. |
KnownOrigin |
Known values of Origin that the service accepts. |
KnownPreviewFeature |
Known values of PreviewFeature that the service accepts. |
KnownPrivateEndpointConnectionProvisioningState |
Known values of PrivateEndpointConnectionProvisioningState that the service accepts. |
KnownPrivateEndpointServiceConnectionStatus |
Known values of PrivateEndpointServiceConnectionStatus that the service accepts. |
KnownPromoteMode |
Known values of PromoteMode that the service accepts. |
KnownPromoteOption |
Known values of PromoteOption that the service accepts. |
KnownProvisioningState |
Known values of ProvisioningState that the service accepts. |
KnownPublicNetworkAccess |
Known values of PublicNetworkAccess that the service accepts. |
KnownReplicationRole |
Known values of ReplicationRole that the service accepts. |
KnownReplicationState |
Known values of ReplicationState that the service accepts. |
Functions
restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Function Details
restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
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>
Returns
PollerLike<OperationState<TResult>, TResult>
Azure SDK for JavaScript