MongoClusters interface
Interface representing a MongoClusters.
Methods
Method Details
beginCreateOrUpdate(string, string, MongoCluster, MongoClustersCreateOrUpdateOptionalParams)
Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.
function beginCreateOrUpdate(resourceGroupName: string, mongoClusterName: string, parameters: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<MongoCluster>, MongoCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- parameters
- MongoCluster
The required parameters for creating or updating a mongo cluster.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<MongoCluster>, MongoCluster>>
beginCreateOrUpdateAndWait(string, string, MongoCluster, MongoClustersCreateOrUpdateOptionalParams)
Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.
function beginCreateOrUpdateAndWait(resourceGroupName: string, mongoClusterName: string, parameters: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams): Promise<MongoCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- parameters
- MongoCluster
The required parameters for creating or updating a mongo cluster.
The options parameters.
Returns
Promise<MongoCluster>
beginCreateOrUpdateFirewallRule(string, string, string, FirewallRule, MongoClustersCreateOrUpdateFirewallRuleOptionalParams)
Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
function beginCreateOrUpdateFirewallRule(resourceGroupName: string, mongoClusterName: string, firewallRuleName: string, parameters: FirewallRule, options?: MongoClustersCreateOrUpdateFirewallRuleOptionalParams): Promise<SimplePollerLike<OperationState<FirewallRule>, FirewallRule>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- firewallRuleName
-
string
The name of the mongo cluster firewall rule.
- parameters
- FirewallRule
The required parameters for creating or updating a firewall rule.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<FirewallRule>, FirewallRule>>
beginCreateOrUpdateFirewallRuleAndWait(string, string, string, FirewallRule, MongoClustersCreateOrUpdateFirewallRuleOptionalParams)
Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
function beginCreateOrUpdateFirewallRuleAndWait(resourceGroupName: string, mongoClusterName: string, firewallRuleName: string, parameters: FirewallRule, options?: MongoClustersCreateOrUpdateFirewallRuleOptionalParams): Promise<FirewallRule>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- firewallRuleName
-
string
The name of the mongo cluster firewall rule.
- parameters
- FirewallRule
The required parameters for creating or updating a firewall rule.
The options parameters.
Returns
Promise<FirewallRule>
beginDelete(string, string, MongoClustersDeleteOptionalParams)
Deletes a mongo cluster.
function beginDelete(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<MongoClustersDeleteHeaders>, MongoClustersDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
The options parameters.
Returns
beginDeleteAndWait(string, string, MongoClustersDeleteOptionalParams)
Deletes a mongo cluster.
function beginDeleteAndWait(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams): Promise<MongoClustersDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
The options parameters.
Returns
Promise<MongoClustersDeleteHeaders>
beginDeleteFirewallRule(string, string, string, MongoClustersDeleteFirewallRuleOptionalParams)
Deletes a mongo cluster firewall rule.
function beginDeleteFirewallRule(resourceGroupName: string, mongoClusterName: string, firewallRuleName: string, options?: MongoClustersDeleteFirewallRuleOptionalParams): Promise<SimplePollerLike<OperationState<MongoClustersDeleteFirewallRuleHeaders>, MongoClustersDeleteFirewallRuleHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- firewallRuleName
-
string
The name of the mongo cluster firewall rule.
The options parameters.
Returns
beginDeleteFirewallRuleAndWait(string, string, string, MongoClustersDeleteFirewallRuleOptionalParams)
Deletes a mongo cluster firewall rule.
function beginDeleteFirewallRuleAndWait(resourceGroupName: string, mongoClusterName: string, firewallRuleName: string, options?: MongoClustersDeleteFirewallRuleOptionalParams): Promise<MongoClustersDeleteFirewallRuleHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- firewallRuleName
-
string
The name of the mongo cluster firewall rule.
The options parameters.
Returns
beginUpdate(string, string, MongoClusterUpdate, MongoClustersUpdateOptionalParams)
Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.
function beginUpdate(resourceGroupName: string, mongoClusterName: string, parameters: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<MongoCluster>, MongoCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- parameters
- MongoClusterUpdate
The parameters for updating a mongo cluster.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<MongoCluster>, MongoCluster>>
beginUpdateAndWait(string, string, MongoClusterUpdate, MongoClustersUpdateOptionalParams)
Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.
function beginUpdateAndWait(resourceGroupName: string, mongoClusterName: string, parameters: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams): Promise<MongoCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- parameters
- MongoClusterUpdate
The parameters for updating a mongo cluster.
The options parameters.
Returns
Promise<MongoCluster>
checkNameAvailability(string, CheckNameAvailabilityRequest, MongoClustersCheckNameAvailabilityOptionalParams)
Check the availability of name for resource
function checkNameAvailability(location: string, parameters: CheckNameAvailabilityRequest, options?: MongoClustersCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>Parameters
- location
-
string
The name of the Azure region.
- parameters
- CheckNameAvailabilityRequest
The required parameters for checking if resource name is available.
The options parameters.
Returns
Promise<CheckNameAvailabilityResponse>
get(string, string, MongoClustersGetOptionalParams)
Gets information about a mongo cluster.
function get(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersGetOptionalParams): Promise<MongoCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- options
- MongoClustersGetOptionalParams
The options parameters.
Returns
Promise<MongoCluster>
getFirewallRule(string, string, string, MongoClustersGetFirewallRuleOptionalParams)
Gets information about a mongo cluster firewall rule.
function getFirewallRule(resourceGroupName: string, mongoClusterName: string, firewallRuleName: string, options?: MongoClustersGetFirewallRuleOptionalParams): Promise<FirewallRule>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
- firewallRuleName
-
string
The name of the mongo cluster firewall rule.
The options parameters.
Returns
Promise<FirewallRule>
list(MongoClustersListOptionalParams)
List all the mongo clusters in a given subscription.
function list(options?: MongoClustersListOptionalParams): PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>Parameters
- options
- MongoClustersListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, MongoClustersListByResourceGroupOptionalParams)
List all the mongo clusters in a given resource group.
function listByResourceGroup(resourceGroupName: string, options?: MongoClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listConnectionStrings(string, string, MongoClustersListConnectionStringsOptionalParams)
List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster.
function listConnectionStrings(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListConnectionStringsOptionalParams): Promise<ListConnectionStringsResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
The options parameters.
Returns
Promise<ListConnectionStringsResult>
listFirewallRules(string, string, MongoClustersListFirewallRulesOptionalParams)
List all the firewall rules in a given mongo cluster.
function listFirewallRules(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListFirewallRulesOptionalParams): PagedAsyncIterableIterator<FirewallRule, FirewallRule[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- mongoClusterName
-
string
The name of the mongo cluster.
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for