ContainerServiceManagedClusterResource.StopAsync Method

Definition

Namespace:

Azure.ResourceManager.ContainerService

Assembly:

Azure.ResourceManager.ContainerService.dll

Package:

Azure.ResourceManager.ContainerService v1.2.1

Source:

ContainerServiceManagedClusterResource.cs

This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See stopping a cluster for more details about stopping a cluster.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop
• Operation Id: ManagedClusters_Stop
• Default Api Version: 2023-10-01
• Resource: ContainerServiceManagedClusterResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> StopAsync (Azure.WaitUntil waitUntil, System.Threading.CancellationToken cancellationToken = default);

abstract member StopAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.StopAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>

Public Overridable Function StopAsync (waitUntil As WaitUntil, 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.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>