Partilhar via


Cloud Services - Get

Exibir informações sobre um serviço de nuvem.

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

Parâmetros do URI

Name Em Necessário Tipo Description
cloudServiceName
path True

string

Nome do serviço de nuvem.

resourceGroupName
path True

string

Nome do grupo de recursos.

subscriptionId
path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

api-version
query True

string

Versão da API do cliente.

Respostas

Name Tipo Description
200 OK

CloudService

OK

Other Status Codes

CloudError

Erro

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Get Cloud Service with Multiple Roles and RDP Extension

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
ApiError

Erro de api.

ApiErrorBase

Base de erro da api.

CloudError

Uma resposta de erro do serviço de computação.

CloudService

Descreve o serviço de nuvem.

CloudServiceExtensionProfile

Descreve um perfil de extensão de serviço de nuvem.

CloudServiceExtensionProperties

Propriedades de extensão.

CloudServiceNetworkProfile

Perfil de rede para o serviço de nuvem.

CloudServiceOsProfile

Descreve o perfil do sistema operacional para o serviço de nuvem.

CloudServiceProperties

Propriedades do serviço de nuvem

CloudServiceRoleProfile

Descreve o perfil de função para o serviço de nuvem.

CloudServiceRoleProfileProperties

Descreve as propriedades da função.

CloudServiceRoleSku

Descreve a função de serviço de nuvem sku.

CloudServiceSlotType

Tipo de slot para o serviço de nuvem. Os valores possíveis são

Produção

Encenação

Se não for especificado, o valor padrão será Production.

CloudServiceUpgradeMode

Modo de atualização para o serviço de nuvem. As instâncias de função são alocadas para atualizar domínios quando o serviço é implantado. As atualizações podem ser iniciadas manualmente em cada domínio de atualização ou iniciadas automaticamente em todos os domínios de atualização. Os valores possíveis são

Auto

Manual

simultâneo

Se não for especificado, o valor padrão será Auto. Se definido como Manual, PUT UpdateDomain deve ser chamado para aplicar a atualização. Se definido como Automático, a atualização é aplicada automaticamente a cada domínio de atualização em sequência.

CloudServiceVaultAndSecretReference

Configurações protegidas para a extensão, referenciadas usando KeyVault que são criptografadas antes de enviadas para a instância de função.

CloudServiceVaultCertificate

Descreve uma única referência de certificado em um Cofre de Chaves e onde o certificado deve residir na instância de função.

CloudServiceVaultSecretGroup

Descreve um conjunto de certificados que estão todos no mesmo Cofre de Chaves.

Extension

Descreve uma extensão de serviço de nuvem.

InnerError

Detalhes do erro interno.

LoadBalancerConfiguration

Descreve a configuração do balanceador de carga.

LoadBalancerConfigurationProperties

Descreve as propriedades da configuração do balanceador de carga.

LoadBalancerFrontendIpConfiguration

Especifica o IP de frontend a ser usado para o balanceador de carga. Apenas o endereço IP frontend IPv4 é suportado. Cada configuração de balanceador de carga deve ter exatamente uma configuração de IP frontend.

LoadBalancerFrontendIpConfigurationProperties

Descreve uma configuração IP do serviço de nuvem

SubResource
SystemData

Os metadados do sistema relacionados a este recurso.

ApiError

Erro de api.

Name Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro Api

innererror

InnerError

O erro interno da Api

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

CloudError

Uma resposta de erro do serviço de computação.

Name Tipo Description
error

ApiError

Erro de api.

CloudService

Descreve o serviço de nuvem.

Name Tipo Description
id

string

Id do recurso.

location

string

Localização do recurso.

name

string

Nome do recurso.

properties

CloudServiceProperties

Propriedades do serviço de nuvem

systemData

SystemData

Os metadados do sistema relacionados a este recurso.

tags

object

Tags de recursos.

type

string

Tipo de recurso.

zones

string[]

