Edit

Share via

Get-AzAksArcCluster

  • Reference
Module:
Az.AksArc

Gets the provisioned cluster instance

Syntax

Get-AzAksArcCluster
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the provisioned cluster instance

Examples

Example 1: Get a provisioned cluster

Get-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group

This commands gets a provisioned cluster.

Parameters

-ClusterName

The name of the Kubernetes cluster on which get is called.

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

-DefaultProfile

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

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

-ResourceGroupName

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

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

-SubscriptionId

The ID of the target subscription.

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

Outputs

IProvisionedCluster