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 do Serviços de Nuvem. Faça isso até nextLink ser 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-09-04
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nome do grupo de recursos. |
subscription
|
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
Nome | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Erro |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | 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-09-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
Nome | Description |
---|---|
Api |
Erro de API. |
Api |
Base de erros de API. |
Cloud |
Uma resposta de erro do serviço de computação. |
Cloud |
Descreve o serviço de nuvem. |
Cloud |
Descreve um perfil de extensão de serviço de nuvem. |
Cloud |
Propriedades da extensão. |
Cloud |
O resultado da operação de lista. |
Cloud |
Perfil de rede para o serviço de nuvem. |
Cloud |
Descreve o perfil do sistema operacional para o serviço de nuvem. |
Cloud |
Propriedades do serviço de nuvem |
Cloud |
Descreve o perfil de função para o serviço de nuvem. |
Cloud |
Descreve as propriedades da função. |
Cloud |
Descreve o SKU da função de serviço de nuvem. |
Cloud |
Tipo de slot para o serviço de nuvem.
Os valores possíveis são: |
Cloud |
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.
Os valores possíveis são |
Cloud |
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. |
Cloud |
Descreve uma única referência de certificado em um Key Vault e onde o certificado deve residir na instância de função. |
Cloud |
Descreve um conjunto de certificados que estão todos no mesmo Key Vault. |
Extension |
Descreve uma extensão de serviço de nuvem. |
Inner |
Detalhes do erro interno. |
Load |
Descreve a configuração do balanceador de carga. |
Load |
Descreve as propriedades da configuração do balanceador de carga. |
Load |
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. |
Load |
Descreve uma configuração de IP do serviço de nuvem |
Sub |
|
System |
Os metadados do sistema relacionados a esse recurso. |
ApiError
Erro de API.
Nome | Tipo | 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 de API.
Nome | Tipo | 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.
Nome | Tipo | Description |
---|---|---|
error |
Erro de API. |
CloudService
Descreve o serviço de nuvem.
Nome | Tipo | 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. |
zones |
string[] |
Lista de zonas de disponibilidade lógica do recurso. A lista deve conter apenas uma zona em que o serviço de nuvem deve ser provisionado. Esse campo é opcional. |
CloudServiceExtensionProfile
Descreve um perfil de extensão de serviço de nuvem.
Nome | Tipo | Description |
---|---|---|
extensions |
Lista de extensões para o serviço de nuvem. |
CloudServiceExtensionProperties
Propriedades da extensão.
Nome | Tipo | 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 |
Marque 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 da 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.
Nome | Tipo | 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é nextLink ser nulo para buscar todos os recursos. |
value |
A lista de recursos. |
CloudServiceNetworkProfile
Perfil de rede para o serviço de nuvem.
Nome | Tipo | 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 uma Load Balancer Pública e a uma Load Balancer Interna. |
|
slotType |
Tipo de slot para o serviço de nuvem.
Os valores possíveis sã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 de 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.
Nome | Tipo | Description |
---|---|---|
secrets |
Especifica o conjunto de certificados que devem ser instalados nas instâncias de função. |
CloudServiceProperties
Propriedades do serviço de nuvem
Nome | 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 no .cscfg e .csdef, respectivamente.
O valor padrão é |
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 o URI de SAS (Assinatura de Acesso Compartilhado) de qualquer conta de armazenamento. Essa é 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. Essa é 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 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 é |
uniqueId |
string |
O identificador exclusivo do 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.
Os valores possíveis são |
CloudServiceRoleProfile
Descreve o perfil de função para o serviço de nuvem.
Nome | Tipo | Description |
---|---|---|
roles |
Lista de funções para o serviço de nuvem. |
CloudServiceRoleProfileProperties
Descreve as propriedades da função.
Nome | Tipo | 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.
Nome | Tipo | Description |
---|---|---|
capacity |
integer |
Especifica o número de instâncias de função no serviço de nuvem. |
name |
string |
O nome da SKU. OBSERVAÇÃO: se não houver suporte para o novo 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 |
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.
Nome | Tipo | 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.
Os 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 deverá 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.
Nome | Tipo | 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.
Nome | Tipo | Description |
---|---|---|
secretUrl |
string |
URL secreta que contém as configurações protegidas da extensão |
sourceVault |
A ID do recurso 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.
Nome | Tipo | 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.
Nome | Tipo | Description |
---|---|---|
sourceVault |
A URL relativa do Key Vault que contém todos os certificados em 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.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome da extensão. |
properties |
Propriedades da extensão. |
InnerError
Detalhes do erro interno.
Nome | Tipo | Description |
---|---|---|
errordetail |
string |
A mensagem de erro interna ou o despejo de exceção. |
exceptiontype |
string |
O tipo de exceção. |
LoadBalancerConfiguration
Descreve a configuração do balanceador de carga.
Nome | Tipo | 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.
Nome | Tipo | 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.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome do recurso que é exclusivo dentro do conjunto de configurações de IP de front-end usadas 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
Nome | Tipo | 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
Nome | Tipo | Description |
---|---|---|
id |
string |
ID do recurso |
SystemData
Os metadados do sistema relacionados a esse recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
Especifica a hora em UTC em que o recurso serviço de nuvem (suporte estendido) foi criado. |
lastModifiedAt |
string |
Especifica a hora em UTC em que o recurso de Serviço de Nuvem (suporte estendido) foi modificado pela última vez. |