Agent Pools - Create Or Update

Service:

Operator Nexus - Network Cloud

API Version:

2024-07-01

Create or update the Kubernetes cluster agent pool.
Create a new Kubernetes cluster agent pool or update the properties of the existing one.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
agentPoolName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	The name of the Kubernetes cluster agent pool.
kubernetesClusterName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	The name of the Kubernetes cluster.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
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.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.count	True	integer (int64)	The number of virtual machines that use this configuration.
properties.mode	True	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.
properties.vmSkuName	True	string	The name of the VM SKU that determines the size of resources allocated for node VMs.
extendedLocation		ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created. The extended location of the cluster associated with the resource.
properties.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.
properties.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.
properties.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.
properties.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.
properties.labels		KubernetesLabel[]	The labels applied to the nodes in this agent pool.
properties.taints		KubernetesLabel[]	The taints applied to the nodes in this agent pool.
properties.upgradeSettings		AgentPoolUpgradeSettings	AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool. The configuration of the agent pool.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	AgentPool	The resource has been successfully created or updated.
201 Created	AgentPool	The resource has been accepted for creation or update. Headers Azure-AsyncOperation: string
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

Create or update Kubernetes cluster agent pool

Sample request

HTTP

PUT https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName?api-version=2024-07-01

{
  "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": {
    "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"
  }
}

Java

import com.azure.resourcemanager.networkcloud.models.AdministratorConfiguration;
import com.azure.resourcemanager.networkcloud.models.AgentOptions;
import com.azure.resourcemanager.networkcloud.models.AgentPoolMode;
import com.azure.resourcemanager.networkcloud.models.AgentPoolUpgradeSettings;
import com.azure.resourcemanager.networkcloud.models.AttachedNetworkConfiguration;
import com.azure.resourcemanager.networkcloud.models.ExtendedLocation;
import com.azure.resourcemanager.networkcloud.models.HugepagesSize;
import com.azure.resourcemanager.networkcloud.models.KubernetesLabel;
import com.azure.resourcemanager.networkcloud.models.KubernetesPluginType;
import com.azure.resourcemanager.networkcloud.models.L2NetworkAttachmentConfiguration;
import com.azure.resourcemanager.networkcloud.models.L3NetworkAttachmentConfiguration;
import com.azure.resourcemanager.networkcloud.models.L3NetworkConfigurationIpamEnabled;
import com.azure.resourcemanager.networkcloud.models.SshPublicKey;
import com.azure.resourcemanager.networkcloud.models.TrunkedNetworkAttachmentConfiguration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for AgentPools CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Create.
     * json
     */
    /**
     * Sample code: Create or update Kubernetes cluster agent pool.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void
        createOrUpdateKubernetesClusterAgentPool(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.agentPools().define("agentPoolName").withRegion("location")
            .withExistingKubernetesCluster("resourceGroupName", "kubernetesClusterName").withCount(3L)
            .withMode(AgentPoolMode.SYSTEM).withVmSkuName("NC_P46_224_v1")
            .withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder"))
            .withExtendedLocation(new ExtendedLocation().withName(
                "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName")
                .withType("CustomLocation"))
            .withAdministratorConfiguration(new AdministratorConfiguration().withAdminUsername("azure")
                .withSshPublicKeys(Arrays.asList(new SshPublicKey().withKeyData("fakeTokenPlaceholder"))))
            .withAgentOptions(new AgentOptions().withHugepagesCount(96L).withHugepagesSize(HugepagesSize.ONEG))
            .withAttachedNetworkConfiguration(new AttachedNetworkConfiguration()
                .withL2Networks(Arrays.asList(new L2NetworkAttachmentConfiguration().withNetworkId(
                    "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName")
                    .withPluginType(KubernetesPluginType.DPDK)))
                .withL3Networks(Arrays.asList(new L3NetworkAttachmentConfiguration()
                    .withIpamEnabled(L3NetworkConfigurationIpamEnabled.FALSE)
                    .withNetworkId(
                        "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName")
                    .withPluginType(KubernetesPluginType.SRIOV)))
                .withTrunkedNetworks(Arrays.asList(new TrunkedNetworkAttachmentConfiguration().withNetworkId(
                    "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName")
                    .withPluginType(KubernetesPluginType.MACVLAN))))
            .withAvailabilityZones(Arrays.asList("1", "2", "3"))
            .withLabels(Arrays.asList(new KubernetesLabel().withKey("fakeTokenPlaceholder").withValue("true")))
            .withTaints(
                Arrays.asList(new KubernetesLabel().withKey("fakeTokenPlaceholder").withValue("true:NoSchedule")))
            .withUpgradeSettings(new AgentPoolUpgradeSettings().withMaxSurge("1")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python agent_pools_create.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.agent_pools.begin_create_or_update(
        resource_group_name="resourceGroupName",
        kubernetes_cluster_name="kubernetesClusterName",
        agent_pool_name="agentPoolName",
        agent_pool_parameters={
            "extendedLocation": {
                "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
                "type": "CustomLocation",
            },
            "location": "location",
            "properties": {
                "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": [
                        {
                            "ipamEnabled": "False",
                            "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
                            "pluginType": "SRIOV",
                        }
                    ],
                    "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",
            },
            "tags": {"key1": "myvalue1", "key2": "myvalue2"},
        },
    ).result()
    print(response)


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

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/AgentPools_Create.json
func ExampleAgentPoolsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewAgentPoolsClient().BeginCreateOrUpdate(ctx, "resourceGroupName", "kubernetesClusterName", "agentPoolName", armnetworkcloud.AgentPool{
		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.AgentPoolProperties{
			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"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AgentPool = armnetworkcloud.AgentPool{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.NetworkCloud/kubernetesClusters/agentPools"),
	// 	ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName"),
	// 	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.AgentPoolProperties{
	// 		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),
	// 			DetailedStatus: to.Ptr(armnetworkcloud.AgentPoolDetailedStatusAvailable),
	// 			DetailedStatusMessage: to.Ptr("Agent pool is available"),
	// 			KubernetesVersion: to.Ptr("1.XX.Y"),
	// 			Labels: []*armnetworkcloud.KubernetesLabel{
	// 				{
	// 					Key: to.Ptr("kubernetes.label"),
	// 					Value: to.Ptr("true"),
	// 			}},
	// 			Mode: to.Ptr(armnetworkcloud.AgentPoolModeSystem),
	// 			ProvisioningState: to.Ptr(armnetworkcloud.AgentPoolProvisioningStateSucceeded),
	// 			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"),
	// 		},
	// 	}
}

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 { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Create a new Kubernetes cluster agent pool or update the properties of the existing one.
 *
 * @summary Create a new Kubernetes cluster agent pool or update the properties of the existing one.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Create.json
 */
