provisioned Cluster Instances - List

Service:

Hybrid Container Service

API Version:

2024-01-01

Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster

GET https://management.azure.com/{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
connectedClusterResourceUri	path	True	string	The fully qualified Azure Resource Manager identifier of the connected cluster resource.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	provisionedClusterListResult	Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListProvisionedClusterInstances

Sample request

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances?api-version=2024-01-01

Java

/**
 * Samples for ProvisionedClusterInstances List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/
     * ListProvisionedClusterInstances.json
     */
    /**
     * Sample code: ListProvisionedClusterInstances.
     * 
     * @param manager Entry point to HybridContainerServiceManager.
     */
    public static void listProvisionedClusterInstances(
        com.azure.resourcemanager.hybridcontainerservice.HybridContainerServiceManager manager) {
        manager.provisionedClusterInstances().list(
            "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.hybridcontainerservice import HybridContainerServiceMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-hybridcontainerservice
# USAGE
    python list_provisioned_cluster_instances.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HybridContainerServiceMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.provisioned_cluster_instances.list(
        connected_cluster_resource_uri="subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/ListProvisionedClusterInstances.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armhybridcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hybridcontainerservice/armhybridcontainerservice"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/ListProvisionedClusterInstances.json
func ExampleProvisionedClusterInstancesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armhybridcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewProvisionedClusterInstancesClient().NewListPager("subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProvisionedClusterListResult = armhybridcontainerservice.ProvisionedClusterListResult{
		// 	Value: []*armhybridcontainerservice.ProvisionedCluster{
		// 		{
		// 			Name: to.Ptr("test-hybridakscluster"),
		// 			Type: to.Ptr("Microsoft.HybridContainerService/provisionedClusterInstances"),
		// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default"),
		// 			ExtendedLocation: &armhybridcontainerservice.ExtendedLocation{
		// 				Name: to.Ptr("/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourcegroups/test-arcappliance-resgrp/providers/microsoft.extendedlocation/customlocations/testcustomlocation"),
		// 				Type: to.Ptr(armhybridcontainerservice.ExtendedLocationTypesCustomLocation),
		// 			},
		// 			Properties: &armhybridcontainerservice.ProvisionedClusterProperties{
		// 				AgentPoolProfiles: []*armhybridcontainerservice.NamedAgentPoolProfile{
		// 					{
		// 						Name: to.Ptr("default-nodepool-1"),
		// 						OSType: to.Ptr(armhybridcontainerservice.OsTypeLinux),
		// 						Count: to.Ptr[int32](1),
		// 						VMSize: to.Ptr("Standard_A4_v2"),
		// 				}},
		// 				CloudProviderProfile: &armhybridcontainerservice.CloudProviderProfile{
		// 					InfraNetworkProfile: &armhybridcontainerservice.CloudProviderProfileInfraNetworkProfile{
		// 						VnetSubnetIDs: []*string{
		// 							to.Ptr("/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.AzureStackHCI/logicalNetworks/test-vnet-static")},
		// 						},
		// 					},
		// 					ControlPlane: &armhybridcontainerservice.ControlPlaneProfile{
		// 						Count: to.Ptr[int32](1),
		// 						VMSize: to.Ptr("Standard_A4_v2"),
		// 					},
		// 					KubernetesVersion: to.Ptr("v1.20.5"),
		// 					LicenseProfile: &armhybridcontainerservice.ProvisionedClusterLicenseProfile{
		// 						AzureHybridBenefit: to.Ptr(armhybridcontainerservice.AzureHybridBenefitNotApplicable),
		// 					},
		// 					LinuxProfile: &armhybridcontainerservice.LinuxProfileProperties{
		// 						SSH: &armhybridcontainerservice.LinuxProfilePropertiesSSH{
		// 							PublicKeys: []*armhybridcontainerservice.LinuxProfilePropertiesSSHPublicKeysItem{
		// 								{
		// 									KeyData: to.Ptr("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCY......."),
		// 							}},
		// 						},
		// 					},
		// 					NetworkProfile: &armhybridcontainerservice.NetworkProfile{
		// 						NetworkPolicy: to.Ptr(armhybridcontainerservice.NetworkPolicyCalico),
		// 						PodCidr: to.Ptr("10.244.0.0/16"),
		// 					},
		// 					ProvisioningState: to.Ptr(armhybridcontainerservice.ResourceProvisioningStateSucceeded),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { HybridContainerServiceClient } = require("@azure/arm-hybridcontainerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster
 *
 * @summary Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster
 * x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/ListProvisionedClusterInstances.json
 */
async function listProvisionedClusterInstances() {
  const connectedClusterResourceUri =
    "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster";
  const credential = new DefaultAzureCredential();
  const client = new HybridContainerServiceClient(credential);
  const resArray = new Array();
  for await (let item of client.provisionedClusterInstances.list(connectedClusterResourceUri)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default",
      "name": "test-hybridakscluster",
      "type": "Microsoft.HybridContainerService/provisionedClusterInstances",
      "extendedLocation": {
        "name": "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourcegroups/test-arcappliance-resgrp/providers/microsoft.extendedlocation/customlocations/testcustomlocation",
        "type": "CustomLocation"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "controlPlane": {
          "count": 1,
          "vmSize": "Standard_A4_v2"
        },
        "kubernetesVersion": "v1.20.5",
        "networkProfile": {
          "networkPolicy": "calico",
          "podCidr": "10.244.0.0/16"
        },
        "agentPoolProfiles": [
          {
            "name": "default-nodepool-1",
            "count": 1,
            "vmSize": "Standard_A4_v2",
            "osType": "Linux"
          }
        ],
        "linuxProfile": {
          "ssh": {
            "publicKeys": [
              {
                "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCY......."
              }
            ]
          }
        },
        "cloudProviderProfile": {
          "infraNetworkProfile": {
            "vnetSubnetIds": [
              "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.AzureStackHCI/logicalNetworks/test-vnet-static"
            ]
          }
        },
        "licenseProfile": {
          "azureHybridBenefit": "NotApplicable"
        }
      }
    }
  ]
}

Definitions

Name	Description
addonPhase	Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading'
AddonStatusProfile	The status profile of the addons and other kubernetes components
AutoScalerProfile	Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster.
AzureHybridBenefit	Indicates whether Azure Hybrid Benefit is opted in. Default value is false
CloudProviderProfile	The profile for the underlying cloud infrastructure provider for the provisioned cluster.
ClusterVMAccessProfile	The SSH restricted access profile for the VMs in the provisioned cluster.
ControlPlaneEndpoint	IP Address of the Kubernetes API server
ControlPlaneProfile	The properties of the control plane nodes of the provisioned cluster
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
expander	The expander to use when scaling up
ExtendedLocation	Extended location pointing to the underlying infrastructure
ExtendedLocationTypes	The extended location type. Allowed value: 'CustomLocation'
InfraNetworkProfile	The profile for the infrastructure networks used by the provisioned cluster
LinuxProfileProperties	SSH profile for control plane and nodepool VMs of the provisioned cluster.
LoadBalancerProfile	Profile of the HA Proxy load balancer.
NamedAgentPoolProfile	Profile of the default agent pool along with a name parameter
networkPolicy	Network policy used for building Kubernetes network. Possible values include: 'calico'.
NetworkProfile	The network configuration profile for the provisioned cluster.
OSSKU	Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows.
osType	OSType to be used to specify OS type for the VMs. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
provisionedCluster	The provisioned cluster resource definition.
ProvisionedClusterLicenseProfile	The license profile of the provisioned cluster.
provisionedClusterListResult	Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster.
provisionedClusterProperties	Properties of the provisioned cluster.
PublicKeys	The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified.
ResourceProvisioningState	Provisioning state of the resource
Ssh	SSH configuration for VMs of the provisioned cluster.
Status	The observed status of the provisioned cluster.
StorageProfile	The storage configuration profile for the provisioned cluster.
StorageProfileNfsCSIDriver	NFS CSI Driver settings for the storage profile.
StorageProfileSmbCSIDriver	SMB CSI Driver settings for the storage profile.
systemData	Metadata pertaining to creation and last modification of the resource.

addonPhase

Enumeration

Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading'

Value	Description
deleting
failed
pending
provisioned
provisioning
provisioning {HelmChartInstalled}
provisioning {MSICertificateDownloaded}
upgrading

AddonStatusProfile

Object

The status profile of the addons and other kubernetes components

Name	Type	Description
errorMessage	string	Observed error message from the addon or component
name	string	Name of the addon or component
phase	addonPhase	Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading'
ready	boolean	Indicates whether the addon or component is ready

AutoScalerProfile

Object

Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster.

Name	Type	Description
balance-similar-node-groups	string	Detects similar node pools and balances the number of nodes between them. Valid values are 'true' and 'false'
expander	expander	The expander to use when scaling up If not specified, the default is 'random'. See expanders for more information.
max-empty-bulk-delete	string	The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer. The default is 10.
max-graceful-termination-sec	string	The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. The default is 600.
max-node-provision-time	string	The maximum time the autoscaler waits for a node to be provisioned. The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
max-total-unready-percentage	string	The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations. The default is 45. The maximum is 100 and the minimum is 0.
new-pod-scale-up-delay	string	Ignore unscheduled pods before they're a certain age. For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc).
ok-total-unready-count	string	The number of allowed unready nodes, irrespective of max-total-unready-percentage. This must be an integer. The default is 3.
scale-down-delay-after-add	string	How long after scale up that scale down evaluation resumes The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-delay-after-delete	string	How long after node deletion that scale down evaluation resumes. The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-delay-after-failure	string	How long after scale down failure that scale down evaluation resumes. The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-unneeded-time	string	How long a node should be unneeded before it is eligible for scale down. The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-unready-time	string	How long an unready node should be unneeded before it is eligible for scale down The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-utilization-threshold	string	Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down. The default is '0.5'.
scan-interval	string	How often cluster is reevaluated for scale up or down. The default is '10'. Values must be an integer number of seconds.
skip-nodes-with-local-storage	string	If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath. The default is true.
skip-nodes-with-system-pods	string	If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods) The default is true.

AzureHybridBenefit

Enumeration

Indicates whether Azure Hybrid Benefit is opted in. Default value is false

Value	Description
False
NotApplicable
True

CloudProviderProfile

Object

The profile for the underlying cloud infrastructure provider for the provisioned cluster.

Name	Type	Description
infraNetworkProfile	InfraNetworkProfile	The profile for the infrastructure networks used by the provisioned cluster

ClusterVMAccessProfile

Object

The SSH restricted access profile for the VMs in the provisioned cluster.

Name	Type	Description
authorizedIPRanges	string	IP Address or CIDR for SSH access to VMs in the provisioned cluster

ControlPlaneEndpoint

Object

IP Address of the Kubernetes API server

Name	Type	Description
hostIP	string	IP address of the Kubernetes API server

ControlPlaneProfile

Object

The properties of the control plane nodes of the provisioned cluster

Name	Type	Default value	Description
controlPlaneEndpoint	ControlPlaneEndpoint		IP Address of the Kubernetes API server
count	integer	1	Number of control plane nodes. The default value is 1, and the count should be an odd number
vmSize	string		VM sku size of the control plane nodes

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

expander

Enumeration

The expander to use when scaling up

Value	Description
least-waste	Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources.
most-pods	Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once.
priority	Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details here.
random	Used when you don't have a particular need for the node groups to scale differently.

ExtendedLocation

Object

Extended location pointing to the underlying infrastructure

Name	Type	Description
name	string	ARM Id of the extended location.
type	ExtendedLocationTypes	The extended location type. Allowed value: 'CustomLocation'

ExtendedLocationTypes

Enumeration

The extended location type. Allowed value: 'CustomLocation'

Value	Description
CustomLocation

InfraNetworkProfile

Object

The profile for the infrastructure networks used by the provisioned cluster

Name	Type	Description
vnetSubnetIds	string[]	List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}

LinuxProfileProperties

Object

SSH profile for control plane and nodepool VMs of the provisioned cluster.

Name	Type	Description
ssh	Ssh	SSH configuration for VMs of the provisioned cluster.

LoadBalancerProfile

Object

Profile of the HA Proxy load balancer.

Name	Type	Default value	Description
count	integer	0	Number of HA Proxy load balancer VMs. The default value is 0.

NamedAgentPoolProfile

Object

Profile of the default agent pool along with a name parameter

Name	Type	Default value	Description
count	integer	1	Number of nodes in the agent pool. The default value is 1.
enableAutoScaling	boolean	False	Whether to enable auto-scaler. Default value is false
kubernetesVersion	string		Version of Kubernetes in use by the agent pool. This is inherited from the kubernetesVersion of the provisioned cluster.
maxCount	integer		The maximum number of nodes for auto-scaling
maxPods	integer		The maximum number of pods that can run on a node.
minCount	integer		The minimum number of nodes for auto-scaling
name	string		Unique name of the default agent pool in the context of the provisioned cluster. Default value is -nodepool1
nodeLabels	object		The node labels to be persisted across all nodes in agent pool.
nodeTaints	string[]		Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
osSKU	OSSKU		Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows.
osType	osType	Linux	OSType to be used to specify OS type for the VMs. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
vmSize	string		The VM sku size of the agent pool node VMs.

networkPolicy

Enumeration

Network policy used for building Kubernetes network. Possible values include: 'calico'.

Value	Description
calico

NetworkProfile

Object

The network configuration profile for the provisioned cluster.

Name	Type	Default value	Description
loadBalancerProfile	LoadBalancerProfile		Profile of the HA Proxy load balancer.
networkPolicy	networkPolicy	calico	Network policy used for building Kubernetes network. Possible values include: 'calico'.
podCidr	string		A CIDR notation IP Address range from which to assign pod IPs.

OSSKU

Enumeration

Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows.

Value	Description
CBLMariner	Use Mariner as the OS for node images.
Windows2019	Use Windows2019 as the OS for node images.
Windows2022	Use Windows2022 as the OS for node images.

osType

Enumeration

OSType to be used to specify OS type for the VMs. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'

Value	Description
Linux
Windows

provisionedCluster

Object

The provisioned cluster resource definition.

Name	Type	Description
extendedLocation	ExtendedLocation	Extended location pointing to the underlying infrastructure
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	provisionedClusterProperties	Properties of the provisioned cluster.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ProvisionedClusterLicenseProfile

Object

The license profile of the provisioned cluster.

Name	Type	Default value	Description
azureHybridBenefit	AzureHybridBenefit	NotApplicable	Indicates whether Azure Hybrid Benefit is opted in. Default value is false

provisionedClusterListResult

Object

Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster.

Name	Type	Description
nextLink	string
value	provisionedCluster[]	The provisioned cluster resource definition.

provisionedClusterProperties

Object

Properties of the provisioned cluster.

Name	Type	Description
agentPoolProfiles	NamedAgentPoolProfile[]	The agent pool properties for the provisioned cluster.
autoScalerProfile	AutoScalerProfile	Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster.
cloudProviderProfile	CloudProviderProfile	The profile for the underlying cloud infrastructure provider for the provisioned cluster.
clusterVMAccessProfile	ClusterVMAccessProfile	The SSH restricted access profile for the VMs in the provisioned cluster.
controlPlane	ControlPlaneProfile	The profile for control plane of the provisioned cluster.
kubernetesVersion	string	The version of Kubernetes in use by the provisioned cluster.
licenseProfile	ProvisionedClusterLicenseProfile	The license profile of the provisioned cluster.
linuxProfile	LinuxProfileProperties	The profile for Linux VMs in the provisioned cluster.
networkProfile	NetworkProfile	The network configuration profile for the provisioned cluster.
provisioningState	ResourceProvisioningState	The status of the latest long running operation for the provisioned cluster.
status	Status	The observed status of the provisioned cluster.
storageProfile	StorageProfile	The storage configuration profile for the provisioned cluster.

PublicKeys

Object

The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified.

Name	Type	Description
keyData	string	Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

ResourceProvisioningState

Enumeration

Provisioning state of the resource

Value	Description
Accepted
Canceled
Creating
Deleting
Failed
Pending
Succeeded
Updating
Upgrading

Ssh

Object

SSH configuration for VMs of the provisioned cluster.

Name	Type	Description
publicKeys	PublicKeys[]	The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified.

Status

Object

The observed status of the provisioned cluster.

Name	Type	Description
controlPlaneStatus	AddonStatusProfile[]	The detailed status of the provisioned cluster components including addons.
currentState	ResourceProvisioningState	The current state of the provisioned cluster.
errorMessage	string	Error messages during a provisioned cluster operation or steady state.

StorageProfile

Object

The storage configuration profile for the provisioned cluster.

Name	Type	Description
nfsCsiDriver	StorageProfileNfsCSIDriver	NFS CSI Driver settings for the storage profile.
smbCsiDriver	StorageProfileSmbCSIDriver	SMB CSI Driver settings for the storage profile.

StorageProfileNfsCSIDriver

Object

NFS CSI Driver settings for the storage profile.

Name	Type	Default value	Description
enabled	boolean	True	Indicates whether to enable NFS CSI Driver. The default value is true.

StorageProfileSmbCSIDriver

Object

SMB CSI Driver settings for the storage profile.

Name	Type	Default value	Description
enabled	boolean	True	Indicates whether to enable SMB CSI Driver. The default value is true.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.