Cloud Services - List

Servicio:: Compute

Versión de la API:: 2024-11-04

Obtiene una lista de todos los servicios en la nube de un grupo de recursos. Use la propiedad nextLink en la respuesta para obtener la página siguiente de Cloud Services. Haga esto hasta que nextLink sea nulo para obtener todos los servicios en la nube.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices?api-version=2024-11-04

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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	CloudServiceListResult	OK
Other Status Codes	CloudError	Error

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 Cloud Services in a Resource Group

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices?api-version=2024-11-04

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "name": "{cs-name}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
      "type": "Microsoft.Compute/cloudServices",
      "location": "eastus2euap",
      "properties": {
        "configuration": "{ServiceConfiguration}",
        "upgradeMode": "Auto",
        "roleProfile": {
          "roles": [
            {
              "name": "ContosoFrontend",
              "sku": {
                "name": "Standard_D1_v2",
                "tier": "Standard",
                "capacity": 2
              }
            },
            {
              "name": "ContosoBackend",
              "sku": {
                "name": "Standard_D1_v2",
                "tier": "Standard",
                "capacity": 2
              }
            }
          ]
        },
        "osProfile": {
          "secrets": []
        },
        "networkProfile": {
          "loadBalancerConfigurations": [
            {
              "name": "contosolb",
              "properties": {
                "frontendIpConfigurations": [
                  {
                    "name": "contosofe",
                    "properties": {
                      "publicIPAddress": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
                      }
                    }
                  }
                ]
              }
            }
          ]
        },
        "extensionProfile": {
          "extensions": [
            {
              "name": "RDPExtension",
              "properties": {
                "autoUpgradeMinorVersion": false,
                "provisioningState": "Succeeded",
                "rolesAppliedTo": [
                  "*"
                ],
                "publisher": "Microsoft.Windows.Azure.Extensions",
                "type": "RDP",
                "typeHandlerVersion": "1.2",
                "settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
              }
            }
          ]
        },
        "provisioningState": "Succeeded",
        "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
      }
    }
  ]
}

Definiciones

Nombre	Description
ApiError	Error de API.
ApiErrorBase	Base de errores de API.
CloudError	Una respuesta de error del servicio de proceso.
CloudService	Describe el servicio en la nube.
CloudServiceExtensionProfile	Describe un perfil de extensión de servicio en la nube.
CloudServiceExtensionProperties	Propiedades de extensión.
CloudServiceListResult	El resultado de la operación de lista.
CloudServiceNetworkProfile	Perfil de red para el servicio en la nube.
CloudServiceOsProfile	Describe el perfil del sistema operativo para el servicio en la nube.
CloudServiceProperties	Propiedades del servicio en la nube
CloudServiceRoleProfile	Describe el perfil de rol para el servicio en la nube.
CloudServiceRoleProfileProperties	Describe las propiedades de la función.
CloudServiceRoleSku	Describe la SKU del rol de servicio en la nube.
CloudServiceSlotType	Tipo de ranura para el servicio en la nube. Los valores posibles son producción de de ensayo Si no se especifica, el valor predeterminado es Production.
CloudServiceUpgradeMode	Modo de actualización para el servicio en la nube. Las instancias de rol se asignan a dominios de actualización cuando se implementa el servicio. Las actualizaciones se pueden iniciar manualmente en cada dominio de actualización o iniciarse automáticamente en todos los dominios de actualización. Los valores posibles son auto Manual simultáneas Si no se especifica, el valor predeterminado es Auto. Si se establece en Manual, se debe llamar a PUT UpdateDomain para aplicar la actualización. Si se establece en Automático, la actualización se aplica automáticamente a cada dominio de actualización en secuencia.
CloudServiceVaultAndSecretReference	Configuración protegida para la extensión, a la que se hace referencia mediante KeyVault, que se cifran antes de enviarlos a la instancia de rol.
CloudServiceVaultCertificate	Describe una única referencia de certificado en un almacén de claves y dónde debe residir el certificado en la instancia de rol.
CloudServiceVaultSecretGroup	Describe un conjunto de certificados que están todos en la misma instancia de Key Vault.
createdByType	Tipo de identidad que creó el recurso.
Extension	Describe una extensión de servicio en la nube.
InnerError	Detalles del error interno.
LoadBalancerConfiguration	Describe la configuración del equilibrador de carga.
LoadBalancerConfigurationProperties	Describe las propiedades de la configuración del equilibrador de carga.
LoadBalancerFrontendIpConfiguration	Especifica la dirección IP de front-end que se va a usar para el equilibrador de carga. Solo se admite la dirección IP de front-end IPv4. Cada configuración del equilibrador de carga debe tener exactamente una configuración ip de front-end.
LoadBalancerFrontendIpConfigurationProperties	Describe una configuración de IP de servicio en la nube
SubResource
systemData	Metadatos relativos a la creación y última modificación del recurso.