async function createOrUpdateKubernetesClusterAgentPool() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const resourceGroupName = process.env["NETWORKCLOUD_RESOURCE_GROUP"] || "resourceGroupName";
  const kubernetesClusterName = "kubernetesClusterName";
  const agentPoolName = "agentPoolName";
  const agentPoolParameters = {
    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: [
        {
          ipamEnabled: "False",
          networkId:
            "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
          pluginType: "SRIOV",
        },
      ],
      trunkedNetworks: [
        {
          networkId:
            "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName",
          pluginType: "MACVLAN",
        },
      ],
    },
    availabilityZones: ["1", "2", "3"],
    count: 3,
    extendedLocation: {
      name: "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
      type: "CustomLocation",
    },
    labels: [{ key: "kubernetes.label", value: "true" }],
    location: "location",
    mode: "System",
    tags: { key1: "myvalue1", key2: "myvalue2" },
    taints: [{ key: "kubernetes.taint", value: "true:NoSchedule" }],
    upgradeSettings: { maxSurge: "1" },
    vmSkuName: "NC_P46_224_v1",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const result = await client.agentPools.beginCreateOrUpdateAndWait(
    resourceGroupName,
    kubernetesClusterName,
    agentPoolName,
    agentPoolParameters,
  );
  console.log(result);
}

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

dotnet

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

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Create.json
// this example is just showing the usage of "AgentPools_CreateOrUpdate" 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 NetworkCloudKubernetesClusterResource created on azure
// for more information of creating NetworkCloudKubernetesClusterResource, please refer to the document of NetworkCloudKubernetesClusterResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
string resourceGroupName = "resourceGroupName";
string kubernetesClusterName = "kubernetesClusterName";
ResourceIdentifier networkCloudKubernetesClusterResourceId = NetworkCloudKubernetesClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, kubernetesClusterName);
NetworkCloudKubernetesClusterResource networkCloudKubernetesCluster = client.GetNetworkCloudKubernetesClusterResource(networkCloudKubernetesClusterResourceId);

// get the collection of this NetworkCloudAgentPoolResource
NetworkCloudAgentPoolCollection collection = networkCloudKubernetesCluster.GetNetworkCloudAgentPools();

