Cloud Services - List

Obtém uma lista de todos os serviços de nuvem em um grupo de recursos. Use a propriedade nextLink na resposta para obter a próxima página de Serviços de Nuvem. Faça isso até que nextLink seja nulo para buscar todos os Serviços de Nuvem.

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

Parâmetros de URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nome do grupo de recursos.

subscriptionId
path True
  • string

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

api-version
query True
  • string

Versão da API do Cliente.

Respostas

Name Type Description
200 OK

OK

Other Status Codes

Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

List Cloud Services in a Resource Group

Sample Request

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

Sample Response

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

Definições

ApiError

Erro de API.

ApiErrorBase

Base de erros 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 da extensão.

CloudServiceListResult

O resultado da operação de lista.

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 do serviço de nuvem.

CloudServiceRoleProfileProperties

Descreve as propriedades da função.

CloudServiceRoleSku

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

CloudServiceSlotType

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

Produção

Preparo

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

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 ser iniciadas automaticamente em todos os domínios da atualização. Valores possíveis são

Auto

Manual

Simultânea

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 será 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 serem enviadas para a instância de função.

CloudServiceVaultCertificate

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

CloudServiceVaultSecretGroup

Descreve um conjunto de certificados que estão todos no mesmo Key Vault.

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 front-end a ser usado para o balanceador de carga. Há suporte apenas para o endereço IP de front-end IPv4. Cada configuração do balanceador de carga deve ter exatamente uma configuração de IP de front-end.

LoadBalancerFrontendIPConfigurationProperties

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

SubResource
SystemData

Os metadados do sistema relacionados a esse recurso.

ApiError

Erro de API.

Name Type Description
code
  • string

O código de erro.

details

Os detalhes do erro da API

innererror

O erro interno da API

message
  • string

A mensagem de erro.

target
  • string

O destino do erro específico.

ApiErrorBase

Base de erros da API.

Name Type Description
code
  • string

O código de erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro específico.

CloudError

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

Name Type Description
error

Erro de API.

CloudService

Descreve o serviço de nuvem.

Name Type Description
id
  • string

ID do recurso.

location
  • string

Local do recurso.

name
  • string

Nome do recurso.

properties

Propriedades do serviço de nuvem

systemData

Os metadados do sistema relacionados a esse recurso.

tags
  • object

Marcas de recurso.

type
  • string

Tipo de recurso.

CloudServiceExtensionProfile

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

Name Type Description
extensions

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

CloudServiceExtensionProperties

Propriedades da extensão.

Name Type Description
autoUpgradeMinorVersion
  • boolean

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

forceUpdateTag
  • string

Marca para forçar a aplicação das configurações públicas e protegidas fornecidas. Alterar o valor da marca 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

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

provisioningState
  • string

O estado de provisionamento, que aparece apenas na resposta.

publisher
  • string

O nome do editor do manipulador de extensão.

rolesAppliedTo
  • string[]

Lista opcional de funções para aplicar essa extensão. Se a propriedade não for especificada ou '*' for especificada, 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 a extensão XML (como RDP), essa é 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 esse elemento não for especificado ou um asterisco (*) for usado como o 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.

CloudServiceListResult

O resultado da operação de lista.

Name Type Description
nextLink
  • string

O URI para buscar a próxima página de recursos. Use isso para obter a próxima página de recursos. Faça isso até que nextLink seja nulo para buscar todos os recursos.

value

A lista de recursos.

CloudServiceNetworkProfile

Perfil de Rede para o serviço de nuvem.

Name Type Description
loadBalancerConfigurations

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

slotType

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

Produção

Preparo

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

swappableCloudService

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 do assunto pode executar uma troca. Essa propriedade não pode ser atualizada depois de definida. O serviço de nuvem permutável referenciado por essa ID deve estar presente, caso contrário, um erro será gerado.

CloudServiceOsProfile

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

Name Type Description
secrets

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

CloudServiceProperties

Propriedades do serviço de nuvem

