Container Services - List By Resource Group

Referenz

Dienst:: Compute

API-Version:: 2017-01-31

Ruft eine Liste der Containerdienste in der angegebenen Ressourcengruppe ab.
Ruft eine Liste der Containerdienste in der angegebenen Abonnement- und Ressourcengruppe 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices?api-version=2017-01-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
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 by Resource Group

Beispielanforderung

HTTP

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

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"
        },
        "agentPoolProfiles": [
          {
            "name": "agentpool0",
            "count": 3,
            "vmSize": "Standard_D2_v2",
            "dnsPrefix": "acs1-rg1-e240e5agent",
            "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com"
          }
        ],
        "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"
        },
        "agentPoolProfiles": [
          {
            "name": "agentpool0",
            "count": 3,
            "vmSize": "Standard_D2_v2",
            "dnsPrefix": "acs2-rg1-e240e5agent"
          }
        ],
        "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
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 Schwarm, DCOS und Benutzerdefiniert.
ContainerServiceServicePrincipalProfile	Informationen zu einer Dienstprinzipalidentität für den Cluster zum Bearbeiten von Azure-APIs.
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.
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.

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 für benutzerdefinierte Cluster.
properties.diagnosticsProfile	ContainerServiceDiagnosticsProfile	Eigenschaften des Diagnose-Agents.
properties.linuxProfile	ContainerServiceLinuxProfile	Eigenschaften von Linux-VMs.
properties.masterProfile	ContainerServiceMasterProfile	Eigenschaften von Master-Agents.
properties.orchestratorProfile	ContainerServiceOrchestratorProfile	Eigenschaften des Orchestrators.
properties.provisioningState	string	der aktuelle Bereitstellungs- oder Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
properties.servicePrincipalProfile	ContainerServiceServicePrincipalProfile	Eigenschaften für Clusterdienstprinzipale.
properties.windowsProfile	ContainerServiceWindowsProfile	Eigenschaften von Windows-VMs.
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.
vmSize	ContainerServiceVMSizeTypes		Größe von Agent-VMs.

ContainerServiceCustomProfile

Objekt

Eigenschaften zum Konfigurieren eines benutzerdefinierten Containerdienstclusters.

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

ContainerServiceDiagnosticsProfile

Objekt

Name	Typ	Beschreibung
vmDiagnostics	ContainerServiceVMDiagnostics	Profil für den VM-Diagnose-Agent des Containerdiensts.

ContainerServiceLinuxProfile

Objekt

Profil für Linux-VMs im Containerdienstcluster.

Name	Typ	Beschreibung
adminUsername	string pattern: ^[a-z][a-z0-9_-]*$	Der Administratorbenutzername, der für Linux-VMs verwendet werden soll.
ssh	ContainerServiceSshConfiguration	Die Ssh-Schlüsselkonfiguration für Linux-VMs.

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	enum: 1 (int32) 3 (int32) 5 (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 master verwendet werden soll.
fqdn	string		FQDN für den Master.

ContainerServiceOrchestratorProfile

Objekt

Profil für den Containerdienst-Orchestrator.

Name	Typ	Beschreibung
orchestratorType	ContainerServiceOrchestratorTypes	Der Orchestrator zum Verwalten von Containerdienstclusterressourcen. Gültige Werte sind Schwarm, DCOS und Benutzerdefiniert.

ContainerServiceOrchestratorTypes

Enumeration

Der Orchestrator zum Verwalten von Containerdienstclusterressourcen. Gültige Werte sind Schwarm, DCOS und Benutzerdefiniert.

Wert	Beschreibung
Custom
DCOS
Kubernetes
Swarm

ContainerServiceServicePrincipalProfile

Objekt

Informationen zu einer Dienstprinzipalidentität für den Cluster zum Bearbeiten von Azure-APIs.

Name	Typ	Beschreibung
clientId	string	Die ID für den Dienstprinzipal.
secret	string	Das dem Dienstprinzipal zugeordnete geheime Kennwort.

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.

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.

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_A0
Standard_A1
Standard_A10
Standard_A11
Standard_A2
Standard_A3
Standard_A4
Standard_A5
Standard_A6
Standard_A7
Standard_A8
Standard_A9
Standard_D1
Standard_D11
Standard_D11_v2
Standard_D12
Standard_D12_v2
Standard_D13
Standard_D13_v2
Standard_D14
Standard_D14_v2
Standard_D1_v2
Standard_D2
Standard_D2_v2
Standard_D3
Standard_D3_v2
Standard_D4
Standard_D4_v2
Standard_D5_v2
Standard_DS1
Standard_DS11
Standard_DS12
Standard_DS13
Standard_DS14
Standard_DS2
Standard_DS3
Standard_DS4
Standard_G1
Standard_G2
Standard_G3
Standard_G4
Standard_G5
Standard_GS1
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS5

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.

Freigeben über

Container Services - List By Resource Group

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List Container Services by Resource Group

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ContainerService

ContainerServiceAgentPoolProfile

ContainerServiceCustomProfile

ContainerServiceDiagnosticsProfile

ContainerServiceLinuxProfile

ContainerServiceListResult

ContainerServiceMasterProfile

ContainerServiceOrchestratorProfile

ContainerServiceOrchestratorTypes

ContainerServiceServicePrincipalProfile

ContainerServiceSshConfiguration

ContainerServiceSshPublicKey

ContainerServiceVMDiagnostics

ContainerServiceVMSizeTypes

ContainerServiceWindowsProfile