Container Services - Get

Referencia

Servicio:: Compute

Versión de la API:: 2017-01-31

Obtiene las propiedades del servicio de contenedor especificado en la suscripción y el grupo de recursos especificados. La operación devuelve las propiedades, incluidos el estado, el orquestador, el número de maestros y agentes, y los FQDN de maestros y agentes.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
containerServiceName	path	True	string	Nombre del servicio de contenedor en la suscripción y el grupo de recursos especificados.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	ContainerService	De acuerdo

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

Get Container Service

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
ContainerService	Servicio de contenedor.
ContainerServiceAgentPoolProfile	Perfil del grupo de agentes de servicio de contenedor.
ContainerServiceCustomProfile	Propiedades para configurar un clúster de servicio de contenedor personalizado.
ContainerServiceDiagnosticsProfile
ContainerServiceLinuxProfile	Perfil de máquinas virtuales Linux en el clúster de servicios de contenedor.
ContainerServiceMasterProfile	Perfil del maestro de servicio de contenedor.
ContainerServiceOrchestratorProfile	Perfil del orquestador de servicios de contenedor.
ContainerServiceOrchestratorTypes	Orquestador que se va a usar para administrar los recursos del clúster del servicio de contenedor. Los valores válidos son Swarm, DCOS y Custom.
ContainerServiceServicePrincipalProfile	Información sobre una identidad de entidad de servicio para el clúster que se va a usar para manipular las API de Azure.
ContainerServiceSshConfiguration	Configuración de SSH para máquinas virtuales basadas en Linux que se ejecutan en Azure.
ContainerServiceSshPublicKey	Contiene información sobre los datos de clave pública del certificado SSH.
ContainerServiceVMDiagnostics	Perfil de diagnóstico en las máquinas virtuales del servicio de contenedor.
ContainerServiceVMSizeTypes	Tamaño de las máquinas virtuales del agente.
ContainerServiceWindowsProfile	Perfil de máquinas virtuales Windows en el clúster del servicio de contenedor.

ContainerService

Object

Servicio de contenedor.

Nombre	Tipo	Description
id	string	Identificador de recurso
location	string	Ubicación del recurso
name	string	Nombre del recurso
properties.agentPoolProfiles	ContainerServiceAgentPoolProfile[]	Propiedades del grupo de agentes.
properties.customProfile	ContainerServiceCustomProfile	Propiedades para clústeres personalizados.
properties.diagnosticsProfile	ContainerServiceDiagnosticsProfile	Propiedades del agente de diagnóstico.
properties.linuxProfile	ContainerServiceLinuxProfile	Propiedades de máquinas virtuales Linux.
properties.masterProfile	ContainerServiceMasterProfile	Propiedades de los agentes maestros.
properties.orchestratorProfile	ContainerServiceOrchestratorProfile	Propiedades del orquestador.
properties.provisioningState	string	el estado actual de implementación o aprovisionamiento, que solo aparece en la respuesta.
properties.servicePrincipalProfile	ContainerServiceServicePrincipalProfile	Propiedades de las entidades de servicio del clúster.
properties.windowsProfile	ContainerServiceWindowsProfile	Propiedades de las máquinas virtuales Windows.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

ContainerServiceAgentPoolProfile

Object

Perfil del grupo de agentes de servicio de contenedor.

Nombre	Tipo	Valor predeterminado	Description
count	integer (int32) minimum: 1 maximum: 100	1	Número de agentes (VM) para hospedar contenedores de Docker. Los valores permitidos deben estar en el intervalo de 1 a 100 (ambos incluidos). El valor predeterminado es 1.
dnsPrefix	string		Prefijo DNS que se usará para crear el FQDN para el grupo de agentes.
fqdn	string		FQDN para el grupo de agentes.
name	string		Nombre único del perfil del grupo de agentes en el contexto de la suscripción y el grupo de recursos.
vmSize	ContainerServiceVMSizeTypes		Tamaño de las máquinas virtuales del agente.

ContainerServiceCustomProfile

Object

Propiedades para configurar un clúster de servicio de contenedor personalizado.

Nombre	Tipo	Description
orchestrator	string	Nombre del orquestador personalizado que se va a usar.

ContainerServiceDiagnosticsProfile

Object