Lista da zona de disponibilidade lógica do recurso. A lista deve conter apenas 1 zona onde o serviço de nuvem deve ser provisionado. Este campo é opcional.

CloudServiceExtensionProfile

Descreve um perfil de extensão de serviço de nuvem.

Name Tipo Description
extensions

Extension[]

Lista de extensões para o serviço de nuvem.

CloudServiceExtensionProperties

Propriedades de extensão.

Name Tipo Description
autoUpgradeMinorVersion

boolean

Especifique explicitamente se a plataforma pode atualizar automaticamente typeHandlerVersion para versões secundárias superiores quando elas estiverem disponíveis.

forceUpdateTag

string

Marque para forçar a aplicação das configurações públicas e protegidas fornecidas. Alterar o valor da tag permite executar novamente a extensão sem alterar nenhuma das configurações públicas ou protegidas. Se forceUpdateTag não for alterado, as atualizações para configurações públicas ou protegidas ainda serão aplicadas pelo manipulador. Se nem forceUpdateTag nem nenhuma das configurações públicas ou protegidas forem alteradas, a extensão fluirá para a instância de função com o mesmo número de sequência, e cabe à implementação do manipulador executá-la novamente ou não

protectedSettings

object

Configurações protegidas para a extensão que são criptografadas antes de serem enviadas para a instância de função.

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

Configurações protegidas para a extensão, referenciadas usando KeyVault que são criptografadas antes de enviadas para a instância de função.

provisioningState

string

O estado de provisionamento, que só aparece na resposta.

publisher

string

O nome do editor do manipulador de extensão.

rolesAppliedTo

string[]

Lista opcional de funções para aplicar esta extensão. Se a propriedade não for especificada ou '*' for especificado, a extensão será aplicada a todas as funções no serviço de nuvem.

settings

object

Configurações públicas para a extensão. Para extensões JSON, estas são as configurações JSON para a extensão. Para Extensão XML (como RDP), esta é a configuração XML para a extensão.

type

string

Especifica o tipo da extensão.

typeHandlerVersion

string

Especifica a versão da extensão. Especifica a versão da extensão. Se este elemento não for especificado ou um asterisco (*) for usado como valor, a versão mais recente da extensão será usada. Se o valor for especificado com um número de versão principal e um asterisco como o número de versão secundária (X.), a versão secundária mais recente da versão principal especificada será selecionada. Se um número de versão principal e um número de versão secundária forem especificados (X.Y), a versão de extensão específica será selecionada. Se uma versão for especificada, uma atualização automática será executada na instância de função.

CloudServiceNetworkProfile

Perfil de rede para o serviço de nuvem.

Name Tipo Description
loadBalancerConfigurations

LoadBalancerConfiguration[]

Lista de configurações do balanceador de carga. O serviço de nuvem pode ter até duas configurações de balanceador de carga, correspondendo a um Balanceador de Carga Público e a um Balanceador de Carga Interno.

slotType

CloudServiceSlotType

Tipo de slot para o serviço de nuvem. Os valores possíveis são

Produção

Encenação

Se não for especificado, o valor padrão será Production.

swappableCloudService

SubResource

A referência de id do serviço de nuvem que contém o IP de destino com o qual o serviço de nuvem sujeito pode realizar uma troca. Esta propriedade não pode ser atualizada depois de definida. O serviço de nuvem permutável referido por este id deve estar presente, caso contrário, um erro será lançado.

CloudServiceOsProfile

Descreve o perfil do sistema operacional para o serviço de nuvem.

Name Tipo Description
secrets

CloudServiceVaultSecretGroup[]

Especifica o conjunto de certificados que devem ser instalados nas instâncias de função.

CloudServiceProperties

Propriedades do serviço de nuvem

Name Tipo Description
allowModelOverride

boolean

(Opcional) Indica se as propriedades de sku de função (roleProfile.roles.sku) especificadas no modelo/modelo devem substituir a contagem de instâncias de função e o tamanho da vm especificados em .cscfg e .csdef, respectivamente. O valor padrão é false.