ApiError

Objeto

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de la API
innererror	InnerError	El error interno de la API
message	string	El mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Objeto

Base de errores de API.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error concreto.

CloudError

Objeto

Una respuesta de error del servicio de proceso.

Nombre	Tipo	Description
error	ApiError	Error de API.

CloudService

Objeto

Describe el servicio en la nube.

Nombre	Tipo	Description
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties	CloudServiceProperties	Propiedades del servicio en la nube
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.
zones	string[]	Lista de la zona de disponibilidad lógica del recurso. La lista solo debe contener 1 zona en la que se debe aprovisionar el servicio en la nube. Este campo es opcional.

CloudServiceExtensionProfile

Objeto

Describe un perfil de extensión de servicio en la nube.

Nombre	Tipo	Description
extensions	Extension[]	Lista de extensiones para el servicio en la nube.

CloudServiceExtensionProperties

Objeto

Propiedades de extensión.

Nombre	Tipo	Description
autoUpgradeMinorVersion	boolean	Especifique explícitamente si la plataforma puede actualizar automáticamente typeHandlerVersion a versiones secundarias superiores cuando estén disponibles.
forceUpdateTag	string	Etiqueta para forzar la aplicación de la configuración pública y protegida proporcionada. Cambiar el valor de etiqueta permite volver a ejecutar la extensión sin cambiar ninguna de las configuraciones públicas o protegidas. Si no se cambia forceUpdateTag, el controlador seguirá aplicando las actualizaciones a la configuración pública o protegida. Si ni forceUpdateTag ni ninguna de las configuraciones públicas o protegidas cambian, la extensión fluiría a la instancia de rol con el mismo número de secuencia, y depende de la implementación del controlador volver a ejecutarla o no
protectedSettings	object	Configuración protegida para la extensión que se cifra antes de enviar a la instancia de rol.
protectedSettingsFromKeyVault	CloudServiceVaultAndSecretReference	Configuración protegida para la extensión, a la que se hace referencia mediante KeyVault, que se cifran antes de enviarlos a la instancia de rol.
provisioningState	string	Estado de aprovisionamiento, que solo aparece en la respuesta.
publisher	string	Nombre del publicador de controladores de extensión.
rolesAppliedTo	string[]	Lista opcional de roles para aplicar esta extensión. Si no se especifica la propiedad o se especifica '*', la extensión se aplica a todos los roles del servicio en la nube.
settings	object	Configuración pública de la extensión. En el caso de las extensiones JSON, esta es la configuración JSON de la extensión. Para la extensión XML (como RDP), esta es la configuración XML de la extensión.
type	string	Especifica el tipo de la extensión.
typeHandlerVersion	string	Especifica la versión de la extensión. Especifica la versión de la extensión. Si no se especifica este elemento o se usa un asterisco (*) como valor, se usa la versión más reciente de la extensión. Si el valor se especifica con un número de versión principal y un asterisco como número de versión secundaria (X.), se selecciona la versión secundaria más reciente de la versión principal especificada. Si se especifica un número de versión principal y un número de versión secundaria (X.Y), se selecciona la versión de extensión específica. Si se especifica una versión, se realiza una actualización automática en la instancia de rol.

CloudServiceListResult

Objeto

El resultado de la operación de lista.

Nombre	Tipo	Description
nextLink	string	El URI para obtener la siguiente página de recursos. Use esto para obtener la siguiente página de recursos. Haga esto hasta que nextLink sea null para obtener todos los recursos.
value	CloudService[]	La lista de recursos.

CloudServiceNetworkProfile

Objeto

Perfil de red para el servicio en la nube.

Nombre	Tipo	Description
loadBalancerConfigurations	LoadBalancerConfiguration[]	Lista de configuraciones del equilibrador de carga. El servicio en la nube puede tener hasta dos configuraciones de equilibrador de carga, correspondientes a un equilibrador de carga público y a un equilibrador de carga interno.
slotType	CloudServiceSlotType	Tipo de ranura para el servicio en la nube. Los valores posibles son producción de de ensayo Si no se especifica, el valor predeterminado es Production.
swappableCloudService	SubResource	Referencia de identificador del servicio en la nube que contiene la dirección IP de destino con la que el servicio en la nube sujeto puede realizar un intercambio. Esta propiedad no se puede actualizar una vez establecida. El servicio en la nube intercambiable al que hace referencia este identificador debe estar presente; de lo contrario, se producirá un error.

