Kubernetes Clusters - List By Subscription

Service:: Operator Nexus - Network Cloud

API Version:: 2024-07-01

List Kubernetes clusters in the subscription.
Get a list of Kubernetes clusters in the provided subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/kubernetesClusters?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	KubernetesClusterList	The resource list has been successfully retrieved.
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

List Kubernetes clusters for subscription

Sample request

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/kubernetesClusters?api-version=2024-07-01


/**
 * Samples for KubernetesClusters List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/
     * KubernetesClusters_ListBySubscription.json
     */
    /**
     * Sample code: List Kubernetes clusters for subscription.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void
        listKubernetesClustersForSubscription(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.kubernetesClusters().list(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

from azure.identity import DefaultAzureCredential

from azure.mgmt.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python kubernetes_clusters_list_by_subscription.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.kubernetes_clusters.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.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

package armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c0a12a75b702054cf1e7fcd8c014d0fc116dea6e/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.json
func ExampleKubernetesClustersClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKubernetesClustersClient().NewListBySubscriptionPager(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.KubernetesClusterList = armnetworkcloud.KubernetesClusterList{
		// 	Value: []*armnetworkcloud.KubernetesCluster{
		// 		{
		// 			Name: to.Ptr("KubernetesClusterName"),
		// 			Type: to.Ptr("Microsoft.NetworkCloud/kubernetesClusters"),
		// 			ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName"),
		// 			SystemData: &armnetworkcloud.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
		// 				CreatedBy: to.Ptr("identityA"),
		// 				CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("identityB"),
		// 				LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("location"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("myvalue1"),
		// 				"key2": to.Ptr("myvalue2"),
		// 			},
		// 			ExtendedLocation: &armnetworkcloud.ExtendedLocation{
		// 				Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
		// 				Type: to.Ptr("CustomLocation"),
		// 			},
		// 			Properties: &armnetworkcloud.KubernetesClusterProperties{
		// 				AADConfiguration: &armnetworkcloud.AADConfiguration{
		// 					AdminGroupObjectIDs: []*string{
		// 						to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff")},
		// 					},
		// 					AdministratorConfiguration: &armnetworkcloud.AdministratorConfiguration{
		// 						AdminUsername: to.Ptr("azure"),
		// 						SSHPublicKeys: []*armnetworkcloud.SSHPublicKey{
		// 							{
		// 								KeyData: to.Ptr("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
		// 						}},
		// 					},
		// 					AttachedNetworkIDs: []*string{
		// 						to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName"),
		// 						to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 						to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName")},
		// 						AvailableUpgrades: []*armnetworkcloud.AvailableUpgrade{
		// 							{
		// 								AvailabilityLifecycle: to.Ptr(armnetworkcloud.AvailabilityLifecycleGenerallyAvailable),
		// 								Version: to.Ptr("1.XX.Y"),
		// 						}},
		// 						ClusterID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName"),
		// 						ConnectedClusterID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName"),
		// 						ControlPlaneKubernetesVersion: to.Ptr("1.XX.Y"),
		// 						ControlPlaneNodeConfiguration: &armnetworkcloud.ControlPlaneNodeConfiguration{
		// 							AdministratorConfiguration: &armnetworkcloud.AdministratorConfiguration{
		// 								AdminUsername: to.Ptr("azure"),
		// 								SSHPublicKeys: []*armnetworkcloud.SSHPublicKey{
		// 									{
		// 										KeyData: to.Ptr("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
		// 								}},
		// 							},
		// 							AvailabilityZones: []*string{
		// 								to.Ptr("1"),
		// 								to.Ptr("2"),
		// 								to.Ptr("3")},
		// 								Count: to.Ptr[int64](3),
		// 								VMSKUName: to.Ptr("NC_G6_28_v1"),
		// 							},
		// 							DetailedStatus: to.Ptr(armnetworkcloud.KubernetesClusterDetailedStatusAvailable),
		// 							DetailedStatusMessage: to.Ptr("Kubernetes cluster is operational"),
		// 							FeatureStatuses: []*armnetworkcloud.FeatureStatus{
		// 								{
		// 									Name: to.Ptr("Feature1"),
		// 									DetailedStatus: to.Ptr(armnetworkcloud.FeatureDetailedStatusRunning),
		// 									DetailedStatusMessage: to.Ptr("No issues detected"),
		// 									Version: to.Ptr("1"),
		// 							}},
		// 							InitialAgentPoolConfigurations: []*armnetworkcloud.InitialAgentPoolConfiguration{
		// 								{
		// 									Name: to.Ptr("SystemPool-1"),
		// 									AdministratorConfiguration: &armnetworkcloud.AdministratorConfiguration{
		// 										AdminUsername: to.Ptr("azure"),
		// 										SSHPublicKeys: []*armnetworkcloud.SSHPublicKey{
		// 											{
		// 												KeyData: to.Ptr("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
		// 										}},
		// 									},
		// 									AgentOptions: &armnetworkcloud.AgentOptions{
		// 										HugepagesCount: to.Ptr[int64](96),
		// 										HugepagesSize: to.Ptr(armnetworkcloud.HugepagesSizeOneG),
		// 									},
		// 									AttachedNetworkConfiguration: &armnetworkcloud.AttachedNetworkConfiguration{
		// 										L2Networks: []*armnetworkcloud.L2NetworkAttachmentConfiguration{
		// 											{
		// 												NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName"),
		// 												PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeDPDK),
		// 										}},
		// 										L3Networks: []*armnetworkcloud.L3NetworkAttachmentConfiguration{
		// 											{
		// 												IpamEnabled: to.Ptr(armnetworkcloud.L3NetworkConfigurationIpamEnabledFalse),
		// 												NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 												PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeSRIOV),
		// 										}},
		// 										TrunkedNetworks: []*armnetworkcloud.TrunkedNetworkAttachmentConfiguration{
		// 											{
		// 												NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName"),
		// 												PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeMACVLAN),
		// 										}},
		// 									},
		// 									AvailabilityZones: []*string{
		// 										to.Ptr("1"),
		// 										to.Ptr("2"),
		// 										to.Ptr("3")},
		// 										Count: to.Ptr[int64](3),
		// 										Labels: []*armnetworkcloud.KubernetesLabel{
		// 											{
		// 												Key: to.Ptr("kubernetes.label"),
		// 												Value: to.Ptr("true"),
		// 										}},
		// 										Mode: to.Ptr(armnetworkcloud.AgentPoolModeSystem),
		// 										Taints: []*armnetworkcloud.KubernetesLabel{
		// 											{
		// 												Key: to.Ptr("kubernetes.taint"),
		// 												Value: to.Ptr("true:NoSchedule"),
		// 										}},
		// 										UpgradeSettings: &armnetworkcloud.AgentPoolUpgradeSettings{
		// 											MaxSurge: to.Ptr("1"),
		// 										},
		// 										VMSKUName: to.Ptr("NC_P46_224_v1"),
		// 								}},
		// 								KubernetesVersion: to.Ptr("1.XX.Y"),
		// 								ManagedResourceGroupConfiguration: &armnetworkcloud.ManagedResourceGroupConfiguration{
		// 									Name: to.Ptr("my-managed-rg"),
		// 									Location: to.Ptr("East US"),
		// 								},
		// 								NetworkConfiguration: &armnetworkcloud.NetworkConfiguration{
		// 									AttachedNetworkConfiguration: &armnetworkcloud.AttachedNetworkConfiguration{
		// 										L2Networks: []*armnetworkcloud.L2NetworkAttachmentConfiguration{
		// 											{
		// 												NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName"),
		// 												PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeDPDK),
		// 										}},
		// 										L3Networks: []*armnetworkcloud.L3NetworkAttachmentConfiguration{
		// 											{
		// 												IpamEnabled: to.Ptr(armnetworkcloud.L3NetworkConfigurationIpamEnabledFalse),
		// 												NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 												PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeSRIOV),
		// 										}},
		// 										TrunkedNetworks: []*armnetworkcloud.TrunkedNetworkAttachmentConfiguration{
		// 											{
		// 												NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName"),
		// 												PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeMACVLAN),
		// 										}},
		// 									},
		// 									BgpServiceLoadBalancerConfiguration: &armnetworkcloud.BgpServiceLoadBalancerConfiguration{
		// 										BgpAdvertisements: []*armnetworkcloud.BgpAdvertisement{
		// 											{
		// 												AdvertiseToFabric: to.Ptr(armnetworkcloud.AdvertiseToFabricTrue),
		// 												Communities: []*string{
		// 													to.Ptr("64512:100")},
		// 													IPAddressPools: []*string{
		// 														to.Ptr("pool1")},
		// 														Peers: []*string{
		// 															to.Ptr("peer1")},
		// 													}},
		// 													BgpPeers: []*armnetworkcloud.ServiceLoadBalancerBgpPeer{
		// 														{
		// 															Name: to.Ptr("peer1"),
		// 															BfdEnabled: to.Ptr(armnetworkcloud.BfdEnabledFalse),
		// 															BgpMultiHop: to.Ptr(armnetworkcloud.BgpMultiHopFalse),
		// 															HoldTime: to.Ptr("P300s"),
		// 															KeepAliveTime: to.Ptr("P300s"),
		// 															MyAsn: to.Ptr[int64](64512),
		// 															PeerAddress: to.Ptr("203.0.113.254"),
		// 															PeerAsn: to.Ptr[int64](64497),
		// 															PeerPort: to.Ptr[int64](179),
		// 													}},
		// 													FabricPeeringEnabled: to.Ptr(armnetworkcloud.FabricPeeringEnabledTrue),
		// 													IPAddressPools: []*armnetworkcloud.IPAddressPool{
		// 														{
		// 															Name: to.Ptr("pool1"),
		// 															Addresses: []*string{
		// 																to.Ptr("198.51.102.0/24")},
		// 																AutoAssign: to.Ptr(armnetworkcloud.BfdEnabledTrue),
		// 																OnlyUseHostIPs: to.Ptr(armnetworkcloud.BfdEnabledTrue),
		// 														}},
		// 													},
		// 													CloudServicesNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName"),
		// 													CniNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 													DNSServiceIP: to.Ptr("198.51.101.2"),
		// 													PodCidrs: []*string{
		// 														to.Ptr("198.51.100.0/24")},
		// 														ServiceCidrs: []*string{
		// 															to.Ptr("198.51.101.0/24")},
		// 														},
		// 														Nodes: []*armnetworkcloud.KubernetesClusterNode{
		// 															{
		// 																Name: to.Ptr("kubernetesClusterName-SystemPool-1-md-cqjvd"),
		// 																AgentPoolID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName"),
		// 																AvailabilityZone: to.Ptr("1"),
		// 																BareMetalMachineID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName"),
		// 																CPUCores: to.Ptr[int64](46),
		// 																DetailedStatus: to.Ptr(armnetworkcloud.KubernetesClusterNodeDetailedStatusRunning),
		// 																DetailedStatusMessage: to.Ptr("Running - virtual machine is running."),
		// 																DiskSizeGB: to.Ptr[int64](300),
		// 																Image: to.Ptr("mariner-guest-image-qcow2-k8s-1.XX.Y"),
		// 																KubernetesVersion: to.Ptr("v1.XX.Y"),
		// 																Labels: []*armnetworkcloud.KubernetesLabel{
		// 																	{
		// 																		Key: to.Ptr("kubernetes.label"),
		// 																		Value: to.Ptr("true"),
		// 																}},
		// 																MemorySizeGB: to.Ptr[int64](224),
		// 																Mode: to.Ptr(armnetworkcloud.AgentPoolModeSystem),
		// 																NetworkAttachments: []*armnetworkcloud.NetworkAttachment{
		// 																	{
		// 																		AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName"),
		// 																		DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayFalse),
		// 																		IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 																		IPv4Address: to.Ptr("169.254.8.4"),
		// 																		MacAddress: to.Ptr("aa:bb:cc:06:79:2a"),
		// 																		NetworkAttachmentName: to.Ptr("cloudservices"),
		// 																	},
		// 																	{
		// 																		AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 																		DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayFalse),
		// 																		IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 																		IPv4Address: to.Ptr("10.14.48.12"),
		// 																		IPv6Address: to.Ptr("fda0:d59c:da0a:e30::a"),
		// 																		MacAddress: to.Ptr("aa:bb:cc:ad:40:cf"),
		// 																		NetworkAttachmentName: to.Ptr("defaultcni"),
		// 																}},
		// 																PowerState: to.Ptr(armnetworkcloud.KubernetesNodePowerStateOn),
		// 																Role: to.Ptr(armnetworkcloud.KubernetesNodeRoleWorker),
		// 																Taints: []*armnetworkcloud.KubernetesLabel{
		// 																	{
		// 																		Key: to.Ptr("kubernetes.taint"),
		// 																		Value: to.Ptr("true:NoSchedule"),
		// 																}},
		// 																VMSKUName: to.Ptr("NC_P46_224_v1"),
		// 															},
		// 															{
		// 																Name: to.Ptr("kubernetesClusterName-control-plane-7nsh2"),
		// 																BareMetalMachineID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName"),
		// 																CPUCores: to.Ptr[int64](6),
		// 																DetailedStatus: to.Ptr(armnetworkcloud.KubernetesClusterNodeDetailedStatusRunning),
		// 																DetailedStatusMessage: to.Ptr("Running - virtual machine is running."),
		// 																DiskSizeGB: to.Ptr[int64](300),
		// 																Image: to.Ptr("mariner-guest-image-qcow2-k8s-1.XX.Y"),
		// 																KubernetesVersion: to.Ptr("v1.XX.Y"),
		// 																MemorySizeGB: to.Ptr[int64](28),
		// 																NetworkAttachments: []*armnetworkcloud.NetworkAttachment{
		// 																	{
		// 																		AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName"),
		// 																		DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayFalse),
		// 																		IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 																		IPv4Address: to.Ptr("169.254.8.2"),
		// 																		MacAddress: to.Ptr("aa:bb:cc:fa:91:71"),
		// 																		NetworkAttachmentName: to.Ptr("cloudservices"),
		// 																	},
		// 																	{
		// 																		AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 																		DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayFalse),
		// 																		IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 																		IPv4Address: to.Ptr("10.14.48.11"),
		// 																		IPv6Address: to.Ptr("fda0:d59c:da0a:e30::9"),
		// 																		MacAddress: to.Ptr("aa:bb:cc:c8:a2:40"),
		// 																		NetworkAttachmentName: to.Ptr("defaultcni"),
		// 																}},
		// 																PowerState: to.Ptr(armnetworkcloud.KubernetesNodePowerStateOn),
		// 																Role: to.Ptr(armnetworkcloud.KubernetesNodeRoleControlPlane),
		// 																VMSKUName: to.Ptr("NC_G6_28_v1"),
		// 														}},
		// 														ProvisioningState: to.Ptr(armnetworkcloud.KubernetesClusterProvisioningStateSucceeded),
		// 													},
		// 											}},
		// 										}
	}
}

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

const { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get a list of Kubernetes clusters in the provided subscription.
 *
 * @summary Get a list of Kubernetes clusters in the provided subscription.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.json
 */