configuration

string

Especifica a configuração do serviço XML (.cscfg) para o serviço de nuvem.

configurationUrl

string

Especifica uma URL que se refere ao local da configuração do serviço no serviço Blob. A URL do pacote de serviço pode ser URI de Assinatura de Acesso Compartilhado (SAS) de qualquer conta de armazenamento. Esta é uma propriedade somente gravação e não é retornada em chamadas GET.

extensionProfile

CloudServiceExtensionProfile

Descreve um perfil de extensão de serviço de nuvem.

networkProfile

CloudServiceNetworkProfile

Perfil de rede para o serviço de nuvem.

osProfile

CloudServiceOsProfile

Descreve o perfil do sistema operacional para o serviço de nuvem.

packageUrl

string

Especifica uma URL que se refere ao local do pacote de serviço no serviço Blob. A URL do pacote de serviço pode ser URI de Assinatura de Acesso Compartilhado (SAS) de qualquer conta de armazenamento. Esta é uma propriedade somente gravação e não é retornada em chamadas GET.

provisioningState

string

O estado de provisionamento, que só aparece na resposta.

roleProfile

CloudServiceRoleProfile

Descreve o perfil de função para o serviço de nuvem.

startCloudService

boolean

(Opcional) Indica se o serviço de nuvem deve ser iniciado imediatamente após sua criação. O valor padrão é true. Se false, o modelo de serviço ainda é implantado, mas o código não é executado imediatamente. Em vez disso, o serviço é PoweredOff até que você chame Iniciar, momento em que o serviço será iniciado. Um serviço implantado ainda incorre em encargos, mesmo que esteja desligado.

uniqueId

string

O identificador exclusivo do serviço de nuvem.

upgradeMode

CloudServiceUpgradeMode

Modo de atualização para o serviço de nuvem. As instâncias de função são alocadas para atualizar domínios quando o serviço é implantado. As atualizações podem ser iniciadas manualmente em cada domínio de atualização ou iniciadas automaticamente em todos os domínios de atualização. Os valores possíveis são

Auto

Manual

simultâneo

Se não for especificado, o valor padrão será Auto. Se definido como Manual, PUT UpdateDomain deve ser chamado para aplicar a atualização. Se definido como Automático, a atualização é aplicada automaticamente a cada domínio de atualização em sequência.

CloudServiceRoleProfile

Descreve o perfil de função para o serviço de nuvem.

Name Tipo Description
roles

CloudServiceRoleProfileProperties[]

Lista de funções para o serviço de nuvem.

CloudServiceRoleProfileProperties

Descreve as propriedades da função.

Name Tipo Description
name

string

Nome do recurso.

sku

CloudServiceRoleSku

Descreve a função de serviço de nuvem sku.

CloudServiceRoleSku

Descreve a função de serviço de nuvem sku.

Name Tipo Description
capacity

integer

Especifica o número de instâncias de função no serviço de nuvem.

name

string

O nome do sku. NOTA: Se a nova SKU não for suportada no hardware em que o serviço de nuvem está atualmente, você precisará excluir e recriar o serviço de nuvem ou voltar para a sku antiga.

tier

string

Especifica a camada do serviço de nuvem. Os valores possíveis são

Standard

Básico

CloudServiceSlotType

Tipo de slot para o serviço de nuvem. Os valores possíveis são

Produção

Encenação

Se não for especificado, o valor padrão será Production.

Valor Description
Production
Staging

CloudServiceUpgradeMode

Modo de atualização para o serviço de nuvem. As instâncias de função são alocadas para atualizar domínios quando o serviço é implantado. As atualizações podem ser iniciadas manualmente em cada domínio de atualização ou iniciadas automaticamente em todos os domínios de atualização. Os valores possíveis são

Auto

Manual

simultâneo