CloudServiceOsProfile

Objeto

Describe el perfil del sistema operativo para el servicio en la nube.

Nombre	Tipo	Description
secrets	CloudServiceVaultSecretGroup[]	Especifica el conjunto de certificados que se deben instalar en las instancias de rol.

CloudServiceProperties

Objeto

Propiedades del servicio en la nube

Nombre	Tipo	Description
allowModelOverride	boolean	(Opcional) Indica si las propiedades de SKU de rol (roleProfile.roles.sku) especificadas en el modelo o plantilla deben invalidar el número de instancias de rol y el tamaño de máquina virtual especificados en .cscfg y .csdef respectivamente. El valor predeterminado es `false`.
configuration	string	Especifica la configuración del servicio XML (.cscfg) para el servicio en la nube.
configurationUrl	string	Especifica una dirección URL que hace referencia a la ubicación de la configuración del servicio en Blob service. La dirección URL del paquete de servicio puede ser URI de firma de acceso compartido (SAS) desde cualquier cuenta de almacenamiento. Se trata de una propiedad de solo escritura y no se devuelve en las llamadas GET.
extensionProfile	CloudServiceExtensionProfile	Describe un perfil de extensión de servicio en la nube.
networkProfile	CloudServiceNetworkProfile	Perfil de red para el servicio en la nube.
osProfile	CloudServiceOsProfile	Describe el perfil del sistema operativo para el servicio en la nube.
packageUrl	string	Especifica una dirección URL que hace referencia a la ubicación del paquete de servicio en Blob service. La dirección URL del paquete de servicio puede ser URI de firma de acceso compartido (SAS) desde cualquier cuenta de almacenamiento. Se trata de una propiedad de solo escritura y no se devuelve en las llamadas GET.
provisioningState	string	Estado de aprovisionamiento, que solo aparece en la respuesta.
roleProfile	CloudServiceRoleProfile	Describe el perfil de rol para el servicio en la nube.
startCloudService	boolean	(Opcional) Indica si se debe iniciar el servicio en la nube inmediatamente después de crearlo. El valor predeterminado es `true`. Si es false, el modelo de servicio se sigue implementando, pero el código no se ejecuta inmediatamente. En su lugar, el servicio es PoweredOff hasta que se llama a Start, en cuyo momento se iniciará el servicio. Un servicio implementado todavía incurre en cargos, incluso si está apagado.
uniqueId	string	Identificador único del servicio en la nube.
upgradeMode	CloudServiceUpgradeMode	Modo de actualización para el servicio en la nube. Las instancias de rol se asignan a dominios de actualización cuando se implementa el servicio. Las actualizaciones se pueden iniciar manualmente en cada dominio de actualización o iniciarse automáticamente en todos los dominios de actualización. Los valores posibles son auto Manual simultáneas Si no se especifica, el valor predeterminado es Auto. Si se establece en Manual, se debe llamar a PUT UpdateDomain para aplicar la actualización. Si se establece en Automático, la actualización se aplica automáticamente a cada dominio de actualización en secuencia.

CloudServiceRoleProfile

Objeto

Describe el perfil de rol para el servicio en la nube.

Nombre	Tipo	Description
roles	CloudServiceRoleProfileProperties[]	Lista de roles para el servicio en la nube.

CloudServiceRoleProfileProperties

Objeto

Describe las propiedades de la función.

Nombre	Tipo	Description
name	string	Nombre del recurso.
sku	CloudServiceRoleSku	Describe la SKU del rol de servicio en la nube.

CloudServiceRoleSku

Objeto

Describe la SKU del rol de servicio en la nube.

Nombre	Tipo	Description
capacity	integer (int64)	Especifica el número de instancias de rol en el servicio en la nube.
name	string	El nombre de la SKU. NOTA: Si la nueva SKU no se admite en el hardware en el que está activado el servicio en la nube, debe eliminar y volver a crear el servicio en la nube o volver a la SKU anterior.
tier	string	Especifica el nivel del servicio en la nube. Los valores posibles son Standard Basic

CloudServiceSlotType

Enumeración

Tipo de ranura para el servicio en la nube. Los valores posibles son

producción de

de ensayo

Si no se especifica, el valor predeterminado es Production.

Valor	Description
Production
Staging

CloudServiceUpgradeMode

Enumeración

Modo de actualización para el servicio en la nube. Las instancias de rol se asignan a dominios de actualización cuando se implementa el servicio. Las actualizaciones se pueden iniciar manualmente en cada dominio de actualización o iniciarse automáticamente en todos los dominios de actualización. Los valores posibles son