async function listKubernetesClustersForSubscription() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.kubernetesClusters.listBySubscription()) {
    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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.NetworkCloud;

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.json
// this example is just showing the usage of "KubernetesClusters_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (NetworkCloudKubernetesClusterResource item in subscriptionResource.GetNetworkCloudKubernetesClustersAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetworkCloudKubernetesClusterData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName",
      "name": "KubernetesClusterName",
      "systemData": {
        "createdAt": "2021-01-22T13:27:03.008Z",
        "createdBy": "identityA",
        "createdByType": "Application",
        "lastModifiedAt": "2021-01-22T13:29:03.001Z",
        "lastModifiedBy": "identityB",
        "lastModifiedByType": "User"
      },
      "type": "Microsoft.NetworkCloud/kubernetesClusters",
      "location": "location",
      "tags": {
        "key1": "myvalue1",
        "key2": "myvalue2"
      },
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
      },
      "properties": {
        "aadConfiguration": {
          "adminGroupObjectIds": [
            "ffffffff-ffff-ffff-ffff-ffffffffffff"
          ]
        },
        "administratorConfiguration": {
          "adminUsername": "azure",
          "sshPublicKeys": [
            {
              "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
            }
          ]
        },
        "initialAgentPoolConfigurations": [
          {
            "administratorConfiguration": {
              "adminUsername": "azure",
              "sshPublicKeys": [
                {
                  "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
                }
              ]
            },
            "agentOptions": {
              "hugepagesCount": 96,
              "hugepagesSize": "1G"
            },
            "attachedNetworkConfiguration": {
              "l2Networks": [
                {
                  "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName",
                  "pluginType": "DPDK"
                }
              ],
              "l3Networks": [
                {
                  "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
                  "pluginType": "SRIOV",
                  "ipamEnabled": "False"
                }
              ],
              "trunkedNetworks": [
                {
                  "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName",
                  "pluginType": "MACVLAN"
                }
              ]
            },
            "availabilityZones": [
              "1",
              "2",
              "3"
            ],
            "count": 3,
            "labels": [
              {
                "key": "kubernetes.label",
                "value": "true"
              }
            ],
            "mode": "System",
            "taints": [
              {
                "key": "kubernetes.taint",
                "value": "true:NoSchedule"
              }
            ],
            "upgradeSettings": {
              "maxSurge": "1"
            },
            "vmSkuName": "NC_P46_224_v1",
            "name": "SystemPool-1"
          }
        ],
        "controlPlaneNodeConfiguration": {
          "administratorConfiguration": {
            "adminUsername": "azure",
            "sshPublicKeys": [
              {
                "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
              }
            ]
          },
          "availabilityZones": [
            "1",
            "2",
            "3"
          ],
          "count": 3,
          "vmSkuName": "NC_G6_28_v1"
        },
        "kubernetesVersion": "1.XX.Y",
        "managedResourceGroupConfiguration": {
          "name": "my-managed-rg",
          "location": "East US"
        },
        "networkConfiguration": {
          "attachedNetworkConfiguration": {
            "l2Networks": [
              {
                "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName",
                "pluginType": "DPDK"
              }
            ],
            "l3Networks": [
              {
                "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
                "pluginType": "SRIOV",
                "ipamEnabled": "False"
              }
            ],
            "trunkedNetworks": [
              {
                "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName",
                "pluginType": "MACVLAN"
              }
            ]
          },
          "bgpServiceLoadBalancerConfiguration": {
            "bgpAdvertisements": [
              {
                "advertiseToFabric": "True",
                "communities": [
                  "64512:100"
                ],
                "ipAddressPools": [
                  "pool1"
                ],
                "peers": [
                  "peer1"
                ]
              }
            ],
            "fabricPeeringEnabled": "True",
            "bgpPeers": [
              {
                "bfdEnabled": "False",
                "bgpMultiHop": "False",
                "holdTime": "P300s",
                "keepAliveTime": "P300s",
                "myAsn": 64512,
                "name": "peer1",
                "peerAddress": "203.0.113.254",
                "peerAsn": 64497,
                "peerPort": 179
              }
            ],
            "ipAddressPools": [
              {
                "addresses": [
                  "198.51.102.0/24"
                ],
                "autoAssign": "True",
                "name": "pool1",
                "onlyUseHostIps": "True"
              }
            ]
          },
          "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
          "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
          "dnsServiceIp": "198.51.101.2",
          "podCidrs": [
            "198.51.100.0/24"
          ],
          "serviceCidrs": [
            "198.51.101.0/24"
          ]
        },
        "provisioningState": "Succeeded",
        "availableUpgrades": [
          {
            "version": "1.XX.Y",
            "availabilityLifecycle": "GenerallyAvailable"
          }
        ],
        "attachedNetworkIds": [
          "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName",
          "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
          "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName"
        ],
        "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
        "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName",
        "controlPlaneKubernetesVersion": "1.XX.Y",
        "detailedStatus": "Available",
        "detailedStatusMessage": "Kubernetes cluster is operational",
        "featureStatuses": [
          {
            "name": "Feature1",
            "version": "1",
            "detailedStatus": "Running",
            "detailedStatusMessage": "No issues detected"
          }
        ],
        "nodes": [
          {
            "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName",
            "availabilityZone": "1",
            "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
            "cpuCores": 46,
            "detailedStatus": "Running",
            "detailedStatusMessage": "Running - virtual machine is running.",
            "diskSizeGB": 300,
            "image": "mariner-guest-image-qcow2-k8s-1.XX.Y",
            "kubernetesVersion": "v1.XX.Y",
            "labels": [
              {
                "key": "kubernetes.label",
                "value": "true"
              }
            ],
            "memorySizeGB": 224,
            "mode": "System",
            "name": "kubernetesClusterName-SystemPool-1-md-cqjvd",
            "networkAttachments": [
              {
                "networkAttachmentName": "cloudservices",
                "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
                "ipAllocationMethod": "Dynamic",
                "ipv4Address": "169.254.8.4",
                "macAddress": "aa:bb:cc:06:79:2a",
                "defaultGateway": "False"
              },
              {
                "networkAttachmentName": "defaultcni",
                "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
                "ipAllocationMethod": "Dynamic",
                "ipv4Address": "10.14.48.12",
                "ipv6Address": "fda0:d59c:da0a:e30::a",
                "macAddress": "aa:bb:cc:ad:40:cf",
                "defaultGateway": "False"
              }
            ],
            "powerState": "On",
            "role": "Worker",
            "taints": [
              {
                "key": "kubernetes.taint",
                "value": "true:NoSchedule"
              }
            ],
            "vmSkuName": "NC_P46_224_v1"
          },
          {
            "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
            "cpuCores": 6,
            "detailedStatus": "Running",
            "detailedStatusMessage": "Running - virtual machine is running.",
            "diskSizeGB": 300,
            "image": "mariner-guest-image-qcow2-k8s-1.XX.Y",
            "kubernetesVersion": "v1.XX.Y",
            "memorySizeGB": 28,
            "name": "kubernetesClusterName-control-plane-7nsh2",
            "networkAttachments": [
              {
                "networkAttachmentName": "cloudservices",
                "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
                "ipAllocationMethod": "Dynamic",
                "ipv4Address": "169.254.8.2",
                "macAddress": "aa:bb:cc:fa:91:71",
                "defaultGateway": "False"
              },
              {
                "networkAttachmentName": "defaultcni",
                "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
                "ipAllocationMethod": "Dynamic",
                "ipv4Address": "10.14.48.11",
                "ipv6Address": "fda0:d59c:da0a:e30::9",
                "macAddress": "aa:bb:cc:c8:a2:40",
                "defaultGateway": "False"
              }
            ],
            "powerState": "On",
            "role": "ControlPlane",
            "vmSkuName": "NC_G6_28_v1"
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AadConfiguration	AadConfiguration represents the Azure Active Directory Integration properties.
AdministratorConfiguration	AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters.
AdvertiseToFabric	The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.
AgentOptions	AgentOptions are configurations that will be applied to each agent in an agent pool.
AgentPoolMode	The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
AgentPoolUpgradeSettings	AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.
AttachedNetworkConfiguration	AttachedNetworkConfiguration represents the set of workload networks to attach to a resource.
AvailabilityLifecycle	The version lifecycle indicator.
AvailableUpgrade	AvailableUpgrade represents an upgrade available for a Kubernetes cluster.
BfdEnabled	The indicator of BFD enablement for this BgpPeer.
BgpAdvertisement	BgpAdvertisement represents the association of IP address pools to the communities and peers.
BgpMultiHop	The indicator to enable multi-hop peering support.
BgpServiceLoadBalancerConfiguration	BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer.
ControlPlaneNodeConfiguration	ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster.
createdByType	The type of identity that created the resource.
DefaultGateway	The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created.
FabricPeeringEnabled	The indicator to specify if the load balancer peers with the network fabric.
FeatureDetailedStatus	The status representing the state of this feature.
FeatureStatus	FeatureStatus contains information regarding a Kubernetes cluster feature.
HugepagesSize	The size of the hugepages to allocate.
InitialAgentPoolConfiguration	InitialAgentPoolConfiguration specifies the configuration of a pool of virtual machines that are initially defined with a Kubernetes cluster.
IpAddressPool	IpAddressPool represents a pool of IP addresses that can be allocated to a service.
KubernetesCluster	KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.
KubernetesClusterDetailedStatus	The current status of the Kubernetes cluster.
KubernetesClusterList	KubernetesClusterList represents a list of Kubernetes clusters.
KubernetesClusterNode	KubernetesClusterNode represents the details of a node in a Kubernetes cluster.
KubernetesClusterNodeDetailedStatus	The detailed state of this node.
KubernetesClusterProvisioningState	The provisioning state of the Kubernetes cluster resource.
KubernetesLabel	KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod.
KubernetesNodePowerState	The power state of this node.
KubernetesNodeRole	The role of this node in the cluster.
KubernetesPluginType	The indicator of how this network will be utilized by the Kubernetes cluster.
L2NetworkAttachmentConfiguration	L2NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 2 network.
L2ServiceLoadBalancerConfiguration	L2ServiceLoadBalancerConfiguration represents the configuration of a layer 2 service load balancer.
L3NetworkAttachmentConfiguration	L3NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 3 network.
L3NetworkConfigurationIpamEnabled	The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.
NetworkAttachment	NetworkAttachment represents the single network attachment.
NetworkConfiguration	NetworkConfiguration specifies the Kubernetes cluster network related configuration.
ServiceLoadBalancerBgpPeer	ServiceLoadBalancerBgpPeer represents the configuration of the BGP service load balancer for the Kubernetes cluster.
SshPublicKey	SshPublicKey represents the public key used to authenticate with a resource through SSH.
systemData	Metadata pertaining to creation and last modification of the resource.
TrunkedNetworkAttachmentConfiguration	TrunkedNetworkAttachmentConfiguration represents the configuration of the attachment of a trunked network.
VirtualMachineIPAllocationMethod	The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.

AadConfiguration

Object

AadConfiguration represents the Azure Active Directory Integration properties.

Name	Type	Description
adminGroupObjectIds	string[]	The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster.

AdministratorConfiguration

Object

AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters.

Name	Type	Description
adminUsername	string	The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
sshPublicKeys	SshPublicKey[]	The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.

AdvertiseToFabric

Enumeration

The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.

Value	Description
True
False

AgentOptions

Object

AgentOptions are configurations that will be applied to each agent in an agent pool.

Name	Type	Default value	Description
hugepagesCount	integer (int64)		The number of hugepages to allocate.
hugepagesSize	HugepagesSize	2M	The size of the hugepages to allocate.

AgentPoolMode

Enumeration

The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.

Value	Description
System
User
NotApplicable

AgentPoolUpgradeSettings

Object

AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.

Name	Type	Description
drainTimeout	integer (int64) minimum: 60 maximum: 86400	The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.
maxSurge	string	The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.
maxUnavailable	string	The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.

AttachedNetworkConfiguration

Object

AttachedNetworkConfiguration represents the set of workload networks to attach to a resource.

Name	Type	Description
l2Networks	L2NetworkAttachmentConfiguration[]	The list of Layer 2 Networks and related configuration for attachment.
l3Networks	L3NetworkAttachmentConfiguration[]	The list of Layer 3 Networks and related configuration for attachment.
trunkedNetworks	TrunkedNetworkAttachmentConfiguration[]	The list of Trunked Networks and related configuration for attachment.

AvailabilityLifecycle

Enumeration

The version lifecycle indicator.

Value	Description
Preview
GenerallyAvailable

AvailableUpgrade

Object

AvailableUpgrade represents an upgrade available for a Kubernetes cluster.

Name	Type	Description
availabilityLifecycle	AvailabilityLifecycle	The version lifecycle indicator.
version	string	The version available for upgrading.

BfdEnabled

Enumeration

The indicator of BFD enablement for this BgpPeer.

Value	Description
True
False

BgpAdvertisement

Object

BgpAdvertisement represents the association of IP address pools to the communities and peers.

Name	Type	Default value	Description
advertiseToFabric	AdvertiseToFabric	True	The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.
communities	string[]		The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format.
ipAddressPools	string[]		The names of the IP address pools associated with this announcement.
peers	string[]		The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement.

BgpMultiHop

Enumeration

The indicator to enable multi-hop peering support.

Value	Description
True
False

BgpServiceLoadBalancerConfiguration

Object

BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer.

Name	Type	Default value	Description
bgpAdvertisements	BgpAdvertisement[]		The association of IP address pools to the communities and peers, allowing for announcement of IPs.
bgpPeers	ServiceLoadBalancerBgpPeer[]		The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined.
fabricPeeringEnabled	FabricPeeringEnabled	True	The indicator to specify if the load balancer peers with the network fabric.
ipAddressPools	IpAddressPool[]		The list of pools of IP addresses that can be allocated to load balancer services.

ControlPlaneNodeConfiguration

Object

ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster.

Name	Type	Description
administratorConfiguration	AdministratorConfiguration	AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters. The administrator credentials to be used for the nodes in the control plane.
availabilityZones	string[]	The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used.
count	integer (int64) minimum: 1	The number of virtual machines that use this configuration.
vmSkuName	string	The name of the VM SKU supplied during creation.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DefaultGateway

Enumeration

The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.

Value	Description
True
False

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.

ExtendedLocation

Object

ExtendedLocation represents the Azure custom location where the resource will be created.

Name	Type	Description
name	string	The resource ID of the extended location on which the resource will be created.
type	string	The extended location type, for example, CustomLocation.

FabricPeeringEnabled

Enumeration

The indicator to specify if the load balancer peers with the network fabric.

Value	Description
True
False

FeatureDetailedStatus

Enumeration

The status representing the state of this feature.

Value	Description
Running
Failed
Unknown

FeatureStatus

Object

FeatureStatus contains information regarding a Kubernetes cluster feature.

Name	Type	Description
detailedStatus	FeatureDetailedStatus	The status representing the state of this feature.
detailedStatusMessage	string	The descriptive message about the current detailed status.
name	string	The name of the feature.
version	string	The version of the feature.

HugepagesSize

Enumeration

The size of the hugepages to allocate.

Value	Description
2M
1G

InitialAgentPoolConfiguration

Object

InitialAgentPoolConfiguration specifies the configuration of a pool of virtual machines that are initially defined with a Kubernetes cluster.

Name	Type	Description
administratorConfiguration	AdministratorConfiguration	AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters. The administrator credentials to be used for the nodes in this agent pool.
agentOptions	AgentOptions	AgentOptions are configurations that will be applied to each agent in an agent pool. The configurations that will be applied to each agent in this agent pool.
attachedNetworkConfiguration	AttachedNetworkConfiguration	AttachedNetworkConfiguration represents the set of workload networks to attach to a resource. The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
availabilityZones	string[]	The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
count	integer (int64)	The number of virtual machines that use this configuration.
labels	KubernetesLabel[]	The labels applied to the nodes in this agent pool.
mode	AgentPoolMode	The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
name	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	The name that will be used for the agent pool resource representing this agent pool.
taints	KubernetesLabel[]	The taints applied to the nodes in this agent pool.
upgradeSettings	AgentPoolUpgradeSettings	AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool. The configuration of the agent pool.
vmSkuName	string	The name of the VM SKU that determines the size of resources allocated for node VMs.

IpAddressPool

Object

IpAddressPool represents a pool of IP addresses that can be allocated to a service.

Name	Type	Default value	Description
addresses	string[]		The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes.
autoAssign	BfdEnabled	True	The indicator to determine if automatic allocation from the pool should occur.
name	string pattern: ^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$		The name used to identify this IP address pool for association with a BGP advertisement.
onlyUseHostIps	BfdEnabled	True	The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive.

KubernetesCluster

Object

KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.

Name	Type	Description
extendedLocation	ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created. The extended location of the cluster associated with the resource.
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.aadConfiguration	AadConfiguration	AadConfiguration represents the Azure Active Directory Integration properties. The Azure Active Directory Integration properties.
properties.administratorConfiguration	AdministratorConfiguration	AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters. The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values.
properties.attachedNetworkIds	string[]	The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.
properties.availableUpgrades	AvailableUpgrade[]	The list of versions that this Kubernetes cluster can be upgraded to.
properties.clusterId	string (arm-id)	The resource ID of the Network Cloud cluster.
properties.connectedClusterId	string (arm-id)	The resource ID of the connected cluster set up when this Kubernetes cluster is created.
properties.controlPlaneKubernetesVersion	string	The current running version of Kubernetes on the control plane.
properties.controlPlaneNodeConfiguration	ControlPlaneNodeConfiguration	ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster. The defining characteristics of the control plane for this Kubernetes Cluster.
properties.detailedStatus	KubernetesClusterDetailedStatus	The current status of the Kubernetes cluster.
properties.detailedStatusMessage	string	The descriptive message about the current detailed status.
properties.featureStatuses	FeatureStatus[]	The current feature settings.
properties.initialAgentPoolConfigurations	InitialAgentPoolConfiguration[]	The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.
properties.kubernetesVersion	string	The Kubernetes version for this cluster.
properties.managedResourceGroupConfiguration	ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure. The configuration of the managed resource group associated with the resource.
properties.networkConfiguration	NetworkConfiguration	NetworkConfiguration specifies the Kubernetes cluster network related configuration. The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.
properties.nodes	KubernetesClusterNode[]	The details of the nodes in this cluster.
properties.provisioningState	KubernetesClusterProvisioningState	The provisioning state of the Kubernetes cluster resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

KubernetesClusterDetailedStatus

Enumeration

The current status of the Kubernetes cluster.

Value	Description
Available
Error
Provisioning

KubernetesClusterList

Object

KubernetesClusterList represents a list of Kubernetes clusters.

Name	Type	Description
nextLink	string	The link used to get the next page of operations.
value	KubernetesCluster[]	The list of additional details related to Kubernetes clusters.

KubernetesClusterNode

Object

KubernetesClusterNode represents the details of a node in a Kubernetes cluster.

Name	Type	Description
agentPoolId	string (arm-id)	The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes.
availabilityZone	string	The availability zone this node is running within.
bareMetalMachineId	string (arm-id)	The resource ID of the bare metal machine that hosts this node.
cpuCores	integer (int64)	The number of CPU cores configured for this node, derived from the VM SKU specified.
detailedStatus	KubernetesClusterNodeDetailedStatus	The detailed state of this node.
detailedStatusMessage	string	The descriptive message about the current detailed status.
diskSizeGB	integer (int64)	The size of the disk configured for this node. Allocations are measured in gibibytes.
image	string	The machine image used to deploy this node.
kubernetesVersion	string	The currently running version of Kubernetes and bundled features running on this node.
labels	KubernetesLabel[]	The list of labels on this node that have been assigned to the agent pool containing this node.
memorySizeGB	integer (int64)	The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes.
mode	AgentPoolMode	The mode of the agent pool containing this node. Not applicable for control plane nodes.
name	string	The name of this node, as realized in the Kubernetes cluster.
networkAttachments	NetworkAttachment[]	The NetworkAttachments made to this node.
powerState	KubernetesNodePowerState	The power state of this node.
role	KubernetesNodeRole	The role of this node in the cluster.
taints	KubernetesLabel[]	The list of taints that have been assigned to the agent pool containing this node.
vmSkuName	string	The VM SKU name that was used to create this cluster node.

KubernetesClusterNodeDetailedStatus

Enumeration

The detailed state of this node.

Value	Description
Available
Error
Provisioning
Running
Scheduling
Stopped
Terminating
Unknown

KubernetesClusterProvisioningState

Enumeration

The provisioning state of the Kubernetes cluster resource.

Value	Description
Succeeded
Failed
Canceled
Accepted
InProgress
Created
Updating
Deleting

KubernetesLabel

Object

KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod.

Name	Type	Description
key	string	The name of the label or taint.
value	string	The value of the label or taint.

KubernetesNodePowerState

Enumeration

The power state of this node.

Value	Description
On
Off
Unknown

KubernetesNodeRole

Enumeration

The role of this node in the cluster.

Value	Description
ControlPlane
Worker

KubernetesPluginType

Enumeration

The indicator of how this network will be utilized by the Kubernetes cluster.

Value	Description
DPDK
SRIOV
OSDevice
MACVLAN
IPVLAN

L2NetworkAttachmentConfiguration

Object

L2NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 2 network.

Name	Type	Default value	Description
networkId	string (arm-id)		The resource ID of the network that is being configured for attachment.
pluginType	KubernetesPluginType	SRIOV	The indicator of how this network will be utilized by the Kubernetes cluster.

L2ServiceLoadBalancerConfiguration

Object

L2ServiceLoadBalancerConfiguration represents the configuration of a layer 2 service load balancer.

Name	Type	Description
ipAddressPools	IpAddressPool[]	The list of pools of IP addresses that can be allocated to load balancer services.

L3NetworkAttachmentConfiguration

Object

L3NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 3 network.

Name	Type	Default value	Description
ipamEnabled	L3NetworkConfigurationIpamEnabled	False	The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
networkId	string (arm-id)		The resource ID of the network that is being configured for attachment.
pluginType	KubernetesPluginType	SRIOV	The indicator of how this network will be utilized by the Kubernetes cluster.

L3NetworkConfigurationIpamEnabled

Enumeration

The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.

Value	Description
True
False

ManagedResourceGroupConfiguration

Object

ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.

Name	Type	Description
location	string	The location of the managed resource group. If not specified, the location of the parent resource is chosen.
name	string maxLength: 75	The name for the managed resource group. If not specified, the unique name is automatically generated.

NetworkAttachment

Object

NetworkAttachment represents the single network attachment.

Name	Type	Description
attachedNetworkId	string (arm-id)	The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.
defaultGateway	DefaultGateway	The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
ipAllocationMethod	VirtualMachineIPAllocationMethod	The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
ipv4Address	string	The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.
ipv6Address	string	The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.
macAddress	string	The MAC address of the interface for the virtual machine that corresponds to this network attachment.
networkAttachmentName	string maxLength: 15	The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.

NetworkConfiguration

Object

NetworkConfiguration specifies the Kubernetes cluster network related configuration.

Name	Type	Description
attachedNetworkConfiguration	AttachedNetworkConfiguration	AttachedNetworkConfiguration represents the set of workload networks to attach to a resource. The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster.
bgpServiceLoadBalancerConfiguration	BgpServiceLoadBalancerConfiguration	BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer. The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP.
cloudServicesNetworkId	string (arm-id)	The resource ID of the associated Cloud Services network.
cniNetworkId	string (arm-id)	The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network.
dnsServiceIp	string	The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR.
l2ServiceLoadBalancerConfiguration	L2ServiceLoadBalancerConfiguration	L2ServiceLoadBalancerConfiguration represents the configuration of a layer 2 service load balancer. The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP.
podCidrs	string[]	The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.
serviceCidrs	string[]	The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

ServiceLoadBalancerBgpPeer

Object

ServiceLoadBalancerBgpPeer represents the configuration of the BGP service load balancer for the Kubernetes cluster.

Name	Type	Default value	Description
bfdEnabled	BfdEnabled	False	The indicator of BFD enablement for this BgpPeer.
bgpMultiHop	BgpMultiHop	False	The indicator to enable multi-hop peering support.
holdTime	string		Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H.
keepAliveTime	string		Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H.
myAsn	integer (int64) minimum: 0 maximum: 4294967295		The autonomous system number used for the local end of the BGP session.
name	string pattern: ^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$		The name used to identify this BGP peer for association with a BGP advertisement.
password	string maxLength: 80 pattern: ^[a-zA-Z0-9]{0,80}$		The authentication password for routers enforcing TCP MD5 authenticated sessions.
peerAddress	string		The IPv4 or IPv6 address used to connect this BGP session.
peerAsn	integer (int64) minimum: 0 maximum: 4294967295		The autonomous system number expected from the remote end of the BGP session.
peerPort	integer (int64)	179	The port used to connect this BGP session.

SshPublicKey

Object

SshPublicKey represents the public key used to authenticate with a resource through SSH.

Name	Type	Description
keyData	string minLength: 1	The SSH public key data.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.

TrunkedNetworkAttachmentConfiguration

Object

TrunkedNetworkAttachmentConfiguration represents the configuration of the attachment of a trunked network.

Name	Type	Default value	Description
networkId	string (arm-id)		The resource ID of the network that is being configured for attachment.
pluginType	KubernetesPluginType	SRIOV	The indicator of how this network will be utilized by the Kubernetes cluster.

VirtualMachineIPAllocationMethod

Enumeration

The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.

Value	Description
Dynamic
Static
Disabled