@azure/arm-mongocluster package
Administrator |
The local administrator login properties. |
Backup |
The backup properties of the cluster. This includes the earliest restore time and retention settings. |
Check |
The check availability request body. |
Check |
The check availability result. |
Compute |
The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied to servers in the cluster. |
Connection |
Connection string for the mongo cluster |
Firewall |
Represents a mongo cluster firewall rule. |
Firewall |
The properties of a mongo cluster firewall rule. |
Firewall |
Optional parameters. |
Firewall |
Optional parameters. |
Firewall |
Optional parameters. |
Firewall |
Optional parameters. |
Firewall |
Interface representing a FirewallRules operations. |
High |
The high availability properties of the cluster. |
List |
The connection strings for the given mongo cluster. |
Mongo |
Represents a mongo cluster resource. |
Mongo |
Optional parameters for the client. |
Mongo |
The properties of a mongo cluster. |
Mongo |
Parameters used for replica operations. |
Mongo |
Parameters used for restore operations |
Mongo |
The type used for update operations of the MongoCluster. |
Mongo |
The updatable properties of the MongoCluster. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Interface representing a MongoClusters operations. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
Operation |
Localized display information for and operation. |
Operations |
Optional parameters. |
Operations |
Interface representing a Operations operations. |
Page |
Options for the byPage method |
Paged |
An interface that allows async iterable iteration both to completion and by page. |
Private |
The Private Endpoint resource. |
Private |
The private endpoint connection resource |
Private |
Properties of the private endpoint connection. |
Private |
Concrete proxy resource types can be created by aliasing this type using a specific property type. |
Private |
Optional parameters. |
Private |
Optional parameters. |
Private |
Optional parameters. |
Private |
Optional parameters. |
Private |
Interface representing a PrivateEndpointConnections operations. |
Private |
Concrete proxy resource types can be created by aliasing this type using a specific property type. |
Private |
Properties of a private link resource. |
Private |
A collection of information about the state of the connection between service consumer and provider. |
Private |
Optional parameters. |
Private |
Interface representing a PrivateLinks operations. |
Promote |
Promote replica request properties. |
Proxy |
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. |
Replicas |
Optional parameters. |
Replicas |
Interface representing a Replicas operations. |
Replication |
Replica properties of the mongo cluster. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
Restore |
|
Sharding |
The sharding properties of the cluster. This includes the shard count and scaling options for the cluster. |
Storage |
The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster. |
System |
Metadata pertaining to creation and last modification of the resource. |
Tracked |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
Action |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal |
Check |
Possible reasons for a name not being available. Known values supported by the serviceInvalid |
Continuable |
An interface that describes a page of results. |
Create |
The mode that the Mongo Cluster is created with. Known values supported by the serviceDefault |
Created |
The kind of entity that created the resource. Known values supported by the serviceUser |
High |
The high availability modes for a cluster. Known values supported by the serviceDisabled |
Mongo |
The status of the Mongo cluster resource. Known values supported by the serviceReady |
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 |
Preview |
Preview features that can be enabled on a mongo cluster. Known values supported by the serviceGeoReplicas |
Private |
The current provisioning state. Known values supported by the serviceSucceeded |
Private |
The private endpoint connection status. Known values supported by the servicePending |
Promote |
The mode to apply to a promote operation. Known values supported by the serviceSwitchover |
Promote |
The option to apply to a promote operation. Known values supported by the serviceForced |
Provisioning |
The provisioning state of a resource type. Known values supported by the serviceSucceeded |
Public |
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 |
Replication |
Replication role of the mongo cluster. Known values supported by the servicePrimary |
Replication |
The state of the replication link between the replica and source cluster. Known values supported by the serviceActive |
Known |
Known values of ActionType that the service accepts. |
Known |
Known values of CheckNameAvailabilityReason that the service accepts. |
Known |
Known values of CreateMode that the service accepts. |
Known |
Known values of CreatedByType that the service accepts. |
Known |
Known values of HighAvailabilityMode that the service accepts. |
Known |
Known values of MongoClusterStatus that the service accepts. |
Known |
Known values of Origin that the service accepts. |
Known |
Known values of PreviewFeature that the service accepts. |
Known |
Known values of PrivateEndpointConnectionProvisioningState that the service accepts. |
Known |
Known values of PrivateEndpointServiceConnectionStatus that the service accepts. |
Known |
Known values of PromoteMode that the service accepts. |
Known |
Known values of PromoteOption that the service accepts. |
Known |
Known values of ProvisioningState that the service accepts. |
Known |
Known values of PublicNetworkAccess that the service accepts. |
Known |
Known values of ReplicationRole that the service accepts. |
Known |
Known values of ReplicationState that the service accepts. |
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. |
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>