auto

Manual

simultáneas

Si no se especifica, el valor predeterminado es Auto. Si se establece en Manual, se debe llamar a PUT UpdateDomain para aplicar la actualización. Si se establece en Automático, la actualización se aplica automáticamente a cada dominio de actualización en secuencia.

Valor	Description
Auto
Manual
Simultaneous

CloudServiceVaultAndSecretReference

Objeto

Configuración protegida para la extensión, a la que se hace referencia mediante KeyVault, que se cifran antes de enviarlos a la instancia de rol.

Nombre	Tipo	Description
secretUrl	string	Dirección URL secreta que contiene la configuración protegida de la extensión
sourceVault	SubResource	El identificador de recurso de ARM del almacén de claves

CloudServiceVaultCertificate

Objeto

Describe una única referencia de certificado en un almacén de claves y dónde debe residir el certificado en la instancia de rol.

Nombre	Tipo	Description
certificateUrl	string	Esta es la dirección URL de un certificado que se ha cargado en Key Vault como secreto.
isBootstrapCertificate	boolean	Marca que indica si el certificado proporcionado es un certificado de arranque que va a usar la extensión de Key Vault para capturar los certificados restantes.

CloudServiceVaultSecretGroup

Objeto

Describe un conjunto de certificados que están todos en la misma instancia de Key Vault.

Nombre	Tipo	Description
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene todos los certificados de VaultCertificates.
vaultCertificates	CloudServiceVaultCertificate[]	Lista de referencias del almacén de claves en SourceVault que contienen certificados.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

Extension

Objeto

Describe una extensión de servicio en la nube.

Nombre	Tipo	Description
name	string	Nombre de la extensión.
properties	CloudServiceExtensionProperties	Propiedades de extensión.

InnerError

Objeto

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	El mensaje de error interno o el volcado de excepción.
exceptiontype	string	El tipo de excepción.

LoadBalancerConfiguration

Objeto

Describe la configuración del equilibrador de carga.

Nombre	Tipo	Description
id	string	Identificador de recurso
name	string	Nombre del equilibrador de carga
properties	LoadBalancerConfigurationProperties	Propiedades de la configuración del equilibrador de carga.

LoadBalancerConfigurationProperties

Objeto

Describe las propiedades de la configuración del equilibrador de carga.

Nombre	Tipo	Description
frontendIpConfigurations	LoadBalancerFrontendIpConfiguration[]	Especifica la dirección IP de front-end que se va a usar para el equilibrador de carga. Solo se admite la dirección IP de front-end IPv4. Cada configuración del equilibrador de carga debe tener exactamente una configuración ip de front-end.

LoadBalancerFrontendIpConfiguration

Objeto

Especifica la dirección IP de front-end que se va a usar para el equilibrador de carga. Solo se admite la dirección IP de front-end IPv4. Cada configuración del equilibrador de carga debe tener exactamente una configuración ip de front-end.

Nombre	Tipo	Description
name	string	Nombre del recurso que es único dentro del conjunto de configuraciones ip de front-end usadas por el equilibrador de carga. Este nombre se puede usar para acceder al recurso.
properties	LoadBalancerFrontendIpConfigurationProperties	Propiedades de la configuración ip de front-end del equilibrador de carga.

LoadBalancerFrontendIpConfigurationProperties

Objeto

Describe una configuración de IP de servicio en la nube

Nombre	Tipo	Description
privateIPAddress	string	Dirección IP privada de la red virtual de la configuración de IP.
publicIPAddress	SubResource	Referencia al recurso de dirección IP pública.
subnet	SubResource	Referencia al recurso de subred de red virtual.

SubResource

Objeto

Nombre	Tipo	Description
id	string	Identificador de recurso

systemData

Objeto

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.

Compartir a través de

Cloud Services - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List Cloud Services in a Resource Group

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApiError

ApiErrorBase

CloudError

CloudService

CloudServiceExtensionProfile

CloudServiceExtensionProperties

CloudServiceListResult

CloudServiceNetworkProfile

CloudServiceOsProfile

CloudServiceProperties

CloudServiceRoleProfile

CloudServiceRoleProfileProperties

CloudServiceRoleSku

CloudServiceSlotType

CloudServiceUpgradeMode

CloudServiceVaultAndSecretReference

CloudServiceVaultCertificate

CloudServiceVaultSecretGroup

createdByType

Extension

InnerError

LoadBalancerConfiguration

LoadBalancerConfigurationProperties

LoadBalancerFrontendIpConfiguration

LoadBalancerFrontendIpConfigurationProperties

SubResource

systemData