MongoClusterResource.Promote Method

Reference

Definition

Namespace:: Azure.ResourceManager.MongoCluster

Assembly:: Azure.ResourceManager.MongoCluster.dll

Package:: Azure.ResourceManager.MongoCluster v1.0.0-beta.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Promotes a replica mongo cluster to a primary role.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/promote
Operation Id: MongoClusters_Promote
Default Api Version: 2024-07-01
Resource: MongoClusterResource

public virtual Azure.ResourceManager.ArmOperation Promote (Azure.WaitUntil waitUntil, Azure.ResourceManager.MongoCluster.Models.PromoteReplicaContent content, System.Threading.CancellationToken cancellationToken = default);

abstract member Promote : Azure.WaitUntil * Azure.ResourceManager.MongoCluster.Models.PromoteReplicaContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.Promote : Azure.WaitUntil * Azure.ResourceManager.MongoCluster.Models.PromoteReplicaContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation

Public Overridable Function Promote (waitUntil As WaitUntil, content As PromoteReplicaContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.