Provisioned Clusters - List By Subscription

Odwołanie

Service:: Hybrid Container Service

API Version:: 2022-05-01-preview

Pobiera aprowidowane klastry w subskrypcji
Pobiera aprowizowany klaster hybrydowej usługi AKS w subskrypcji

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HybridContainerService/provisionedClusters?api-version=2022-05-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	provisionedClustersResponseListResult	Wyświetla listę wszystkich aprowizowaniaClusters w ramach subskrypcji.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ListProvisionedClusterBySubscription

Sample Request

GET https://management.azure.com/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/providers/Microsoft.HybridContainerService/provisionedClusters?api-version=2022-05-01-preview

import com.azure.core.util.Context;

/** Samples for ProvisionedClustersOperation List. */
public final class Main {
    /*
     * x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/preview/2022-05-01-preview/examples/ListProvisionedClusterBySubscription.json
     */
    /**
     * Sample code: ListProvisionedClusterBySubscription.
     *
     * @param manager Entry point to HybridContainerServiceManager.
     */
    public static void listProvisionedClusterBySubscription(
        com.azure.resourcemanager.hybridcontainerservice.HybridContainerServiceManager manager) {
        manager.provisionedClustersOperations().list(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

package armhybridcontainerservice_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hybridaks/resource-manager/Microsoft.HybridContainerService/preview/2022-05-01-preview/examples/ListProvisionedClusterBySubscription.json
func ExampleProvisionedClustersClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armhybridcontainerservice.NewProvisionedClustersClient("a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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

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

/**
 * This sample demonstrates how to Gets the Hybrid AKS provisioned cluster in a subscription
 *
 * @summary Gets the Hybrid AKS provisioned cluster in a subscription
 * x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/preview/2022-05-01-preview/examples/ListProvisionedClusterBySubscription.json
 */
async function listProvisionedClusterBySubscription() {
  const subscriptionId = "a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b";
  const credential = new DefaultAzureCredential();
  const client = new HybridContainerServiceClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.provisionedClustersOperations.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

listProvisionedClusterBySubscription().catch(console.error);

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.HybridContainerService/provisionedClusters/test-hybridakscluster",
      "name": "test-hybridakscluster",
      "type": "microsoft.hybridcontainerservice/provisionedclusters",
      "location": "westus",
      "extendedLocation": {
        "name": "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourcegroups/test-arcappliance-resgrp/providers/microsoft.extendedlocation/customlocations/testcustomlocation",
        "type": "CustomLocation"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "controlPlane": {
          "count": 1,
          "vmSize": "Standard_A4_v2",
          "osType": "Linux",
          "linuxProfile": {
            "ssh": {
              "publicKeys": [
                {
                  "keyData": "ssh-rsa AAAAB1NzaC1yc2EAAAADAQABAAACAQCY......"
                }
              ]
            }
          }
        },
        "kubernetesVersion": "v1.20.5",
        "networkProfile": {
          "loadBalancerSku": "unstacked-haproxy",
          "loadBalancerProfile": {
            "count": 1,
            "vmSize": "Standard_K8S3_v1",
            "osType": "Linux",
            "linuxProfile": {
              "ssh": {
                "publicKeys": [
                  {
                    "keyData": "ssh-rsa AAAAB2NzaC1yc2EAAAADAQABAAACAQCY......"
                  }
                ]
              }
            }
          },
          "networkPolicy": "calico",
          "podCidr": "10.244.0.0/16"
        },
        "agentPoolProfiles": [
          {
            "name": "default-nodepool-1",
            "count": 1,
            "vmSize": "Standard_A4_v2",
            "osType": "Linux"
          }
        ],
        "linuxProfile": {
          "ssh": {
            "publicKeys": [
              {
                "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCY......."
              }
            ]
          }
        },
        "cloudProviderProfile": {
          "infraNetworkProfile": {
            "vnetSubnetIds": [
              "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.HybridContainerService/virtualNetworks/test-vnet-static"
            ]
          },
          "infraStorageProfile": {
            "storageSpaceIds": [
              "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.HybridContainerService/storageSpaces/test-storage"
            ]
          }
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
AADProfileResponse	Profil usługi AAD określa atrybuty integracji z usługą Azure Active Directory.
AddonProfiles	Konfiguracje dodatków
AddonStatus	Stan dodatku
ArcAgentProfile	Definiuje właściwości agenta usługi Arc dla zaaprowizowanych klastrów.
ArcAgentStatus	Definiuje zaobserwowany stan agenta usługi Arc, który jest zasóbSynchroniczny z powrotem do zasobu usługi ARM.
AutoUpgradeOptions	Wskazuje, czy agenci usługi Arc w aprowizowanych klastrach zostaną automatycznie uaktualnioni do najnowszej wersji. Wartość domyślna to Włączone.
CloudProviderProfile	CloudProviderProfile — podstawowe właściwości dostawcy infrastruktury w chmurze.
ControlPlaneEndpoint	Punkt końcowy serwera interfejsu API dla płaszczyzny sterowania
ControlPlaneProfile	ControlPlaneProfile — właściwości płaszczyzny sterowania dla aprowizowanego klastra.
createdByType	Typ tożsamości, która utworzyła zasób.
deploymentState	Zaobserwowano stan wdrożenia agentów usługi Arc w klastrze docelowym. Możliwe wartości to: "pending", "provisioning", "provisioned", "deleting", "failed", "upgrade"
Error
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ExtendedLocation
Features	Dodatkowe specyfikacje funkcji, takie jak dołączanie agenta usługi Arc.
FeaturesStatus	Stan dodatkowych funkcji, takich jak dołączanie agenta usługi Arc.
httpProxyConfigResponse	Konfiguracje aprowizacji klastra za pomocą serwerów proxy HTTP.
InfraNetworkProfile	InfraNetworkProfile — lista profilów sieci infrastruktury dla aprowizowanego klastra
InfraStorageProfile	InfraStorageProfile — lista profilów magazynu infra dla aprowizowanego klastra
licenseType	LicenseType — typ licencji do użycia dla maszyn wirtualnych z systemem Windows. Windows_Server służy do włączania korzyści użycia hybrydowego użytkownika platformy Azure dla maszyn wirtualnych z systemem Windows. Możliwe wartości to: "None", "Windows_Server"
LinuxProfileProperties	LinuxProfile — profil maszyn wirtualnych z systemem Linux w klastrze usługi kontenera.
LoadBalancerProfile	LoadBalancerProfile — profil modułu równoważenia obciążenia klastra.
loadBalancerSku	LoadBalancerSku — jednostka SKU modułu równoważenia obciążenia dla aprowizowanego klastra. Możliwe wartości: "unstacked-haproxy", "stacked-kube-vip", "stacked-metallb", "unmanaged". Wartość domyślna to "niezarządzana".
mode	Tryb — AgentPoolMode reprezentuje tryb puli agentów. Możliwe wartości to: "System", "LB", "Użytkownik". Wartość domyślna to "Użytkownik"
NamedAgentPoolProfile	Profil puli agentów wraz z parametrem nazwy
networkPolicy	NetworkPolicy — zasady sieci używane do tworzenia sieci Kubernetes. Możliwe wartości to: "calico", "flannel". Wartość domyślna to "calico"
NetworkProfile	NetworkProfile — profil konfiguracji sieci.
osType	OsType — typ OsType, który ma być używany do określania typu systemu operacyjnego. Wybierz jedną z systemów Linux i Windows. Wartość domyślna to Linux. Możliwe wartości to: "Linux", "Windows"
provisionedClusterIdentity	Tożsamość dla aprowizowanego klastra.
provisionedClustersResponse	Definicja zasobu provisionedClusters.
provisionedClustersResponseListResult
provisionedClustersResponseProperties
provisioningState
ProvisioningStatus	Zawiera błędy aprowizacji
PublicKeys	PublicKeys — lista kluczy publicznych SSH używanych do uwierzytelniania za pomocą maszyn wirtualnych z systemem Linux. Oczekuje się tylko jednego określonego klucza.
ResourceIdentityType	Typ tożsamości używany dla aprowizowanego klastra. Typ SystemAssigned zawiera tożsamość utworzoną przez system. Typ Brak oznacza, że żadna tożsamość nie jest przypisana do aprowizowanego klastra.
Ssh	SSH — konfiguracja SSH dla maszyn wirtualnych z systemem Linux działających na platformie Azure.
Status	HybridAKSClusterStatus definiuje zaobserwowany stan hybridAKSCluster
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
WindowsProfileResponse	Profil maszyn wirtualnych z systemem Windows w klastrze usługi kontenera.

AADProfileResponse

Profil usługi AAD określa atrybuty integracji z usługą Azure Active Directory.

Nazwa	Typ	Opis
adminGroupObjectIDs	string[]	Lista identyfikatorów obiektów grupy usługi AAD, które będą miały rolę administratora klastra.
clientAppID	string	Identyfikator aplikacji usługi AAD klienta.
enableAzureRbac	boolean	Czy włączyć kontrolę dostępu opartą na rolach platformy Azure dla autoryzacji platformy Kubernetes.
managed	boolean	Czy włączyć zarządzaną usługę AAD.
serverAppID	string	Identyfikator aplikacji usługi AAD serwera.
tenantID	string	Identyfikator dzierżawy usługi AAD do użycia do uwierzytelniania. Jeśli nie zostanie określony, użyje dzierżawy subskrypcji wdrożenia.

AddonProfiles

Konfiguracje dodatków

Nazwa	Typ	Opis
config	object	Config — pary klucz-wartość służące do konfigurowania dodatku.
enabled	boolean	Włączone — określa, czy dodatek jest włączony, czy nie.

AddonStatus

Stan dodatku

Nazwa	Typ	Opis
errorMessage	string	Komunikat o błędzie zostanie ustawiony w przypadku, gdy wystąpił problem terminalowy z uzgadnianiem dodatku i będzie zawierać bardziej pełny ciąg odpowiedni do rejestrowania i spożycia przez ludzi.
phase	string	Faza reprezentuje bieżącą fazę działania klastra. Np. Oczekujące, Uruchomione, Zakończenie, Niepowodzenie itp.
ready	boolean

ArcAgentProfile

Definiuje właściwości agenta usługi Arc dla zaaprowizowanych klastrów.

Nazwa	Typ	Wartość domyślna	Opis
agentAutoUpgrade	AutoUpgradeOptions	Enabled	Wskazuje, czy agenci usługi Arc w aprowizowanych klastrach zostaną automatycznie uaktualnioni do najnowszej wersji. Wartość domyślna to Włączone.
agentVersion	string		Wersja agentów usługi Arc do zainstalowania w zasób aprowizowanego klastra

ArcAgentStatus

Definiuje zaobserwowany stan agenta usługi Arc, który jest zasóbSynchroniczny z powrotem do zasobu usługi ARM.

Nazwa	Typ	Opis
agentVersion	string	Wersja agentów usługi Arc uruchomionych obecnie w zasobie aprowizowanego klastra.
coreCount	integer	Liczba rdzeni procesora CPU znajdujących się w zasobie aprowizowanego klastra
deploymentState	deploymentState	Zaobserwowano stan wdrożenia agentów usługi Arc w klastrze docelowym. Możliwe wartości to: "pending", "provisioning", "provisioned", "deleting", "failed", "upgrade"
errorMessage	string	Komunikaty o błędach podczas dołączania/uaktualniania/odinstalowywania agentów usługi Arc
lastConnectivityTime	string	Sygnatura czasowa ostatniego połączonego zasobu klastra aprowizowanego.
managedIdentityCertificateExpirationTime	string	ManagedIdentity czas wygaśnięcia certyfikatu (ValidUntil).
onboardingPublicKey	string	Dołączanie klucza publicznego do aprowizowania tożsamości zarządzanej dla klastra HybridAKS. Zostanie użyty do utworzenia zasobu serwera proxy hybridIdentityMetadata i nie zostanie utrwalone.

AutoUpgradeOptions

Wskazuje, czy agenci usługi Arc w aprowizowanych klastrach zostaną automatycznie uaktualnioni do najnowszej wersji. Wartość domyślna to Włączone.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

CloudProviderProfile

CloudProviderProfile — podstawowe właściwości dostawcy infrastruktury w chmurze.

Nazwa	Typ	Opis
infraNetworkProfile	InfraNetworkProfile	InfraNetworkProfile — lista profilów sieci infrastruktury dla aprowizowanego klastra
infraStorageProfile	InfraStorageProfile	InfraStorageProfile — lista profilów magazynu infra dla aprowizowanego klastra

ControlPlaneEndpoint

Punkt końcowy serwera interfejsu API dla płaszczyzny sterowania

Nazwa	Typ	Opis
hostIP	string	Adres IP hosta dla serwera interfejsu API
port	string	Port serwera interfejsu API

ControlPlaneProfile

ControlPlaneProfile — właściwości płaszczyzny sterowania dla aprowizowanego klastra.

Nazwa	Typ	Wartość domyślna	Opis
availabilityZones	string[]		AvailabilityZones — lista stref dostępności do użycia dla węzłów. Stojaki centrów danych modelowane jako strefy
cloudProviderProfile	CloudProviderProfile		Podstawowe właściwości dostawcy infrastruktury w chmurze.
controlPlaneEndpoint	ControlPlaneEndpoint		Punkt końcowy serwera interfejsu API dla płaszczyzny sterowania
count	integer	1	Count — liczba agentów hostujących kontenery platformy Docker. Dozwolone wartości muszą należeć do zakresu od 1 do 100 (włącznie). Wartość domyślna to 1.
linuxProfile	LinuxProfileProperties		Profil maszyn wirtualnych z systemem Linux w klastrze usługi kontenera.
maxCount	integer		Maksymalna liczba węzłów do automatycznego skalowania
maxPods	integer		Maksymalna liczba zasobników, które mogą być uruchamiane w węźle.
minCount	integer		Minimalna liczba węzłów do automatycznego skalowania
mode	mode	User	Tryb — AgentPoolMode reprezentuje tryb puli agentów. Możliwe wartości to: "System", "LB", "Użytkownik". Wartość domyślna to "Użytkownik"
name	string		Unikatowa nazwa profilu puli agentów w kontekście subskrypcji i grupy zasobów.
nodeImageVersion	string		Wersja obrazu węzła
nodeLabels	object		NodeLabels — etykiety węzłów puli agentów, które mają być utrwalane we wszystkich węzłach w puli agentów.
nodeTaints	string[]		NodeTaints — defekty dodane do nowych węzłów podczas tworzenia i skalowania puli węzłów. Na przykład key=value:NoSchedule.
osType	osType	Linux	OsType — typ OsType, który ma być używany do określania typu systemu operacyjnego. Wybierz jedną z systemów Linux i Windows. Wartość domyślna to Linux. Możliwe wartości to: "Linux", "Windows"
vmSize	string		VmSize — rozmiar maszyn wirtualnych puli agentów.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

deploymentState

Zaobserwowano stan wdrożenia agentów usługi Arc w klastrze docelowym. Możliwe wartości to: "pending", "provisioning", "provisioned", "deleting", "failed", "upgrade"

Nazwa	Typ	Opis
deleting	string
failed	string
pending	string
provisioned	string
provisioning	string
upgrading	string

Error

Nazwa	Typ	Opis
code	string
message	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

ExtendedLocation

Nazwa	Typ	Opis
name	string	Nazwa lokalizacji rozszerzonej.
type	string	Typ lokalizacji rozszerzonej.

Features

Dodatkowe specyfikacje funkcji, takie jak dołączanie agenta usługi Arc.

Nazwa	Typ	Opis
arcAgentProfile	ArcAgentProfile	Konfiguracja agentów usługi Arc dla aprowizowanego klastra.

FeaturesStatus

Stan dodatkowych funkcji, takich jak dołączanie agenta usługi Arc.

Nazwa	Typ	Opis
arcAgentStatus	ArcAgentStatus	Definiuje zaobserwowany stan agenta usługi Arc, który jest zasóbSynchroniczny z powrotem do zasobu usługi ARM.

httpProxyConfigResponse

Konfiguracje aprowizacji klastra za pomocą serwerów proxy HTTP.

Nazwa	Typ	Opis
httpProxy	string	Punkt końcowy serwera proxy HTTP do użycia.
httpsProxy	string	Punkt końcowy serwera proxy HTTPS do użycia.
noProxy	string[]	Punkty końcowe, które nie powinny przechodzić przez serwer proxy.
trustedCa	string	Alternatywny certyfikat urzędu certyfikacji do użycia do nawiązywania połączenia z serwerami proxy.
username	string	Nazwa użytkownika używana do nawiązywania połączenia z serwerem proxy

InfraNetworkProfile

InfraNetworkProfile — lista profilów sieci infrastruktury dla aprowizowanego klastra

Nazwa	Typ	Opis
vnetSubnetIds	string[]	Tablica odwołań do zasobu platformy Azure odpowiadającego nowemu obiektowi HybridAKSNetwork, np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}

InfraStorageProfile

InfraStorageProfile — lista profilów magazynu infra dla aprowizowanego klastra

Nazwa	Typ	Opis
storageSpaceIds	string[]	Odwołanie do zasobu platformy Azure odpowiadającego nowemu obiektowi HybridAKSStorage, np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}

licenseType

LicenseType — typ licencji do użycia dla maszyn wirtualnych z systemem Windows. Windows_Server służy do włączania korzyści użycia hybrydowego użytkownika platformy Azure dla maszyn wirtualnych z systemem Windows. Możliwe wartości to: "None", "Windows_Server"

Nazwa	Typ	Opis
None	string
Windows_Server	string

LinuxProfileProperties

LinuxProfile — profil maszyn wirtualnych z systemem Linux w klastrze usługi kontenera.

Nazwa	Typ	Opis
adminUsername	string	AdminUsername — nazwa użytkownika administratora do użycia dla maszyn wirtualnych z systemem Linux.
ssh	Ssh	SSH — konfiguracja SSH dla maszyn wirtualnych z systemem Linux działających na platformie Azure.

LoadBalancerProfile

LoadBalancerProfile — profil modułu równoważenia obciążenia klastra.

Nazwa	Typ	Wartość domyślna	Opis
availabilityZones	string[]		AvailabilityZones — lista stref dostępności do użycia dla węzłów. Stojaki centrów danych modelowane jako strefy
cloudProviderProfile	CloudProviderProfile		Podstawowe właściwości dostawcy infrastruktury w chmurze.
count	integer	1	Count — liczba agentów hostujących kontenery platformy Docker. Dozwolone wartości muszą należeć do zakresu od 1 do 100 (włącznie). Wartość domyślna to 1.
linuxProfile	LinuxProfileProperties		Profil maszyn wirtualnych z systemem Linux w klastrze usługi kontenera.
maxCount	integer		Maksymalna liczba węzłów do automatycznego skalowania
maxPods	integer		Maksymalna liczba zasobników, które mogą być uruchamiane w węźle.
minCount	integer		Minimalna liczba węzłów do automatycznego skalowania
mode	mode	User	Tryb — AgentPoolMode reprezentuje tryb puli agentów. Możliwe wartości to: "System", "LB", "Użytkownik". Wartość domyślna to "Użytkownik"
name	string		Unikatowa nazwa profilu puli agentów w kontekście subskrypcji i grupy zasobów.
nodeImageVersion	string		Wersja obrazu węzła
nodeLabels	object		NodeLabels — etykiety węzłów puli agentów, które mają być utrwalane we wszystkich węzłach w puli agentów.
nodeTaints	string[]		NodeTaints — defekty dodane do nowych węzłów podczas tworzenia i skalowania puli węzłów. Na przykład key=value:NoSchedule.
osType	osType	Linux	OsType — typ OsType, który ma być używany do określania typu systemu operacyjnego. Wybierz jedną z systemów Linux i Windows. Wartość domyślna to Linux. Możliwe wartości to: "Linux", "Windows"
vmSize	string		VmSize — rozmiar maszyn wirtualnych puli agentów.

loadBalancerSku

LoadBalancerSku — jednostka SKU modułu równoważenia obciążenia dla aprowizowanego klastra. Możliwe wartości: "unstacked-haproxy", "stacked-kube-vip", "stacked-metallb", "unmanaged". Wartość domyślna to "niezarządzana".

Nazwa	Typ	Opis
stacked-kube-vip	string
stacked-metallb	string
unmanaged	string
unstacked-haproxy	string

mode

Tryb — AgentPoolMode reprezentuje tryb puli agentów. Możliwe wartości to: "System", "LB", "Użytkownik". Wartość domyślna to "Użytkownik"

Nazwa	Typ	Opis
LB	string
System	string
User	string

NamedAgentPoolProfile

Profil puli agentów wraz z parametrem nazwy

Nazwa	Typ	Wartość domyślna	Opis
availabilityZones	string[]		AvailabilityZones — lista stref dostępności do użycia dla węzłów. Stojaki centrów danych modelowane jako strefy
cloudProviderProfile	CloudProviderProfile		Podstawowe właściwości dostawcy infrastruktury w chmurze.
count	integer	1	Count — liczba agentów hostujących kontenery platformy Docker. Dozwolone wartości muszą należeć do zakresu od 1 do 100 (włącznie). Wartość domyślna to 1.
maxCount	integer		Maksymalna liczba węzłów do automatycznego skalowania
maxPods	integer		Maksymalna liczba zasobników, które mogą być uruchamiane w węźle.
minCount	integer		Minimalna liczba węzłów do automatycznego skalowania
mode	mode	User	Tryb — AgentPoolMode reprezentuje tryb puli agentów. Możliwe wartości to: "System", "LB", "Użytkownik". Wartość domyślna to "Użytkownik"
name	string		Unikatowa nazwa profilu puli agentów w kontekście subskrypcji i grupy zasobów.
nodeImageVersion	string		Wersja obrazu węzła
nodeLabels	object		NodeLabels — etykiety węzłów puli agentów, które mają być utrwalane we wszystkich węzłach w puli agentów.
nodeTaints	string[]		NodeTaints — defekty dodane do nowych węzłów podczas tworzenia i skalowania puli węzłów. Na przykład key=value:NoSchedule.
osType	osType	Linux	OsType — typ OsType, który ma być używany do określania typu systemu operacyjnego. Wybierz jedną z systemów Linux i Windows. Wartość domyślna to Linux. Możliwe wartości to: "Linux", "Windows"
vmSize	string		VmSize — rozmiar maszyn wirtualnych puli agentów.

networkPolicy

NetworkPolicy — zasady sieci używane do tworzenia sieci Kubernetes. Możliwe wartości to: "calico", "flannel". Wartość domyślna to "calico"

Nazwa	Typ	Opis
calico	string
flannel	string

NetworkProfile

NetworkProfile — profil konfiguracji sieci.

Nazwa	Typ	Wartość domyślna	Opis
dnsServiceIP	string		DNSServiceIP — adres IP przypisany do usługi DNS Kubernetes. Musi znajdować się w zakresie adresów usługi Kubernetes określonym w usłudze ServiceCidr.
loadBalancerProfile	LoadBalancerProfile		LoadBalancerProfile — profil modułu równoważenia obciążenia klastra.
loadBalancerSku	loadBalancerSku	unmanaged	LoadBalancerSku — jednostka SKU modułu równoważenia obciążenia dla aprowizowanego klastra. Możliwe wartości: "unstacked-haproxy", "stacked-kube-vip", "stacked-metallb", "unmanaged". Wartość domyślna to "niezarządzana".
networkPolicy	networkPolicy	calico	NetworkPolicy — zasady sieci używane do tworzenia sieci Kubernetes. Możliwe wartości to: "calico", "flannel". Wartość domyślna to "calico"
podCidr	string		PodCidr — zakres adresów IP notacji CIDR, z którego można przypisać adresy IP zasobników, gdy jest używana platforma kubenet.
podCidrs	string[]		Adresy IP notacji CIDR, z których mają zostać przypisane adresy IP zasobników. Oczekiwano jednego protokołu IPv4 CIDR w przypadku sieci z jednym stosem. Dla każdej rodziny adresów IP (IPv4/IPv6) oczekuje się dwóch reguł CIDR, po jednej dla sieci z podwójnym stosem.
serviceCidr	string		ServiceCidr — zakres adresów IP notacji CIDR, z którego można przypisać adresy IP klastra usługi. Nie może pokrywać się z żadnymi zakresami adresów IP podsieci.
serviceCidrs	string[]		Adresy IP notacji CIDR obejmują zakresy adresów IP, z których należy przypisać adresy IP klastra usług. Oczekiwano jednego protokołu IPv4 CIDR w przypadku sieci z jednym stosem. Dla każdej rodziny adresów IP (IPv4/IPv6) oczekuje się dwóch reguł CIDR, po jednej dla sieci z podwójnym stosem. Nie mogą nakładać się na zakresy adresów IP podsieci.

osType

OsType — typ OsType, który ma być używany do określania typu systemu operacyjnego. Wybierz jedną z systemów Linux i Windows. Wartość domyślna to Linux. Możliwe wartości to: "Linux", "Windows"

Nazwa	Typ	Opis
Linux	string
Windows	string

provisionedClusterIdentity

Tożsamość dla aprowizowanego klastra.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości aprowizowanego klastra. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId	string	Identyfikator dzierżawy skojarzony z zainicjowanym klastrem. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type	ResourceIdentityType	Typ tożsamości używany dla aprowizowanego klastra. Typ SystemAssigned zawiera tożsamość utworzoną przez system. Typ Brak oznacza, że żadna tożsamość nie jest przypisana do aprowizowanego klastra.

provisionedClustersResponse

Definicja zasobu provisionedClusters.

Nazwa	Typ	Opis
extendedLocation	ExtendedLocation
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	provisionedClusterIdentity	Tożsamość dla aprowizowanego klastra.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties	provisionedClustersResponseProperties
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

provisionedClustersResponseListResult

Nazwa	Typ	Opis
nextLink	string
value	provisionedClustersResponse[]	Definicja zasobu provisionedClusters.

provisionedClustersResponseProperties

Nazwa	Typ	Opis
aadProfile	AADProfileResponse	Profil usługi AAD dla aprowizowanego klastra.
addonProfiles	<string, AddonProfiles>	AddonProfiles — profil dodatku klastra zarządzanego.
agentPoolProfiles	NamedAgentPoolProfile[]	Pule agentów klastra.
cloudProviderProfile	CloudProviderProfile	Podstawowe właściwości dostawcy infrastruktury w chmurze.
controlPlane	ControlPlaneProfile	ControlPlane — konfiguracja płaszczyzny sterowania
enableRbac	boolean	EnableRBAC — określa, czy włączyć Role-Based Access Control Kubernetes.
features	Features	Dodatkowe specyfikacje funkcji, takie jak dołączanie agenta usługi Arc.
httpProxyConfig	httpProxyConfigResponse	HttpProxyConfig — konfiguracje aprowizowania klastra za pomocą serwerów proxy HTTP.
kubernetesVersion	string	KubernetesVersion — wersja rozwiązania Kubernetes określona podczas tworzenia klastra zarządzanego.
linuxProfile	LinuxProfileProperties	LinuxProfile — profil maszyn wirtualnych z systemem Linux w aprowizowanej klastrze.
networkProfile	NetworkProfile	NetworkProfile — profil konfiguracji sieci.
nodeResourceGroup	string	NodeResourceGroup — nazwa grupy zasobów zawierającej węzły puli agentów.
provisioningState	provisioningState
status	Status	HybridAKSClusterStatus definiuje zaobserwowany stan hybridAKSCluster
windowsProfile	WindowsProfileResponse	WindowsProfile — profil maszyn wirtualnych z systemem Windows w aprowizowanej klastrze.

provisioningState

Nazwa	Typ	Opis
Accepted	string
Canceled	string
Created	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string
Updating	string

ProvisioningStatus

Zawiera błędy aprowizacji

Nazwa	Typ	Opis
error	Error
operationId	string
phase	string	Faza reprezentuje bieżącą fazę działania klastra. Np. Oczekujące, Uruchomione, Zakończenie, Niepowodzenie itp.
status	string

PublicKeys

PublicKeys — lista kluczy publicznych SSH używanych do uwierzytelniania za pomocą maszyn wirtualnych z systemem Linux. Oczekuje się tylko jednego określonego klucza.

Nazwa	Typ	Opis
keyData	string	KeyData — klucz publiczny certyfikatu używany do uwierzytelniania za pomocą maszyn wirtualnych za pośrednictwem protokołu SSH. Certyfikat musi być w formacie PEM z nagłówkami lub bez.

ResourceIdentityType

Typ tożsamości używany dla aprowizowanego klastra. Typ SystemAssigned zawiera tożsamość utworzoną przez system. Typ Brak oznacza, że żadna tożsamość nie jest przypisana do aprowizowanego klastra.

Nazwa	Typ	Opis
None	string
SystemAssigned	string

Ssh

SSH — konfiguracja SSH dla maszyn wirtualnych z systemem Linux działających na platformie Azure.

Nazwa	Typ	Opis
publicKeys	PublicKeys[]	PublicKeys — lista kluczy publicznych SSH używanych do uwierzytelniania za pomocą maszyn wirtualnych z systemem Linux. Oczekuje się tylko jednego określonego klucza.

Status

HybridAKSClusterStatus definiuje zaobserwowany stan hybridAKSCluster

Nazwa	Typ	Opis
addonStatus	<string, AddonStatus>	AddonStatus — stan dodatków
errorMessage	string	ErrorMessage — komunikaty o błędach podczas tworzenia klastra
featuresStatus	FeaturesStatus	Stan dodatkowych funkcji, takich jak dołączanie agenta usługi Arc.
provisioningStatus	ProvisioningStatus	Zawiera błędy aprowizacji

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

WindowsProfileResponse

Profil maszyn wirtualnych z systemem Windows w klastrze usługi kontenera.

Nazwa	Typ	Opis
adminUsername	string	AdminUsername — określa nazwę konta administratora. Ograniczenie: Nie można kończyć się "." Niedozwolone wartości: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimalna długość: 1 znak Maksymalna długość: 20 znaków
enableCsiProxy	boolean	EnableCSIProxy — czy włączyć serwer proxy CSI.
licenseType	licenseType	LicenseType — typ licencji do użycia dla maszyn wirtualnych z systemem Windows. Windows_Server służy do włączania korzyści użycia hybrydowego użytkownika platformy Azure dla maszyn wirtualnych z systemem Windows. Możliwe wartości to: "None", "Windows_Server"

Provisioned Clusters - List By Subscription

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

ListProvisionedClusterBySubscription

Sample Request

Sample Response

Definicje

AADProfileResponse

AddonProfiles

AddonStatus

ArcAgentProfile

ArcAgentStatus

AutoUpgradeOptions

CloudProviderProfile

ControlPlaneEndpoint

ControlPlaneProfile

createdByType

deploymentState

Error

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

Features

FeaturesStatus

httpProxyConfigResponse

InfraNetworkProfile

InfraStorageProfile

licenseType

LinuxProfileProperties

LoadBalancerProfile

loadBalancerSku

mode

NamedAgentPoolProfile

networkPolicy

NetworkProfile

osType

provisionedClusterIdentity

provisionedClustersResponse

provisionedClustersResponseListResult

provisionedClustersResponseProperties

provisioningState

ProvisioningStatus

PublicKeys

ResourceIdentityType

Ssh

Status

systemData

WindowsProfileResponse

Dodatkowe zasoby