Se não for especificado, o valor padrão será Auto. Se definido como Manual, PUT UpdateDomain deve ser chamado para aplicar a atualização. Se definido como Automático, a atualização é aplicada automaticamente a cada domínio de atualização em sequência.

Valor Description
Auto
Manual
Simultaneous

CloudServiceVaultAndSecretReference

Configurações protegidas para a extensão, referenciadas usando KeyVault que são criptografadas antes de enviadas para a instância de função.

Name Tipo Description
secretUrl

string

URL secreto que contém as configurações protegidas da extensão

sourceVault

SubResource

O ID do recurso ARM do Cofre da Chave

CloudServiceVaultCertificate

Descreve uma única referência de certificado em um Cofre de Chaves e onde o certificado deve residir na instância de função.

Name Tipo Description
certificateUrl

string

Este é o URL de um certificado que foi carregado para o Cofre da Chave como um segredo.

isBootstrapCertificate

boolean

Sinalizador que indica se o certificado fornecido é um certificado de bootstrap a ser usado pela Extensão do Cofre de Chaves para buscar os certificados restantes.

CloudServiceVaultSecretGroup

Descreve um conjunto de certificados que estão todos no mesmo Cofre de Chaves.

Name Tipo Description
sourceVault

SubResource

A URL relativa do Cofre da Chave que contém todos os certificados em VaultCertificates.

vaultCertificates

CloudServiceVaultCertificate[]

A lista de referências do cofre de chaves no SourceVault que contêm certificados.

Extension

Descreve uma extensão de serviço de nuvem.

Name Tipo Description
name

string

O nome da extensão.

properties

CloudServiceExtensionProperties

Propriedades de extensão.

InnerError

Detalhes do erro interno.

Name Tipo Description
errordetail

string

A mensagem de erro interna ou despejo de exceção.

exceptiontype

string

O tipo de exceção.

LoadBalancerConfiguration

Descreve a configuração do balanceador de carga.

Name Tipo Description
id

string

ID do recurso

name

string

O nome do balanceador de carga

properties

LoadBalancerConfigurationProperties

Propriedades da configuração do balanceador de carga.

LoadBalancerConfigurationProperties

Descreve as propriedades da configuração do balanceador de carga.

Name Tipo Description
frontendIpConfigurations

LoadBalancerFrontendIpConfiguration[]

Especifica o IP de frontend a ser usado para o balanceador de carga. Apenas o endereço IP frontend IPv4 é suportado. Cada configuração de balanceador de carga deve ter exatamente uma configuração de IP frontend.

LoadBalancerFrontendIpConfiguration

Especifica o IP de frontend a ser usado para o balanceador de carga. Apenas o endereço IP frontend IPv4 é suportado. Cada configuração de balanceador de carga deve ter exatamente uma configuração de IP frontend.

Name Tipo Description
name

string

O nome do recurso que é exclusivo dentro do conjunto de configurações de IP frontend usado pelo balanceador de carga. Esse nome pode ser usado para acessar o recurso.

properties

LoadBalancerFrontendIpConfigurationProperties

Propriedades da configuração ip frontend do balanceador de carga.

LoadBalancerFrontendIpConfigurationProperties

Descreve uma configuração IP do serviço de nuvem

Name Tipo Description
privateIPAddress

string

O endereço IP privado da rede virtual da configuração IP.

publicIPAddress

SubResource

A referência ao recurso de endereço IP público.

subnet

SubResource

A referência ao recurso de sub-rede de rede virtual.

SubResource

Name Tipo Description
id

string

ID do recurso

SystemData

Os metadados do sistema relacionados a este recurso.

Name Tipo Description
createdAt

string

Especifica a hora em UTC em que o recurso Serviço de Nuvem (suporte estendido) foi criado.
Versão api mínima: 2022-04-04.

lastModifiedAt

string

Especifica a hora em UTC em que o recurso Serviço de Nuvem (suporte estendido) foi modificado pela última vez.
Versão api mínima: 2022-04-04.