Name Type 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 no .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 de serviço no serviço Blob. A URL do pacote de serviço pode ser o URI de SAS (Assinatura de Acesso Compartilhado) de qualquer conta de armazenamento. Esta é uma propriedade somente gravação e não é retornada em chamadas GET.

extensionProfile

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

networkProfile

Perfil de Rede para o serviço de nuvem.

osProfile

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

packageUrl
  • string

Especifica uma URL que faz referência ao local do pacote de serviço no serviço Blob. A URL do pacote de serviço pode ser o URI de SAS (Assinatura de Acesso Compartilhado) 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 aparece apenas na resposta.

roleProfile

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

startCloudService
  • boolean

(Opcional) Indica se o serviço de nuvem deve ser iniciado imediatamente após a criação. O valor padrão é true. Se for falso, o modelo de serviço ainda será implantado, mas o código não será 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 seja desacionado.

uniqueId
  • string

O identificador exclusivo para o serviço de nuvem.

upgradeMode

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 ser iniciadas automaticamente em todos os domínios da atualização. Valores possíveis são

Auto

Manual

Simultânea

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 será aplicada automaticamente a cada domínio de atualização em sequência.

CloudServiceRoleProfile

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

Name Type Description
roles

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

CloudServiceRoleProfileProperties

Descreve as propriedades da função.

Name Type Description
name
  • string

Nome do recurso.

sku

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

CloudServiceRoleSku

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

Name Type Description
capacity
  • integer

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

name
  • string

O nome do sku. OBSERVAÇÃO: se não houver suporte para a nova SKU 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

Basic

CloudServiceSlotType

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

Produção

Preparo

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

Name Type Description
Production
  • string
Staging
  • string

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 ser iniciadas automaticamente em todos os domínios da atualização. Valores possíveis são

Auto

Manual

Simultânea

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 será aplicada automaticamente a cada domínio de atualização em sequência.

Name Type Description
Auto
  • string
Manual
  • string
Simultaneous
  • string

CloudServiceVaultAndSecretReference

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

Name Type Description
secretUrl
  • string

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

sourceVault

A ID de recurso do ARM do Key Vault

CloudServiceVaultCertificate

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

Name Type Description
certificateUrl
  • string

Essa é a URL de um certificado que foi carregado para Key Vault como um segredo.

CloudServiceVaultSecretGroup

Descreve um conjunto de certificados que estão todos no mesmo Key Vault.

Name Type Description
sourceVault

A URL relativa do Key Vault que contém todos os certificados no VaultCertificates.

vaultCertificates

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 Type Description
name
  • string

O nome da extensão.

properties

Propriedades da extensão.

InnerError

Detalhes do erro interno.

Name Type 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 Type Description
id
  • string

ID do recurso

name
  • string

O nome do balanceador de carga

properties

Propriedades da configuração do balanceador de carga.

LoadBalancerConfigurationProperties

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

Name Type Description
frontendIPConfigurations

Especifica o IP de front-end a ser usado para o balanceador de carga. Há suporte apenas para o endereço IP de front-end IPv4. Cada configuração do balanceador de carga deve ter exatamente uma configuração de IP de front-end.

LoadBalancerFrontendIPConfiguration

Especifica o IP de front-end a ser usado para o balanceador de carga. Há suporte apenas para o endereço IP de front-end IPv4. Cada configuração do balanceador de carga deve ter exatamente uma configuração de IP de front-end.

Name Type Description
name
  • string

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

properties

Propriedades da configuração de ip de front-end do balanceador de carga.

LoadBalancerFrontendIPConfigurationProperties

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

Name Type Description
privateIPAddress
  • string

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

publicIPAddress

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

subnet

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

SubResource

Name Type Description
id
  • string

ID do recurso

SystemData

Os metadados do sistema relacionados a esse recurso.

Name Type Description
createdAt
  • string

Especifica a hora em UTC em que o recurso serviço de nuvem (suporte estendido) foi criado.
Versão mínima da api: 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 mínima da api: 2022-04-04.