Nombre	Tipo	Description
vmDiagnostics	ContainerServiceVMDiagnostics	Perfil del agente de diagnóstico de máquina virtual del servicio de contenedor.

ContainerServiceLinuxProfile

Object

Perfil de máquinas virtuales Linux en el clúster de servicios de contenedor.

Nombre	Tipo	Description
adminUsername	string pattern: ^[a-z][a-z0-9_-]*$	Nombre de usuario del administrador que se va a usar para máquinas virtuales Linux.
ssh	ContainerServiceSshConfiguration	Configuración de clave ssh para máquinas virtuales Linux.

ContainerServiceMasterProfile

Object

Perfil del maestro de servicio de contenedor.

Nombre	Tipo	Valor predeterminado	Description
count	enum: 1 (int32) 3 (int32) 5 (int32)	1	Número de maestros (VM) en el clúster del servicio de contenedor. Los valores permitidos son 1, 3 y 5. El valor predeterminado es 1.
dnsPrefix	string		Prefijo DNS que se usará para crear el FQDN para master.
fqdn	string		FQDN para el maestro.

ContainerServiceOrchestratorProfile

Object

Perfil del orquestador de servicios de contenedor.

Nombre	Tipo	Description
orchestratorType	ContainerServiceOrchestratorTypes	Orquestador que se va a usar para administrar los recursos del clúster del servicio de contenedor. Los valores válidos son Swarm, DCOS y Custom.

ContainerServiceOrchestratorTypes

Enumeración

Orquestador que se va a usar para administrar los recursos del clúster del servicio de contenedor. Los valores válidos son Swarm, DCOS y Custom.

Valor	Description
Custom
DCOS
Kubernetes
Swarm

ContainerServiceServicePrincipalProfile

Object

Información sobre una identidad de entidad de servicio para el clúster que se va a usar para manipular las API de Azure.

Nombre	Tipo	Description
clientId	string	Identificador de la entidad de servicio.
secret	string	Contraseña secreta asociada a la entidad de servicio.

ContainerServiceSshConfiguration

Object

Configuración de SSH para máquinas virtuales basadas en Linux que se ejecutan en Azure.

Nombre	Tipo	Description
publicKeys	ContainerServiceSshPublicKey[]	la lista de claves públicas SSH que se usan para autenticarse con máquinas virtuales basadas en Linux.

ContainerServiceSshPublicKey

Object

Contiene información sobre los datos de clave pública del certificado SSH.

Nombre	Tipo	Description
keyData	string	Clave pública de certificado que se usa para autenticarse con máquinas virtuales a través de SSH. El certificado debe estar en formato PEM con o sin encabezados.

ContainerServiceVMDiagnostics

Object

Perfil de diagnóstico en las máquinas virtuales del servicio de contenedor.

Nombre	Tipo	Description
enabled	boolean	Indica si el agente de diagnóstico de máquina virtual está aprovisionado en la máquina virtual.
storageUri	string	URI de la cuenta de almacenamiento donde se almacenan los diagnósticos.

ContainerServiceVMSizeTypes

Enumeración

Tamaño de las máquinas virtuales del agente.

Valor	Description
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

Object

Perfil de máquinas virtuales Windows en el clúster del servicio de contenedor.

Nombre	Tipo	Description
adminPassword	string pattern: ^(?=.[a-z])(?=.[A-Z])(?=.[!@#$%\^&\])[a-zA-Z\d!@#$%\^&\*]{12,123}$	Contraseña de administrador que se va a usar para máquinas virtuales Windows.
adminUsername	string pattern: ^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$	Nombre de usuario del administrador que se va a usar para máquinas virtuales Windows.

Compartir a través de

Container Services - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get Container Service

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ContainerService

ContainerServiceAgentPoolProfile

ContainerServiceCustomProfile

ContainerServiceDiagnosticsProfile

ContainerServiceLinuxProfile

ContainerServiceMasterProfile

ContainerServiceOrchestratorProfile

ContainerServiceOrchestratorTypes

ContainerServiceServicePrincipalProfile

ContainerServiceSshConfiguration

ContainerServiceSshPublicKey

ContainerServiceVMDiagnostics

ContainerServiceVMSizeTypes

ContainerServiceWindowsProfile