MongoClusterResource.PromoteAsync Method
Definition
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 System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> PromoteAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.MongoCluster.Models.PromoteReplicaContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member PromoteAsync : Azure.WaitUntil * Azure.ResourceManager.MongoCluster.Models.PromoteReplicaContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.PromoteAsync : Azure.WaitUntil * Azure.ResourceManager.MongoCluster.Models.PromoteReplicaContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function PromoteAsync (waitUntil As WaitUntil, content As PromoteReplicaContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.
- content
- PromoteReplicaContent
The content of the action request.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
content
is null.