Stop-AzAksCluster

Module:

Az.Aks

Stops a Running Managed Cluster

Syntax

Stop-AzAksCluster
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-Break]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-NoWait]
    [-PassThru]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzAksCluster
    -InputObject <IAksIdentity>
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-Break]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-NoWait]
    [-PassThru]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Stops a Running Managed Cluster

Examples

Example 1: Stop Aks cluster with resource group name and cluster name

Stop-AzAksCluster -ResourceGroupName group -Name myCluster

Stop Aks cluster with resource group name and cluster name.

Example 2: Stop Aks cluster with pipeline

Get-AzAksCluster -ResourceGroupName group -Name myCluster | Stop-AzAksCluster

Stop Aks cluster with pipeline.

Parameters

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Break

Wait for .NET debugger to attach

Type:	SwitchParameter
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Type:	SendAsyncStep[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Type:	SendAsyncStep[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IAksIdentity
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the managed cluster resource.

Type:	String
Aliases:	ClusterName
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Proxy

The URI for the proxy server to use

Type:	Uri
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Type:	PSCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Type:	SwitchParameter
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IAksIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IAksIdentity>: Identity Parameter

• [AgentPoolName <String>]: The name of the agent pool.
• [Id <String>]: Resource identity path
• [Location <String>]: The name of a supported Azure region.
• [PrivateEndpointConnectionName <String>]: The name of the private endpoint connection.
• [ResourceGroupName <String>]: The name of the resource group.
• [ResourceName <String>]: The name of the managed cluster resource.
• [RoleName <String>]: The name of the role for managed cluster accessProfile resource.
• [SubscriptionId <String>]: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.