Container Services - List

Referenz

Dienst:: AKS

API-Version:: 2017-07-01

Ruft eine Liste der Containerdienste im angegebenen Abonnement ab. Der Vorgang gibt Eigenschaften jedes Containerdiensts zurück, einschließlich Status, Orchestrator, Anzahl der Master- und Agents sowie FQDNs von Masters und Agents.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices?api-version=2017-07-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ContainerServiceListResult	OKAY

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List Container Services

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/containerServices?api-version=2017-07-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "type": "Microsoft.ContainerService/ContainerServices",
      "location": "location1",
      "id": "/subscriptions/subid1/resourceGroups/RG1/providers/Microsoft.ContainerService/containerServices/acs1",
      "name": "acs1",
      "properties": {
        "provisioningState": "Succeeded",
        "orchestratorProfile": {
          "orchestratorType": "DCOS"
        },
        "masterProfile": {
          "count": 1,
          "dnsPrefix": "acs1-rg1-e240e5mgmt",
          "fqdn": "acs1-rg1-e240e5mgmt.location1.cloudapp.azure.com",
          "vmSize": "Standard_D2_v2"
        },
        "agentPoolProfiles": [
          {
            "name": "agentpool0",
            "count": 3,
            "vmSize": "Standard_D2_v2",
            "dnsPrefix": "acs1-rg1-e240e5agent",
            "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com",
            "osType": "Linux"
          }
        ],
        "linuxProfile": {
          "ssh": {
            "publicKeys": [
              {
                "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n"
              }
            ]
          },
          "adminUsername": "azureuser"
        },
        "diagnosticsProfile": {
          "vmDiagnostics": {
            "enabled": true,
            "storageUri": "https://mjwjtrv73stvgdiag0.blob.core.windows.net/"
          }
        }
      }
    },
    {
      "type": "Microsoft.ContainerService/ContainerServices",
      "location": "location1",
      "id": "/subscriptions/subid1/resourceGroups/RG1/providers/Microsoft.ContainerService/containerServices/acs2",
      "name": "acs2",
      "properties": {
        "provisioningState": "Creating",
        "orchestratorProfile": {
          "orchestratorType": "DCOS"
        },
        "masterProfile": {
          "count": 1,
          "dnsPrefix": "acs2-rg1-e240e5mgmt",
          "vmSize": "Standard_D2_v2"
        },
        "agentPoolProfiles": [
          {
            "name": "agentpool0",
            "count": 3,
            "vmSize": "Standard_D2_v2",
            "dnsPrefix": "acs2-rg1-e240e5agent",
            "osType": "Linux"
          }
        ],
        "linuxProfile": {
          "ssh": {
            "publicKeys": [
              {
                "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n"
              }
            ]
          },
          "adminUsername": "azureuser"
        },
        "diagnosticsProfile": {
          "vmDiagnostics": {
            "enabled": true
          }
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ContainerService	Containerdienst.
ContainerServiceAgentPoolProfile	Profil für den Containerdienst-Agent-Pool.
ContainerServiceCustomProfile	Eigenschaften zum Konfigurieren eines benutzerdefinierten Containerdienstclusters.
ContainerServiceDiagnosticsProfile	Profil für die Diagnose im Containerdienstcluster.
ContainerServiceLinuxProfile	Profil für Linux-VMs im Containerdienstcluster.
ContainerServiceListResult	Die Antwort des Vorgangs "Containerdienste auflisten".
ContainerServiceMasterProfile	Profil für den Containerdienstmaster.
ContainerServiceOrchestratorProfile	Profil für den Containerdienst-Orchestrator.
ContainerServiceOrchestratorTypes	Der Orchestrator zum Verwalten von Containerdienstclusterressourcen. Gültige Werte sind Kubernetes, Swarm, DCOS, DockerCE und Custom.
ContainerServiceServicePrincipalProfile	Informationen zu einer Dienstprinzipalidentität für den Cluster zum Bearbeiten von Azure-APIs. Entweder geheim oder keyVaultSecretRef muss angegeben werden.
ContainerServiceSshConfiguration	SSH-Konfiguration für linuxbasierte VMs, die auf Azure ausgeführt werden.
ContainerServiceSshPublicKey	Enthält Informationen zu SSH-Zertifikatdaten für öffentliche Schlüssel.
ContainerServiceStorageProfileTypes	Das Speicherprofil gibt an, welche Art von Speicher verwendet wird. Wählen Sie aus "StorageAccount" und "ManagedDisks" aus. Lassen Sie es leer, wir wählen sie für Sie basierend auf der Orchestratorauswahl aus.
ContainerServiceVMDiagnostics	Profil für die Diagnose für die Containerdienst-VMs.
ContainerServiceVMSizeTypes	Größe von Agent-VMs.
ContainerServiceWindowsProfile	Profil für Windows-VMs im Containerdienstcluster.
Count	Anzahl der Master (VMs) im Containerdienstcluster. Zulässige Werte sind 1, 3 und 5. Der Standardwert ist 1.
KeyVaultSecretRef	Verweisen auf einen geheimen Schlüssel, der in Azure Key Vault gespeichert ist.
OSType	OsType, das zum Angeben des Betriebssystemtyps verwendet werden soll. Wählen Sie unter Linux und Windows aus. Standard für Linux.

ContainerService

Objekt

Containerdienst.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
location	string	Ressourcenspeicherort
name	string	Ressourcenname
properties.agentPoolProfiles	ContainerServiceAgentPoolProfile[]	Eigenschaften des Agentpools.
properties.customProfile	ContainerServiceCustomProfile	Eigenschaften zum Konfigurieren eines benutzerdefinierten Containerdienstclusters.
properties.diagnosticsProfile	ContainerServiceDiagnosticsProfile	Profil für die Diagnose im Containerdienstcluster.
properties.linuxProfile	ContainerServiceLinuxProfile	Profil für Linux-VMs im Containerdienstcluster.
properties.masterProfile	ContainerServiceMasterProfile	Profil für den Containerdienstmaster.
properties.orchestratorProfile	ContainerServiceOrchestratorProfile	Profil für den Containerdienst-Orchestrator.
properties.provisioningState	string	Der aktuelle Bereitstellungs- oder Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
properties.servicePrincipalProfile	ContainerServiceServicePrincipalProfile	Informationen zu einer Dienstprinzipalidentität für den Cluster zum Bearbeiten von Azure-APIs. Genau ein geheimer schlüssel oder keyVaultSecretRef muss angegeben werden.
properties.windowsProfile	ContainerServiceWindowsProfile	Profil für Windows-VMs im Containerdienstcluster.
tags	object	Ressourcentags
type	string	Ressourcentyp

ContainerServiceAgentPoolProfile

Objekt

Profil für den Containerdienst-Agent-Pool.

Name	Typ	Standardwert	Beschreibung
count	integer (int32) minimum: 1 maximum: 100	1	Anzahl der Agents (VMs) zum Hosten von Docker-Containern. Zulässige Werte müssen im Bereich von 1 bis 100 (einschließlich) liegen. Der Standardwert ist 1.
dnsPrefix	string		DNS-Präfix, das zum Erstellen des FQDN für den Agentpool verwendet werden soll.
fqdn	string		FQDN für den Agentpool.
name	string		Eindeutiger Name des Agentpoolprofils im Kontext des Abonnements und der Ressourcengruppe.
osDiskSizeGB	integer (int32) minimum: 0 maximum: 1023		Betriebssystemdatenträgergröße in GB, die verwendet werden soll, um die Datenträgergröße für jeden Computer in diesem Master-/Agent-Pool anzugeben. Wenn Sie "0" angeben, wird die Standardmäßige osDisk-Größe entsprechend der angegebenen vmSize angewendet.
osType	OSType	Linux	OsType, das zum Angeben des Betriebssystemtyps verwendet werden soll. Wählen Sie unter Linux und Windows aus. Standard für Linux.
ports	integer[] minimum: 1 maximum: 65535		Ports number array used to expose on this agent pool. Die standardmäßig geöffneten Ports unterscheiden sich je nach Wahl des Orchestrators.
storageProfile	ContainerServiceStorageProfileTypes		Das Speicherprofil gibt an, welche Art von Speicher verwendet wird. Wählen Sie aus "StorageAccount" und "ManagedDisks" aus. Lassen Sie es leer, wir wählen sie für Sie basierend auf der Orchestratorauswahl aus.
vmSize	ContainerServiceVMSizeTypes		Größe von Agent-VMs.
vnetSubnetID	string		VNet SubnetID gibt den Subnetzbezeichner des VNet an.

ContainerServiceCustomProfile

Objekt

Eigenschaften zum Konfigurieren eines benutzerdefinierten Containerdienstclusters.

Name	Typ	Beschreibung
orchestrator	string	Der Name des zu verwendenden benutzerdefinierten Orchestrators.

ContainerServiceDiagnosticsProfile

Objekt

Profil für die Diagnose im Containerdienstcluster.

Name	Typ	Beschreibung
vmDiagnostics	ContainerServiceVMDiagnostics	Profil für die Diagnose für die Containerdienst-VMs.

ContainerServiceLinuxProfile

Objekt

Profil für Linux-VMs im Containerdienstcluster.

Name	Typ	Beschreibung
adminUsername	string pattern: ^[A-Za-z][-A-Za-z0-9_]*$	Der Administratorbenutzername, der für Linux-VMs verwendet werden soll.
ssh	ContainerServiceSshConfiguration	SSH-Konfiguration für linuxbasierte VMs, die auf Azure ausgeführt werden.

ContainerServiceListResult

Objekt

Die Antwort des Vorgangs "Containerdienste auflisten".

Name	Typ	Beschreibung
nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Containerdienstergebnissen.
value	ContainerService[]	Die Liste der Containerdienste.

ContainerServiceMasterProfile

Objekt

Profil für den Containerdienstmaster.

Name	Typ	Standardwert	Beschreibung
count	Count (int32)	1	Anzahl der Master (VMs) im Containerdienstcluster. Zulässige Werte sind 1, 3 und 5. Der Standardwert ist 1.
dnsPrefix	string		DNS-Präfix, das zum Erstellen des FQDN für den Masterpool verwendet werden soll.
firstConsecutiveStaticIP	string	10.240.255.5	FirstConsecutiveStaticIP verwendet, um die erste statische IP von Master anzugeben.
fqdn	string		FQDN für den Masterpool.
osDiskSizeGB	integer (int32) minimum: 0 maximum: 1023		Betriebssystemdatenträgergröße in GB, die verwendet werden soll, um die Datenträgergröße für jeden Computer in diesem Master-/Agent-Pool anzugeben. Wenn Sie "0" angeben, wird die Standardmäßige osDisk-Größe entsprechend der angegebenen vmSize angewendet.
storageProfile	ContainerServiceStorageProfileTypes		Das Speicherprofil gibt an, welche Art von Speicher verwendet wird. Wählen Sie aus "StorageAccount" und "ManagedDisks" aus. Lassen Sie es leer, wir wählen sie für Sie basierend auf der Orchestratorauswahl aus.
vmSize	ContainerServiceVMSizeTypes		Größe von Agent-VMs.
vnetSubnetID	string		VNet SubnetID gibt den Subnetzbezeichner des VNet an.

ContainerServiceOrchestratorProfile

Objekt

Profil für den Containerdienst-Orchestrator.

Name	Typ	Beschreibung
orchestratorType	ContainerServiceOrchestratorTypes	Der Orchestrator zum Verwalten von Containerdienstclusterressourcen. Gültige Werte sind Kubernetes, Swarm, DCOS, DockerCE und Custom.
orchestratorVersion	string	Die zu verwendende Version des Orchestrators. Sie können den Teil "major.minor.patch" der tatsächlichen Version angeben. Sie können z. B. version als "1.6.11" angeben.

ContainerServiceOrchestratorTypes

Enumeration

Der Orchestrator zum Verwalten von Containerdienstclusterressourcen. Gültige Werte sind Kubernetes, Swarm, DCOS, DockerCE und Custom.

Wert	Beschreibung
Custom
DCOS
DockerCE
Kubernetes
Swarm

ContainerServiceServicePrincipalProfile

Objekt

Informationen zu einer Dienstprinzipalidentität für den Cluster zum Bearbeiten von Azure-APIs. Entweder geheim oder keyVaultSecretRef muss angegeben werden.

Name	Typ	Beschreibung
clientId	string	Die ID für den Dienstprinzipal.
keyVaultSecretRef	KeyVaultSecretRef	Verweisen auf einen geheimen Schlüssel, der in Azure Key Vault gespeichert ist.
secret	string	Das geheime Kennwort, das dem Dienstprinzipal in Nur-Text zugeordnet ist.

ContainerServiceSshConfiguration

Objekt

SSH-Konfiguration für linuxbasierte VMs, die auf Azure ausgeführt werden.

Name	Typ	Beschreibung
publicKeys	ContainerServiceSshPublicKey[]	Die Liste der öffentlichen SSH-Schlüssel, die für die Authentifizierung mit linuxbasierten VMs verwendet werden. Es wird nur ein Schlüssel angegeben.

ContainerServiceSshPublicKey

Objekt

Enthält Informationen zu SSH-Zertifikatdaten für öffentliche Schlüssel.

Name	Typ	Beschreibung
keyData	string	Öffentlicher Zertifikatschlüssel, der für die Authentifizierung mit VMs über SSH verwendet wird. Das Zertifikat muss im PEM-Format mit oder ohne Kopfzeilen vorliegen.

ContainerServiceStorageProfileTypes

Enumeration

Das Speicherprofil gibt an, welche Art von Speicher verwendet wird. Wählen Sie aus "StorageAccount" und "ManagedDisks" aus. Lassen Sie es leer, wir wählen sie für Sie basierend auf der Orchestratorauswahl aus.

Wert	Beschreibung
ManagedDisks
StorageAccount

ContainerServiceVMDiagnostics

Objekt

Profil für die Diagnose für die Containerdienst-VMs.

Name	Typ	Beschreibung
enabled	boolean	Gibt an, ob der VM-Diagnose-Agent auf dem virtuellen Computer bereitgestellt wird.
storageUri	string	Der URI des Speicherkontos, in dem die Diagnose gespeichert ist.

ContainerServiceVMSizeTypes

Enumeration

Größe von Agent-VMs.

Wert	Beschreibung
Standard_A1
Standard_A10
Standard_A11
Standard_A1_v2
Standard_A2
Standard_A2_v2
Standard_A2m_v2
Standard_A3
Standard_A4
Standard_A4_v2
Standard_A4m_v2
Standard_A5
Standard_A6
Standard_A7
Standard_A8
Standard_A8_v2
Standard_A8m_v2
Standard_A9
Standard_B2ms
Standard_B2s
Standard_B4ms
Standard_B8ms
Standard_D1
Standard_D11
Standard_D11_v2
Standard_D11_v2_Promo
Standard_D12
Standard_D12_v2
Standard_D12_v2_Promo
Standard_D13
Standard_D13_v2
Standard_D13_v2_Promo
Standard_D14
Standard_D14_v2
Standard_D14_v2_Promo
Standard_D15_v2
Standard_D16_v3
Standard_D16s_v3
Standard_D1_v2
Standard_D2
Standard_D2_v2
Standard_D2_v2_Promo
Standard_D2_v3
Standard_D2s_v3
Standard_D3
Standard_D32_v3
Standard_D32s_v3
Standard_D3_v2
Standard_D3_v2_Promo
Standard_D4
Standard_D4_v2
Standard_D4_v2_Promo
Standard_D4_v3
Standard_D4s_v3
Standard_D5_v2
Standard_D5_v2_Promo
Standard_D64_v3
Standard_D64s_v3
Standard_D8_v3
Standard_D8s_v3
Standard_DS1
Standard_DS11
Standard_DS11_v2
Standard_DS11_v2_Promo
Standard_DS12
Standard_DS12_v2
Standard_DS12_v2_Promo
Standard_DS13
Standard_DS13-2_v2
Standard_DS13-4_v2
Standard_DS13_v2
Standard_DS13_v2_Promo
Standard_DS14
Standard_DS14-4_v2
Standard_DS14-8_v2
Standard_DS14_v2
Standard_DS14_v2_Promo
Standard_DS15_v2
Standard_DS1_v2
Standard_DS2
Standard_DS2_v2
Standard_DS2_v2_Promo
Standard_DS3
Standard_DS3_v2
Standard_DS3_v2_Promo
Standard_DS4
Standard_DS4_v2
Standard_DS4_v2_Promo
Standard_DS5_v2
Standard_DS5_v2_Promo
Standard_E16_v3
Standard_E16s_v3
Standard_E2_v3
Standard_E2s_v3
Standard_E32-16s_v3
Standard_E32-8s_v3
Standard_E32_v3
Standard_E32s_v3
Standard_E4_v3
Standard_E4s_v3
Standard_E64-16s_v3
Standard_E64-32s_v3
Standard_E64_v3
Standard_E64s_v3
Standard_E8_v3
Standard_E8s_v3
Standard_F1
Standard_F16
Standard_F16s
Standard_F16s_v2
Standard_F1s
Standard_F2
Standard_F2s
Standard_F2s_v2
Standard_F32s_v2
Standard_F4
Standard_F4s
Standard_F4s_v2
Standard_F64s_v2
Standard_F72s_v2
Standard_F8
Standard_F8s
Standard_F8s_v2
Standard_G1
Standard_G2
Standard_G3
Standard_G4
Standard_G5
Standard_GS1
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS4-4
Standard_GS4-8
Standard_GS5
Standard_GS5-16
Standard_GS5-8
Standard_H16
Standard_H16m
Standard_H16mr
Standard_H16r
Standard_H8
Standard_H8m
Standard_L16s
Standard_L32s
Standard_L4s
Standard_L8s
Standard_M128-32ms
Standard_M128-64ms
Standard_M128ms
Standard_M128s
Standard_M64-16ms
Standard_M64-32ms
Standard_M64ms
Standard_M64s
Standard_NC12
Standard_NC12s_v2
Standard_NC12s_v3
Standard_NC24
Standard_NC24r
Standard_NC24rs_v2
Standard_NC24rs_v3
Standard_NC24s_v2
Standard_NC24s_v3
Standard_NC6
Standard_NC6s_v2
Standard_NC6s_v3
Standard_ND12s
Standard_ND24rs
Standard_ND24s
Standard_ND6s
Standard_NV12
Standard_NV24
Standard_NV6

ContainerServiceWindowsProfile

Objekt

Profil für Windows-VMs im Containerdienstcluster.

Name	Typ	Beschreibung
adminPassword	string pattern: ^(?=.[a-z])(?=.[A-Z])(?=.[!@#$%\^&\])[a-zA-Z\d!@#$%\^&\*]{12,123}$	Das Administratorkennwort, das für Windows-VMs verwendet werden soll.
adminUsername	string pattern: ^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$	Der Administratorbenutzername, der für Windows-VMs verwendet werden soll.

Count

Enumeration

Anzahl der Master (VMs) im Containerdienstcluster. Zulässige Werte sind 1, 3 und 5. Der Standardwert ist 1.

Wert	Beschreibung
1
3
5

KeyVaultSecretRef

Objekt

Verweisen auf einen geheimen Schlüssel, der in Azure Key Vault gespeichert ist.

Name	Typ	Beschreibung
secretName	string	Der geheime Name.
vaultID	string	Schlüsseltresor-ID.
version	string	Die geheime Version.

OSType

Enumeration

OsType, das zum Angeben des Betriebssystemtyps verwendet werden soll. Wählen Sie unter Linux und Windows aus. Standard für Linux.

Wert	Beschreibung
Linux
Windows

Freigeben über

Container Services - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List Container Services

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ContainerService

ContainerServiceAgentPoolProfile

ContainerServiceCustomProfile

ContainerServiceDiagnosticsProfile

ContainerServiceLinuxProfile

ContainerServiceListResult

ContainerServiceMasterProfile

ContainerServiceOrchestratorProfile

ContainerServiceOrchestratorTypes

ContainerServiceServicePrincipalProfile

ContainerServiceSshConfiguration

ContainerServiceSshPublicKey

ContainerServiceStorageProfileTypes

ContainerServiceVMDiagnostics

ContainerServiceVMSizeTypes

ContainerServiceWindowsProfile

Count

KeyVaultSecretRef

OSType