Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Start-AzAksCluster

Module:
Az.Aks Module

See starting a cluster for more details about starting a cluster.

Syntax

Start (Default)

Start-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>]

StartViaIdentity

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

Description

See starting a cluster for more details about starting a cluster.

Examples

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

Start-AzAksCluster -ResourceGroupName group -Name myCluster

Start Aks cluster with resource group name and cluster name.

Example 2: Start Aks cluster with pipeline

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

Start Aks cluster with pipeline.

Parameters

-AsJob

Run the command as a job

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Break

Wait for .NET debugger to attach

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

-HttpPipelineAppend

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

Parameter properties

Type:

SendAsyncStep[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelinePrepend

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

Parameter properties

Type:

SendAsyncStep[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-InputObject

Identity Parameter

Parameter properties

Type:IAksIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

The name of the managed cluster resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ClusterName

Parameter sets

-NoWait

Run the command asynchronously

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Proxy

The URI for the proxy server to use

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:String
Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IAksIdentity

Outputs

Boolean


Feedback

Was this page helpful?