Kubernetes Clusters - List By Subscription

Servicio:

Operator Nexus - Network Cloud

Versión de la API:

2023-07-01

Enumeración de clústeres de Kubernetes en la suscripción.
Obtenga una lista de clústeres de Kubernetes en la suscripción proporcionada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	KubernetesClusterList	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List Kubernetes clusters for subscription

Solicitud de ejemplo

HTTP

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

Java

/** Samples for KubernetesClusters List. */
public final class Main {
    /*
     * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-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

Python

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/2023-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

Go

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/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-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.24.13-1"),
		// 						}},
		// 						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.24.12-1"),
		// 						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_G4_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"),
		// 										}},
		// 										UpgradeSettings: &armnetworkcloud.AgentPoolUpgradeSettings{
		// 											MaxSurge: to.Ptr("1"),
		// 										},
		// 										VMSKUName: to.Ptr("NC_M16_v1"),
		// 								}},
		// 								KubernetesVersion: to.Ptr("1.24.12-1"),
		// 								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("machine1"),
		// 																AgentPoolID: to.Ptr("pool1"),
		// 																AvailabilityZone: to.Ptr("1"),
		// 																BareMetalMachineID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName"),
		// 																CPUCores: to.Ptr[int64](20),
		// 																DetailedStatus: to.Ptr(armnetworkcloud.KubernetesClusterNodeDetailedStatusAvailable),
		// 																DetailedStatusMessage: to.Ptr("No issues detected"),
		// 																DiskSizeGB: to.Ptr[int64](120),
		// 																Image: to.Ptr("myacr.azurecr.io/foobar:latest"),
		// 																KubernetesVersion: to.Ptr("1.24.12-1"),
		// 																Labels: []*armnetworkcloud.KubernetesLabel{
		// 																	{
		// 																		Key: to.Ptr("kubernetes.label"),
		// 																		Value: to.Ptr("true"),
		// 																}},
		// 																MemorySizeGB: to.Ptr[int64](256),
		// 																Mode: to.Ptr(armnetworkcloud.AgentPoolModeSystem),
		// 																NetworkAttachments: []*armnetworkcloud.NetworkAttachment{
		// 																	{
		// 																		AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 																		DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayTrue),
		// 																		IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 																		IPv4Address: to.Ptr("198.51.100.1"),
		// 																		IPv6Address: to.Ptr("2001:0db8:0000:0000:0000:0000:0000:0000"),
		// 																		MacAddress: to.Ptr("bf:1c:29:31:31:1f"),
		// 																		NetworkAttachmentName: to.Ptr("netAttachName01"),
		// 																}},
		// 																PowerState: to.Ptr(armnetworkcloud.KubernetesNodePowerStateOn),
		// 																Role: to.Ptr(armnetworkcloud.KubernetesNodeRoleControlPlane),
		// 																Taints: []*armnetworkcloud.KubernetesLabel{
		// 																	{
		// 																		Key: to.Ptr("kubernetes.taint"),
		// 																		Value: to.Ptr("true"),
		// 																}},
		// 																VMSKUName: to.Ptr("NC_M16_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

JavaScript

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

/**
 * 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/2023-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 (let 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

dotnet

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

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-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

Respuesta de muestra

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"
              }
            ],
            "upgradeSettings": {
              "maxSurge": "1"
            },
            "vmSkuName": "NC_M16_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_G4_v1"
        },
        "kubernetesVersion": "1.24.12-1",
        "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.24.13-1",
            "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.24.12-1",
        "detailedStatus": "Available",
        "detailedStatusMessage": "Kubernetes cluster is operational",
        "featureStatuses": [
          {
            "name": "Feature1",
            "version": "1",
            "detailedStatus": "Running",
            "detailedStatusMessage": "No issues detected"
          }
        ],
        "nodes": [
          {
            "agentPoolId": "pool1",
            "availabilityZone": "1",
            "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
            "cpuCores": 20,
            "detailedStatus": "Available",
            "detailedStatusMessage": "No issues detected",
            "diskSizeGB": 120,
            "image": "myacr.azurecr.io/foobar:latest",
            "kubernetesVersion": "1.24.12-1",
            "labels": [
              {
                "key": "kubernetes.label",
                "value": "true"
              }
            ],
            "memorySizeGB": 256,
            "mode": "System",
            "name": "machine1",
            "networkAttachments": [
              {
                "networkAttachmentName": "netAttachName01",
                "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
                "ipAllocationMethod": "Dynamic",
                "ipv4Address": "198.51.100.1",
                "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
                "macAddress": "bf:1c:29:31:31:1f",
                "defaultGateway": "True"
              }
            ],
            "powerState": "On",
            "role": "ControlPlane",
            "taints": [
              {
                "key": "kubernetes.taint",
                "value": "true"
              }
            ],
            "vmSkuName": "NC_M16_v1"
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
AadConfiguration	AadConfiguration representa las propiedades de integración de Azure Active Directory.
AdministratorConfiguration	AdministratorConfiguration representa las credenciales administrativas que se aplicarán a los nodos del plano de control y del grupo de agentes en clústeres de Kubernetes.
AdvertiseToFabric	Indicador de si este anuncio también se realiza en el tejido de red asociado al clúster de nube de red. Este campo se omite si fabricPeeringEnabled está establecido en False.
AgentOptions	AgentOptions son configuraciones que se aplicarán a cada agente de un grupo de agentes.
AgentPoolMode	La selección de cómo se utiliza este grupo de agentes, ya sea como un grupo de sistemas o un grupo de usuarios. Los grupos de sistemas ejecutan las características y los servicios críticos para el clúster de Kubernetes, mientras que los grupos de usuarios están dedicados a las cargas de trabajo de usuario. Cada clúster de Kubernetes debe contener al menos un grupo de nodos del sistema con al menos un nodo.
AgentPoolUpgradeSettings	AgentPoolUpgradeSettings especifica la configuración de actualización de un grupo de agentes.
AttachedNetworkConfiguration	AttachedNetworkConfiguration representa el conjunto de redes de carga de trabajo que se van a asociar a un recurso.
AvailabilityLifecycle	Indicador del ciclo de vida de la versión.
AvailableUpgrade	AvailableUpgrade representa una actualización disponible para un clúster de Kubernetes.
BfdEnabled	Indicador de habilitación de BFD para este BgpPeer.
BgpAdvertisement	BgpAdvertisement representa la asociación de grupos de direcciones IP a las comunidades y compañeros.
BgpMultiHop	Indicador para habilitar la compatibilidad con el emparejamiento de varios saltos.
BgpServiceLoadBalancerConfiguration	BgpServiceLoadBalancerConfiguration representa la configuración de un equilibrador de carga de servicio BGP.
ControlPlaneNodeConfiguration	ControlPlaneNodeConfiguration representa la selección de máquinas virtuales y el tamaño del plano de control para un clúster de Kubernetes.
createdByType	Tipo de identidad que creó el recurso.
DefaultGateway	Indicador de si se trata de la puerta de enlace predeterminada. Solo se puede especificar una de las redes conectadas (incluidos los datos adjuntos de CloudServicesNetwork) para una sola máquina como True.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ExtendedLocation	ExtendedLocation representa la ubicación personalizada de Azure donde se creará el recurso.
FabricPeeringEnabled	Indicador que se especifica si el equilibrador de carga empareja con el tejido de red.
FeatureDetailedStatus	Estado que representa el estado de esta característica.
FeatureStatus	FeatureStatus contiene información sobre una característica de clúster de Kubernetes.
HugepagesSize	Tamaño de las enormes páginas que se van a asignar.
InitialAgentPoolConfiguration	InitialAgentPoolConfiguration especifica la configuración de un grupo de máquinas virtuales que se definen inicialmente con un clúster de Kubernetes.
IpAddressPool	IpAddressPool representa un grupo de direcciones IP que se pueden asignar a un servicio.
KubernetesCluster	KubernetesCluster representa el clúster de Kubernetes hospedado en la nube de red.
KubernetesClusterDetailedStatus	Estado actual del clúster de Kubernetes.
KubernetesClusterList	KubernetesClusterList representa una lista de clústeres de Kubernetes.
KubernetesClusterNode	KubernetesClusterNode representa los detalles de un nodo de un clúster de Kubernetes.
KubernetesClusterNodeDetailedStatus	Estado detallado de este nodo.
KubernetesClusterProvisioningState	Estado de aprovisionamiento del recurso de clúster de Kubernetes.
KubernetesLabel	KubernetesLabel representa una sola entrada para una etiqueta o taint de Kubernetes, como las usadas en un nodo o pod.
KubernetesNodePowerState	Estado de energía de este nodo.
KubernetesNodeRole	Rol de este nodo en el clúster.
KubernetesPluginType	Indicador de cómo usará esta red el clúster de Kubernetes.
L2NetworkAttachmentConfiguration	L2NetworkAttachmentConfiguration representa la configuración de los datos adjuntos de una red de nivel 2.
L3NetworkAttachmentConfiguration	L3NetworkAttachmentConfiguration representa la configuración de los datos adjuntos de una red de nivel 3.
L3NetworkConfigurationIpamEnabled	Indicación de si esta red realizará o no la administración de direcciones IP y asignará direcciones IP cuando se adjunte.
ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration representa la configuración del grupo de recursos administrado por Azure.
NetworkAttachment	NetworkAttachment representa los datos adjuntos de red únicos.
NetworkConfiguration	NetworkConfiguration especifica la configuración relacionada con la red del clúster de Kubernetes.
ServiceLoadBalancerBgpPeer	ServiceLoadBalancerBgpPeer representa la configuración del equilibrador de carga del servicio BGP para el clúster de Kubernetes.
SshPublicKey	SshPublicKey representa la clave pública que se usa para autenticarse con un recurso a través de SSH.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TrunkedNetworkAttachmentConfiguration	TrunkedNetworkAttachmentConfiguration representa la configuración de los datos adjuntos de una red troncal.
VirtualMachineIPAllocationMethod	Mecanismo de asignación de IP para la máquina virtual. Dinámicos y estáticos solo son válidos para l3Network que también pueden especificar Deshabilitado. De lo contrario, Disabled es el único valor permitido.

AadConfiguration

Object

AadConfiguration representa las propiedades de integración de Azure Active Directory.

Nombre	Tipo	Description
adminGroupObjectIds	string[]	Lista de identificadores de objeto de grupo de Azure Active Directory que tendrán un rol administrativo en el clúster de Kubernetes.

AdministratorConfiguration

Object

AdministratorConfiguration representa las credenciales administrativas que se aplicarán a los nodos del plano de control y del grupo de agentes en clústeres de Kubernetes.

Nombre	Tipo	Description
adminUsername	string	Nombre de usuario del administrador que se aplicará a los sistemas operativos que ejecutan nodos de Kubernetes. Si no se proporciona, el servicio elegirá un nombre de usuario.
sshPublicKeys	SshPublicKey[]	Configuración de SSH para los sistemas operativos que ejecutan los nodos en el clúster de Kubernetes. En algunos casos, es posible que se requiera la especificación de claves públicas para generar un entorno de trabajo.

AdvertiseToFabric

Enumeración

Indicador de si este anuncio también se realiza en el tejido de red asociado al clúster de nube de red. Este campo se omite si fabricPeeringEnabled está establecido en False.

Valor	Description
False
True

AgentOptions

Object

AgentOptions son configuraciones que se aplicarán a cada agente de un grupo de agentes.

Nombre	Tipo	Valor predeterminado	Description
hugepagesCount	integer (int64)		Número de enormes páginas que se van a asignar.
hugepagesSize	HugepagesSize	2M	Tamaño de las enormes páginas que se van a asignar.

AgentPoolMode

Enumeración

La selección de cómo se utiliza este grupo de agentes, ya sea como un grupo de sistemas o un grupo de usuarios. Los grupos de sistemas ejecutan las características y los servicios críticos para el clúster de Kubernetes, mientras que los grupos de usuarios están dedicados a las cargas de trabajo de usuario. Cada clúster de Kubernetes debe contener al menos un grupo de nodos del sistema con al menos un nodo.

Valor	Description
NotApplicable
System
User

AgentPoolUpgradeSettings

Object

AgentPoolUpgradeSettings especifica la configuración de actualización de un grupo de agentes.

Nombre	Tipo	Valor predeterminado	Description
maxSurge	string	1	Número máximo o porcentaje de nodos que se sobrecargan durante la actualización. Esto puede establecerse en un entero (por ejemplo, "5") o en un porcentaje (por ejemplo, "50%"). Si se especifica un porcentaje, es el porcentaje del tamaño total del grupo de agentes en el momento de la actualización. En porcentajes, los nodos fraccionarios se redondean hacia arriba. Si no se especifica, el valor predeterminado es 1.

AttachedNetworkConfiguration

Object

AttachedNetworkConfiguration representa el conjunto de redes de carga de trabajo que se van a asociar a un recurso.

Nombre	Tipo	Description
l2Networks	L2NetworkAttachmentConfiguration[]	Lista de redes de nivel 2 y configuración relacionada para los datos adjuntos.
l3Networks	L3NetworkAttachmentConfiguration[]	Lista de redes de nivel 3 y configuración relacionada para datos adjuntos.
trunkedNetworks	TrunkedNetworkAttachmentConfiguration[]	La lista de redes troncales y la configuración relacionada para los datos adjuntos.

AvailabilityLifecycle

Enumeración

Indicador del ciclo de vida de la versión.

Valor	Description
GenerallyAvailable
Preview

AvailableUpgrade

Object

AvailableUpgrade representa una actualización disponible para un clúster de Kubernetes.

Nombre	Tipo	Description
availabilityLifecycle	AvailabilityLifecycle	Indicador del ciclo de vida de la versión.
version	string	La versión disponible para actualizar.

BfdEnabled

Enumeración

Indicador de habilitación de BFD para este BgpPeer.

Valor	Description
False
True

BgpAdvertisement

Object

BgpAdvertisement representa la asociación de grupos de direcciones IP a las comunidades y compañeros.

Nombre	Tipo	Valor predeterminado	Description
advertiseToFabric	AdvertiseToFabric	True	Indicador de si este anuncio también se realiza en el tejido de red asociado al clúster de nube de red. Este campo se omite si fabricPeeringEnabled está establecido en False.
communities	string[]		Los nombres de las comunidades BGP que se asociarán al anuncio, utilizando una cadena de comunidad BGP en formato 1234:1234.
ipAddressPools	string[]		Los nombres de los grupos de direcciones IP asociados a este anuncio.
peers	string[]		Los nombres de los pares BGP a los que limitar este anuncio. Si no se especifica ningún valor, todos los pares BGP recibirán este anuncio.

BgpMultiHop

Enumeración

Indicador para habilitar la compatibilidad con el emparejamiento de varios saltos.

Valor	Description
False
True

BgpServiceLoadBalancerConfiguration

Object

BgpServiceLoadBalancerConfiguration representa la configuración de un equilibrador de carga de servicio BGP.

Nombre	Tipo	Valor predeterminado	Description
bgpAdvertisements	BgpAdvertisement[]		Asociación de grupos de direcciones IP a las comunidades y compañeros, lo que permite el anuncio de direcciones IP.
bgpPeers	ServiceLoadBalancerBgpPeer[]		Lista de entidades BgpPeer adicionales con las que se emparejará el clúster de Kubernetes. Todo el emparejamiento debe definirse explícitamente.
fabricPeeringEnabled	FabricPeeringEnabled	True	Indicador que se especifica si el equilibrador de carga empareja con el tejido de red.
ipAddressPools	IpAddressPool[]		Lista de grupos de direcciones IP que se pueden asignar a los servicios de Load Balancer.

ControlPlaneNodeConfiguration

Object

ControlPlaneNodeConfiguration representa la selección de máquinas virtuales y el tamaño del plano de control para un clúster de Kubernetes.

Nombre	Tipo	Description
administratorConfiguration	AdministratorConfiguration	AdministratorConfiguration representa las credenciales administrativas que se aplicarán a los nodos del plano de control y del grupo de agentes en clústeres de Kubernetes. Credenciales de administrador que se usarán para los nodos del plano de control.
availabilityZones	string[]	Lista de zonas de disponibilidad del clúster de nube de red que se va a usar para el aprovisionamiento de nodos en el plano de control. Si no se especifica, se usarán todas las zonas de disponibilidad.
count	integer (int64) minimum: 1	Número de máquinas virtuales que usan esta configuración.
vmSkuName	string	Nombre de la SKU de máquina virtual proporcionada durante la creación.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DefaultGateway

Enumeración

Indicador de si se trata de la puerta de enlace predeterminada. Solo se puede especificar una de las redes conectadas (incluidos los datos adjuntos de CloudServicesNetwork) para una sola máquina como True.

Valor	Description
False
True

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ExtendedLocation

Object

ExtendedLocation representa la ubicación personalizada de Azure donde se creará el recurso.

Nombre	Tipo	Description
name	string	Identificador de recurso de la ubicación extendida en la que se creará el recurso.
type	string	El tipo de ubicación extendida, por ejemplo, CustomLocation.

FabricPeeringEnabled

Enumeración

Indicador que se especifica si el equilibrador de carga empareja con el tejido de red.

Valor	Description
False
True

FeatureDetailedStatus

Enumeración

Estado que representa el estado de esta característica.

Valor	Description
Failed
Running
Unknown

FeatureStatus

Object

FeatureStatus contiene información sobre una característica de clúster de Kubernetes.

Nombre	Tipo	Description
detailedStatus	FeatureDetailedStatus	Estado que representa el estado de esta característica.
detailedStatusMessage	string	Mensaje descriptivo sobre el estado detallado actual.
name	string	Nombre de la característica.
version	string	Versión de la característica.

HugepagesSize

Enumeración

Tamaño de las enormes páginas que se van a asignar.

Valor	Description
1G
2M

InitialAgentPoolConfiguration

Object

InitialAgentPoolConfiguration especifica la configuración de un grupo de máquinas virtuales que se definen inicialmente con un clúster de Kubernetes.

Nombre	Tipo	Description
administratorConfiguration	AdministratorConfiguration	AdministratorConfiguration representa las credenciales administrativas que se aplicarán a los nodos del plano de control y del grupo de agentes en clústeres de Kubernetes. Credenciales de administrador que se usarán para los nodos de este grupo de agentes.
agentOptions	AgentOptions	AgentOptions son configuraciones que se aplicarán a cada agente de un grupo de agentes. Las configuraciones que se aplicarán a cada agente de este grupo de agentes.
attachedNetworkConfiguration	AttachedNetworkConfiguration	AttachedNetworkConfiguration representa el conjunto de redes de carga de trabajo que se van a asociar a un recurso. La configuración de redes que se adjuntan al grupo de agentes para su uso por las cargas de trabajo que se ejecutan en este clúster de Kubernetes.
availabilityZones	string[]	Lista de zonas de disponibilidad del clúster de nube de red que se usa para el aprovisionamiento de nodos en este grupo de agentes. Si no se especifica, se usarán todas las zonas de disponibilidad.
count	integer (int64)	Número de máquinas virtuales que usan esta configuración.
labels	KubernetesLabel[]	Etiquetas aplicadas a los nodos de este grupo de agentes.
mode	AgentPoolMode	La selección de cómo se utiliza este grupo de agentes, ya sea como un grupo de sistemas o un grupo de usuarios. Los grupos de sistemas ejecutan las características y los servicios críticos para el clúster de Kubernetes, mientras que los grupos de usuarios están dedicados a las cargas de trabajo de usuario. Cada clúster de Kubernetes debe contener al menos un grupo de nodos del sistema con al menos un nodo.
name	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	Nombre que se usará para el recurso del grupo de agentes que representa este grupo de agentes.
taints	KubernetesLabel[]	Los valores taint aplicados a los nodos de este grupo de agentes.
upgradeSettings	AgentPoolUpgradeSettings	AgentPoolUpgradeSettings especifica la configuración de actualización de un grupo de agentes. Configuración del grupo de agentes.
vmSkuName	string	Nombre de la SKU de máquina virtual que determina el tamaño de los recursos asignados para las máquinas virtuales de nodo.

IpAddressPool

Object

IpAddressPool representa un grupo de direcciones IP que se pueden asignar a un servicio.

Nombre	Tipo	Valor predeterminado	Description
addresses	string[]		Lista de intervalos de direcciones IP. Cada intervalo puede ser una subred en formato CIDR o un intervalo de inicio explícito de direcciones IP.
autoAssign	BfdEnabled	True	Indicador para determinar si debe producirse la asignación automática del grupo.
name	string pattern: ^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$		Nombre usado para identificar este grupo de direcciones IP para asociarse con un anuncio BGP.
onlyUseHostIps	BfdEnabled	True	Indicador para evitar el uso de direcciones IP que terminan con .0 y .255 para este grupo. Al habilitar esta opción, solo se usarán direcciones IP entre .1 y .254 inclusive.

KubernetesCluster

Object

KubernetesCluster representa el clúster de Kubernetes hospedado en la nube de red.

Nombre	Tipo	Description
extendedLocation	ExtendedLocation	ExtendedLocation representa la ubicación personalizada de Azure donde se creará el recurso. Ubicación extendida del clúster asociado al recurso.
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.aadConfiguration	AadConfiguration	AadConfiguration representa las propiedades de integración de Azure Active Directory. Propiedades de integración de Azure Active Directory.
properties.administratorConfiguration	AdministratorConfiguration	AdministratorConfiguration representa las credenciales administrativas que se aplicarán a los nodos del plano de control y del grupo de agentes en clústeres de Kubernetes. Credenciales administrativas que se aplicarán a los nodos del plano de control y del grupo de agentes que no especifican sus propios valores.
properties.attachedNetworkIds	string[]	Lista completa de identificadores de recursos de red que están asociados a este clúster, incluidos los asociados solo a grupos de agentes específicos.
properties.availableUpgrades	AvailableUpgrade[]	Lista de versiones a las que se puede actualizar este clúster de Kubernetes.
properties.clusterId	string	Identificador de recurso del clúster de nube de red.
properties.connectedClusterId	string	Identificador de recurso del clúster conectado configurado cuando se crea este clúster de Kubernetes.
properties.controlPlaneKubernetesVersion	string	La versión actual en ejecución de Kubernetes en el plano de control.
properties.controlPlaneNodeConfiguration	ControlPlaneNodeConfiguration	ControlPlaneNodeConfiguration representa la selección de máquinas virtuales y el tamaño del plano de control para un clúster de Kubernetes. Características de definición del plano de control para este clúster de Kubernetes.
properties.detailedStatus	KubernetesClusterDetailedStatus	Estado actual del clúster de Kubernetes.
properties.detailedStatusMessage	string	Mensaje descriptivo sobre el estado detallado actual.
properties.featureStatuses	FeatureStatus[]	Configuración actual de la característica.
properties.initialAgentPoolConfigurations	InitialAgentPoolConfiguration[]	Los grupos de agentes que se crean con este clúster de Kubernetes para ejecutar cargas de trabajo y servicios del sistema críticos. Estos datos de este campo solo se usan durante la creación y el campo estará vacío después de la creación del clúster de Kubernetes. Después de la creación, la administración de grupos de agentes se realiza mediante el subrecurso agentPools.
properties.kubernetesVersion	string	Versión de Kubernetes para este clúster. Acepta el formato n.n, n.n.n y n.n-n. La versión interpretada usada se resolverá en este campo después de la creación o actualización.
properties.managedResourceGroupConfiguration	ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration representa la configuración del grupo de recursos administrado por Azure. Configuración del grupo de recursos administrado asociado al recurso.
properties.networkConfiguration	NetworkConfiguration	NetworkConfiguration especifica la configuración relacionada con la red del clúster de Kubernetes. Configuración de las redes del clúster de Kubernetes, incluidos los datos adjuntos de las redes que abarcan el clúster.
properties.nodes	KubernetesClusterNode[]	Detalles de los nodos de este clúster.
properties.provisioningState	KubernetesClusterProvisioningState	Estado de aprovisionamiento del recurso de clúster de Kubernetes.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

KubernetesClusterDetailedStatus

Enumeración

Estado actual del clúster de Kubernetes.

Valor	Description
Available
Error
Provisioning

KubernetesClusterList

Object

KubernetesClusterList representa una lista de clústeres de Kubernetes.

Nombre	Tipo	Description
nextLink	string	Vínculo que se usa para obtener la página siguiente de operaciones.
value	KubernetesCluster[]	Lista de detalles adicionales relacionados con los clústeres de Kubernetes.

KubernetesClusterNode

Object

KubernetesClusterNode representa los detalles de un nodo de un clúster de Kubernetes.

Nombre	Tipo	Description
agentPoolId	string	Identificador de recurso del grupo de agentes al que pertenece este nodo. Este valor no se representa en los nodos del plano de control.
availabilityZone	string	La zona de disponibilidad en la que se ejecuta este nodo.
bareMetalMachineId	string	Identificador de recurso de la máquina sin sistema operativo que hospeda este nodo.
cpuCores	integer (int64)	Número de núcleos de CPU configurados para este nodo, derivados de la SKU de máquina virtual especificada.
detailedStatus	KubernetesClusterNodeDetailedStatus	Estado detallado de este nodo.
detailedStatusMessage	string	Mensaje descriptivo sobre el estado detallado actual.
diskSizeGB	integer (int64)	Tamaño del disco configurado para este nodo.
image	string	Imagen de máquina que se usa para implementar este nodo.
kubernetesVersion	string	La versión actualmente en ejecución de Kubernetes y las características agrupadas que se ejecutan en este nodo.
labels	KubernetesLabel[]	Lista de etiquetas de este nodo que se han asignado al grupo de agentes que contiene este nodo.
memorySizeGB	integer (int64)	Cantidad de memoria configurada para este nodo, derivada de la SKU de máquina virtual especificada.
mode	AgentPoolMode	Modo del grupo de agentes que contiene este nodo. No es aplicable a los nodos del plano de control.
name	string	Nombre de este nodo, tal como se realizó en el clúster de Kubernetes.
networkAttachments	NetworkAttachment[]	NetworkAttachments realizados en este nodo.
powerState	KubernetesNodePowerState	Estado de energía de este nodo.
role	KubernetesNodeRole	Rol de este nodo en el clúster.
taints	KubernetesLabel[]	Lista de taints que se han asignado al grupo de agentes que contiene este nodo.
vmSkuName	string	Nombre de la SKU de máquina virtual que se usó para crear este nodo de clúster.

KubernetesClusterNodeDetailedStatus

Enumeración

Estado detallado de este nodo.

Valor	Description
Available
Error
Provisioning
Running
Scheduling
Stopped
Terminating
Unknown

KubernetesClusterProvisioningState

Enumeración

Estado de aprovisionamiento del recurso de clúster de Kubernetes.

Valor	Description
Accepted
Canceled
Created
Deleting
Failed
InProgress
Succeeded
Updating

KubernetesLabel

Object

KubernetesLabel representa una sola entrada para una etiqueta o taint de Kubernetes, como las usadas en un nodo o pod.

Nombre	Tipo	Description
key	string	Nombre de la etiqueta o taint.
value	string	Valor de la etiqueta o taint.

KubernetesNodePowerState

Enumeración

Estado de energía de este nodo.

Valor	Description
Off
On
Unknown

KubernetesNodeRole

Enumeración

Rol de este nodo en el clúster.

Valor	Description
ControlPlane
Worker

KubernetesPluginType

Enumeración

Indicador de cómo usará esta red el clúster de Kubernetes.

Valor	Description
DPDK
IPVLAN
MACVLAN
OSDevice
SRIOV

L2NetworkAttachmentConfiguration

Object

L2NetworkAttachmentConfiguration representa la configuración de los datos adjuntos de una red de nivel 2.

Nombre	Tipo	Valor predeterminado	Description
networkId	string		Identificador de recurso de la red que se está configurando para los datos adjuntos.
pluginType	KubernetesPluginType	SRIOV	Indicador de cómo usará esta red el clúster de Kubernetes.

L3NetworkAttachmentConfiguration

Object

L3NetworkAttachmentConfiguration representa la configuración de los datos adjuntos de una red de nivel 3.

Nombre	Tipo	Valor predeterminado	Description
ipamEnabled	L3NetworkConfigurationIpamEnabled	False	Indicación de si esta red realizará o no la administración de direcciones IP y asignará direcciones IP cuando se adjunte.
networkId	string		Identificador de recurso de la red que se está configurando para los datos adjuntos.
pluginType	KubernetesPluginType	SRIOV	Indicador de cómo usará esta red el clúster de Kubernetes.

L3NetworkConfigurationIpamEnabled

Enumeración

Indicación de si esta red realizará o no la administración de direcciones IP y asignará direcciones IP cuando se adjunte.

Valor	Description
False
True

ManagedResourceGroupConfiguration

Object

ManagedResourceGroupConfiguration representa la configuración del grupo de recursos administrado por Azure.

Nombre	Tipo	Description
location	string	Ubicación del grupo de recursos administrado. Si no se especifica, se elige la ubicación del recurso primario.
name	string maxLength: 75	Nombre del grupo de recursos administrado. Si no se especifica, se genera automáticamente el nombre único.

NetworkAttachment

Object

NetworkAttachment representa los datos adjuntos de red únicos.

Nombre	Tipo	Description
attachedNetworkId	string	Identificador de recurso de la red asociada conectada a la máquina virtual. Puede ser uno de los recursos cloudServicesNetwork, l3Network, l2Network o trunkedNetwork.
defaultGateway	DefaultGateway	Indicador de si se trata de la puerta de enlace predeterminada. Solo se puede especificar una de las redes conectadas (incluidos los datos adjuntos de CloudServicesNetwork) para una sola máquina como True.
ipAllocationMethod	VirtualMachineIPAllocationMethod	Mecanismo de asignación de IP para la máquina virtual. Dinámicos y estáticos solo son válidos para l3Network que también pueden especificar Deshabilitado. De lo contrario, Disabled es el único valor permitido.
ipv4Address	string	Dirección IPv4 de la máquina virtual. Este campo solo se usa si la red conectada tiene IPAllocationType de IPV4 o DualStack. Si IPAllocationMethod es: Estático: este campo debe contener una dirección IPv4 especificada por el usuario desde dentro de la subred especificada en la red conectada. Dinámico: este campo es de solo lectura, pero se rellenará con una dirección desde dentro de la subred especificada en la red conectada. Deshabilitado: este campo estará vacío.
ipv6Address	string	Dirección IPv6 de la máquina virtual. Este campo solo se usa si la red conectada tiene IPAllocationType de IPV6 o DualStack. Si IPAllocationMethod es: Estático: este campo debe contener un intervalo de direcciones IPv6 desde el intervalo especificado en la red conectada. Dinámico: este campo es de solo lectura, pero se rellenará con un intervalo desde dentro de la subred especificada en la red conectada. Deshabilitado: este campo estará vacío.
macAddress	string	Dirección MAC de la interfaz de la máquina virtual que corresponde a estos datos adjuntos de red.
networkAttachmentName	string maxLength: 15	Nombre de la interfaz de la red asociada. Si se especifica, el nombre de los datos adjuntos de red tiene una longitud máxima de 15 caracteres y debe ser único para esta máquina virtual. Si el usuario no especifica este valor, se usará el nombre de interfaz predeterminado del recurso de red. En el caso de un recurso CloudServicesNetwork, este nombre se omitirá.

NetworkConfiguration

Object

NetworkConfiguration especifica la configuración relacionada con la red del clúster de Kubernetes.

Nombre	Tipo	Description
attachedNetworkConfiguration	AttachedNetworkConfiguration	AttachedNetworkConfiguration representa el conjunto de redes de carga de trabajo que se van a asociar a un recurso. La configuración de redes que se adjuntan al clúster para usarlas en las cargas de trabajo que se ejecutan en este clúster de Kubernetes.
bgpServiceLoadBalancerConfiguration	BgpServiceLoadBalancerConfiguration	BgpServiceLoadBalancerConfiguration representa la configuración de un equilibrador de carga de servicio BGP. Configuración del equilibrador de carga del servicio BGP para este clúster de Kubernetes.
cloudServicesNetworkId	string	Identificador de recurso de la red de Cloud Services asociada.
cniNetworkId	string	Identificador de recurso de la red de nivel 3 que se usa para la creación de la red de interfaz de red de contenedor.
dnsServiceIp	string	La dirección IP asignada al servicio DNS de Kubernetes. Debe estar dentro del intervalo de direcciones del servicio kubernetes especificado en el CIDR del servicio.
podCidrs	string[]	Intervalos IP de notación CIDR desde los que se van a asignar direcciones IP de pod. Se espera un CIDR IPv4 para las redes de una sola pila. Se esperan dos CIDR, uno para cada familia IP (IPv4/IPv6) para las redes de doble pila.
serviceCidrs	string[]	Intervalos IP de notación CIDR desde los que se van a asignar direcciones IP de servicio. Se espera un CIDR IPv4 para las redes de una sola pila. Se esperan dos CIDR, uno para cada familia IP (IPv4/IPv6) para las redes de doble pila.

ServiceLoadBalancerBgpPeer

Object

ServiceLoadBalancerBgpPeer representa la configuración del equilibrador de carga del servicio BGP para el clúster de Kubernetes.

Nombre	Tipo	Valor predeterminado	Description
bfdEnabled	BfdEnabled	False	Indicador de habilitación de BFD para este BgpPeer.
bgpMultiHop	BgpMultiHop	False	Indicador para habilitar la compatibilidad con el emparejamiento de varios saltos.
holdTime	string		Valor de tiempo de suspensión de BGP solicitado. Este campo usa el formato de duración ISO 8601, por ejemplo P1H.
keepAliveTime	string		Valor de tiempo keepalive de BGP solicitado. Este campo usa el formato de duración ISO 8601, por ejemplo P1H.
myAsn	integer (int64) minimum: 0 maximum: 4294967295		Número de sistema autónomo usado para el final local de la sesión BGP.
name	string pattern: ^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$		Nombre usado para identificar este par BGP para asociarlo con un anuncio de BGP.
password	string maxLength: 80 pattern: ^[a-zA-Z0-9]{0,80}$		Contraseña de autenticación para enrutadores que aplican sesiones autenticadas tcp MD5.
peerAddress	string		Dirección IPv4 o IPv6 que se usa para conectar esta sesión BGP.
peerAsn	integer (int64) minimum: 0 maximum: 4294967295		Número de sistema autónomo esperado desde el final remoto de la sesión BGP.
peerPort	integer (int64)	179	Puerto usado para conectar esta sesión BGP.

SshPublicKey

Object

SshPublicKey representa la clave pública que se usa para autenticarse con un recurso a través de SSH.

Nombre	Tipo	Description
keyData	string minLength: 1	Datos de clave pública SSH.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TrunkedNetworkAttachmentConfiguration

Object

TrunkedNetworkAttachmentConfiguration representa la configuración de los datos adjuntos de una red troncal.

Nombre	Tipo	Valor predeterminado	Description
networkId	string		Identificador de recurso de la red que se está configurando para los datos adjuntos.
pluginType	KubernetesPluginType	SRIOV	Indicador de cómo usará esta red el clúster de Kubernetes.

VirtualMachineIPAllocationMethod

Enumeración

Mecanismo de asignación de IP para la máquina virtual. Dinámicos y estáticos solo son válidos para l3Network que también pueden especificar Deshabilitado. De lo contrario, Disabled es el único valor permitido.

Valor	Description
Disabled
Dynamic
Static