Cloud Services - Get
Mostrar información sobre un servicio en la nube.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}?api-version=2022-09-04
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
cloud
|
path | True |
string |
Nombre del servicio en la nube. |
resource
|
path | True |
string |
Nombre del grupo de recursos. |
subscription
|
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 para cada llamada al servicio. |
api-version
|
query | True |
string |
Versión de api de cliente. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar |
|
Other Status Codes |
Error |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
Get Cloud Service with Multiple Roles and RDP Extension
Sample Request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}?api-version=2022-09-04
Sample Response
{
"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"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
}
}
Definiciones
Nombre | Description |
---|---|
Api |
Error de api. |
Api |
Base de errores de api. |
Cloud |
Respuesta de error del servicio Compute. |
Cloud |
Describe el servicio en la nube. |
Cloud |
Describe un perfil de extensión de servicio en la nube. |
Cloud |
Propiedades de extensión. |
Cloud |
Perfil de red para el servicio en la nube. |
Cloud |
Describe el perfil del sistema operativo para el servicio en la nube. |
Cloud |
Propiedades del servicio en la nube |
Cloud |
Describe el perfil de rol para el servicio en la nube. |
Cloud |
Describe las propiedades del rol. |
Cloud |
Describe la SKU del rol de servicio en la nube. |
Cloud |
Tipo de ranura para el servicio en la nube.
Los valores posibles son |
Cloud |
Modo de actualización para el servicio en la nube. Las instancias de rol se asigna para actualizar dominios cuando se implementa el servicio. Las actualizaciones se pueden iniciar manualmente en cada dominio de actualización o iniciar automáticamente en todos dominios de actualización.
Los valores posibles son |
Cloud |
Configuración protegida para la extensión, a la que se hace referencia mediante KeyVault, que se cifran antes de enviarse a la instancia de rol. |
Cloud |
Describe una única referencia de certificado en un Key Vault y dónde debe residir el certificado en la instancia de rol. |
Cloud |
Describe un conjunto de certificados que están en la misma Key Vault. |
Extension |
Describe una extensión de servicio en la nube. |
Inner |
Detalles del error interno. |
Load |
Describe la configuración del equilibrador de carga. |
Load |
Describe las propiedades de la configuración del equilibrador de carga. |
Load |
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. |
Load |
Describe una configuración de IP de servicio en la nube |
Sub |
|
System |
Metadatos del sistema relacionados con este recurso. |
ApiError
Error de api.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
details |
Detalles del error de api |
|
innererror |
Error interno de api |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error determinado. |
ApiErrorBase
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 determinado. |
CloudError
Respuesta de error del servicio Compute.
Nombre | Tipo | Description |
---|---|---|
error |
Error de api. |
CloudService
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 |
Propiedades del servicio en la nube |
|
systemData |
Metadatos del sistema relacionados con este recurso. |
|
tags |
object |
Etiquetas del recurso. |
type |
string |
Tipo de recurso. |
zones |
string[] |
Lista de la zona de disponibilidad lógica del recurso. La lista debe contener solo 1 zona en la que se debe aprovisionar el servicio en la nube. Este campo es opcional. |
CloudServiceExtensionProfile
Describe un perfil de extensión de servicio en la nube.
Nombre | Tipo | Description |
---|---|---|
extensions |
Lista de extensiones para el servicio en la nube. |
CloudServiceExtensionProperties
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 forceUpdateTag no se cambia, el controlador seguirá aplicando las actualizaciones de 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 es capaz de controlar la implementación de si 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 |
Configuración protegida para la extensión, a la que se hace referencia mediante KeyVault, que se cifran antes de enviarse 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. |
CloudServiceNetworkProfile
Perfil de red para el servicio en la nube.
Nombre | Tipo | Description |
---|---|---|
loadBalancerConfigurations |
Lista de configuraciones del equilibrador de carga. El servicio en la nube puede tener hasta dos configuraciones de equilibrador de carga, que corresponden a un Load Balancer público y a un Load Balancer interno. |
|
slotType |
Tipo de ranura para el servicio en la nube.
Los valores posibles son |
|
swappableCloudService |
Referencia de identificador del servicio en la nube que contiene la dirección IP de destino con la que el servicio en la nube del asunto 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
Describe el perfil del sistema operativo para el servicio en la nube.
Nombre | Tipo | Description |
---|---|---|
secrets |
Especifica el conjunto de certificados que se deben instalar en las instancias de rol. |
CloudServiceProperties
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 |
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 |
Describe un perfil de extensión de servicio en la nube. |
|
networkProfile |
Perfil de red para el servicio en la nube. |
|
osProfile |
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 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 |
Describe el perfil de rol para el servicio en la nube. |
|
startCloudService |
boolean |
(Opcional) Indica si se va a iniciar el servicio en la nube inmediatamente después de crearlo. El valor predeterminado es |
uniqueId |
string |
Identificador único del servicio en la nube. |
upgradeMode |
Modo de actualización para el servicio en la nube. Las instancias de rol se asigna para actualizar dominios cuando se implementa el servicio. Las actualizaciones se pueden iniciar manualmente en cada dominio de actualización o iniciar automáticamente en todos dominios de actualización.
Los valores posibles son |
CloudServiceRoleProfile
Describe el perfil de rol para el servicio en la nube.
Nombre | Tipo | Description |
---|---|---|
roles |
Lista de roles para el servicio en la nube. |
CloudServiceRoleProfileProperties
Describe las propiedades del rol.
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre del recurso. |
sku |
Describe la SKU del rol de servicio en la nube. |
CloudServiceRoleSku
Describe la SKU del rol de servicio en la nube.
Nombre | Tipo | Description |
---|---|---|
capacity |
integer |
Especifica el número de instancias de rol en el servicio en la nube. |
name |
string |
Nombre de la SKU. NOTA: Si la nueva SKU no es compatible con 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 |
CloudServiceSlotType
Tipo de ranura para el servicio en la nube.
Los valores posibles son
Producción
Ensayo
Si no se especifica, el valor predeterminado es Production.
Nombre | Tipo | Description |
---|---|---|
Production |
string |
|
Staging |
string |
CloudServiceUpgradeMode
Modo de actualización para el servicio en la nube. Las instancias de rol se asigna para actualizar dominios cuando se implementa el servicio. Las actualizaciones se pueden iniciar manualmente en cada dominio de actualización o iniciar automáticamente en todos dominios de actualización.
Los valores posibles son
Automático
Manual
Simultánea
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.
Nombre | Tipo | Description |
---|---|---|
Auto |
string |
|
Manual |
string |
|
Simultaneous |
string |
CloudServiceVaultAndSecretReference
Configuración protegida para la extensión, a la que se hace referencia mediante KeyVault, que se cifran antes de enviarse 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 |
Identificador de recurso de ARM del Key Vault |
CloudServiceVaultCertificate
Describe una única referencia de certificado en un Key Vault 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. |
CloudServiceVaultSecretGroup
Describe un conjunto de certificados que están en la misma Key Vault.
Nombre | Tipo | Description |
---|---|---|
sourceVault |
Dirección URL relativa del Key Vault que contiene todos los certificados de VaultCertificates. |
|
vaultCertificates |
Lista de referencias del almacén de claves en SourceVault que contienen certificados. |
Extension
Describe una extensión de servicio en la nube.
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre de la extensión. |
properties |
Propiedades de extensión. |
InnerError
Detalles del error interno.
Nombre | Tipo | Description |
---|---|---|
errordetail |
string |
Mensaje de error interno o volcado de memoria de excepciones. |
exceptiontype |
string |
Tipo de la excepción. |
LoadBalancerConfiguration
Describe la configuración del equilibrador de carga.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Id. de recurso |
name |
string |
Nombre del equilibrador de carga |
properties |
Propiedades de la configuración del equilibrador de carga. |
LoadBalancerConfigurationProperties
Describe las propiedades de la configuración del equilibrador de carga.
Nombre | Tipo | Description |
---|---|---|
frontendIpConfigurations |
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
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 |
Propiedades de la configuración ip de front-end del equilibrador de carga. |
LoadBalancerFrontendIpConfigurationProperties
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 |
Referencia al recurso de dirección IP pública. |
|
subnet |
Referencia al recurso de subred de red virtual. |
SubResource
Nombre | Tipo | Description |
---|---|---|
id |
string |
Id. de recurso |
SystemData
Metadatos del sistema relacionados con este recurso.
Nombre | Tipo | Description |
---|---|---|
createdAt |
string |
Especifica la hora en UTC a la que se creó el recurso servicio en la nube (soporte extendido). |
lastModifiedAt |
string |
Especifica la hora utc a la que se modificó por última vez el recurso servicio en la nube (soporte extendido). |