// invoke the operation
string agentPoolName = "agentPoolName";
NetworkCloudAgentPoolData data = new NetworkCloudAgentPoolData(new AzureLocation("location"), 3L, NetworkCloudAgentPoolMode.System, "NC_P46_224_v1")
{
    ExtendedLocation = new ExtendedLocation("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName", "CustomLocation"),
    AdministratorConfiguration = new AdministratorConfiguration
    {
        AdminUsername = "azure",
        SshPublicKeys = { new NetworkCloudSshPublicKey("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm") },
    },
    AgentOptions = new NetworkCloudAgentConfiguration(96L)
    {
        HugepagesSize = HugepagesSize.OneG,
    },
    AttachedNetworkConfiguration = new AttachedNetworkConfiguration
    {
        L2Networks = {new L2NetworkAttachmentConfiguration(new ResourceIdentifier("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName"))
        {
        PluginType = KubernetesPluginType.Dpdk,
        }},
        L3Networks = {new L3NetworkAttachmentConfiguration(new ResourceIdentifier("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"))
        {
        IpamEnabled = L3NetworkConfigurationIpamEnabled.False,
        PluginType = KubernetesPluginType.Sriov,
        }},
        TrunkedNetworks = {new TrunkedNetworkAttachmentConfiguration(new ResourceIdentifier("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName"))
        {
        PluginType = KubernetesPluginType.Macvlan,
        }},
    },
    AvailabilityZones = { "1", "2", "3" },
    Labels = { new KubernetesLabel("kubernetes.label", "true") },
    Taints = { new KubernetesLabel("kubernetes.taint", "true:NoSchedule") },
    UpgradeSettings = new AgentPoolUpgradeSettings
    {
        MaxSurge = "1",
    },
    Tags =
    {
    ["key1"] = "myvalue1",
    ["key2"] = "myvalue2"
    },
};
ArmOperation<NetworkCloudAgentPoolResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, agentPoolName, data);
NetworkCloudAgentPoolResource result = lro.Value;

// the variable result 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
NetworkCloudAgentPoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName",
  "name": "default",
  "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/agentPools",
  "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": {
    "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",
    "provisioningState": "Succeeded",
    "kubernetesVersion": "1.XX.Y",
    "detailedStatus": "Available",
    "detailedStatusMessage": "Agent pool is available"
  }
}

Status code:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName",
  "name": "default",
  "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/agentPools",
  "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": {
    "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",
    "provisioningState": "Accepted",
    "kubernetesVersion": "1.XX.Y",
    "detailedStatus": "Available",
    "detailedStatusMessage": "Agent pool is available"
  }
}

Definitions

Name	Description
AdministratorConfiguration	AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters.
AgentOptions	AgentOptions are configurations that will be applied to each agent in an agent pool.
AgentPool	AgentPool represents the agent pool of Kubernetes cluster.
AgentPoolDetailedStatus	The current status of the 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.
AgentPoolProvisioningState	The provisioning state of the agent pool.
AgentPoolUpgradeSettings	AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.
AttachedNetworkConfiguration	AttachedNetworkConfiguration represents the set of workload networks to attach to a resource.
createdByType	The type of identity that created the resource.
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.
HugepagesSize	The size of the hugepages to allocate.
KubernetesLabel	KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod.
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.
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.
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.

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.

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.

AgentPool

Object

AgentPool represents the agent pool of Kubernetes cluster.

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.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.
properties.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.
properties.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.
properties.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.
properties.count	integer (int64)	The number of virtual machines that use this configuration.
properties.detailedStatus	AgentPoolDetailedStatus	The current status of the agent pool.
properties.detailedStatusMessage	string	The descriptive message about the current detailed status.
properties.kubernetesVersion	string	The Kubernetes version running in this agent pool.
properties.labels	KubernetesLabel[]	The labels applied to the nodes in this agent pool.
properties.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.
properties.provisioningState	AgentPoolProvisioningState	The provisioning state of the agent pool.
properties.taints	KubernetesLabel[]	The taints applied to the nodes in this agent pool.
properties.upgradeSettings	AgentPoolUpgradeSettings	AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool. The configuration of the agent pool.
properties.vmSkuName	string	The name of the VM SKU that determines the size of resources allocated for node VMs.
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"

AgentPoolDetailedStatus

Enumeration

The current status of the agent pool.

Value	Description
Available
Error
Provisioning

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

AgentPoolProvisioningState

Enumeration

The provisioning state of the agent pool.

Value	Description
Accepted
Canceled
Deleting
Failed
InProgress
Succeeded
Updating

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

HugepagesSize

Enumeration

The size of the hugepages to allocate.

Value	Description
2M
1G

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.

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.

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

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.