IManagedClustersOperations.StopWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.ContainerService

Assembly:: Microsoft.Azure.PowerShell.Aks.Management.Sdk.dll

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.

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.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Management.ContainerService.Models.ManagedClustersStopHeaders>> StopWithHttpMessagesAsync (string resourceGroupName, string resourceName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member StopWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Management.ContainerService.Models.ManagedClustersStopHeaders>>

Public Function StopWithHttpMessagesAsync (resourceGroupName As String, resourceName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of ManagedClustersStopHeaders))

Parameters

resourceGroupName: String

The name of the resource group. The name is case insensitive.

resourceName: String

The name of the managed cluster resource.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationHeaderResponse<ManagedClustersStopHeaders>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

Remarks

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](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.

Applies to

Condividi tramite