Cloud Services - List

Obtient une liste de tous les services Cloud sous un groupe de ressources. Utilisez la propriété nextLink dans la réponse pour accéder à la page suivante des services Cloud. Procédez ainsi jusqu’à ce que nextLink ait la valeur null pour récupérer tous les services Cloud.

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

Paramètres URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nom du groupe de ressources.

subscriptionId
path True
  • string

Informations d’identification d’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API cliente.

Réponses

Name Type Description
200 OK

Ok

Other Status Codes

Error

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2

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

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

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=2021-03-01

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.1",
                "settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
              }
            }
          ]
        },
        "provisioningState": "Succeeded",
        "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
      }
    }
  ]
}

Définitions

ApiError

Erreur d’API.

ApiErrorBase

Base d’erreurs d’API.

CloudError

Réponse d’erreur du service de calcul.

CloudService

Décrit le service Cloud.

CloudServiceExtensionProfile

Décrit un profil d’extension de service Cloud.

CloudServiceExtensionProperties

Propriétés d’extension.

CloudServiceListResult
CloudServiceNetworkProfile

Profil réseau pour le service Cloud.

CloudServiceOsProfile

Décrit le profil du système d’exploitation pour le service Cloud.

CloudServiceProperties

Propriétés du service Cloud

CloudServiceRoleProfile

Décrit le profil de rôle pour le service Cloud.

CloudServiceRoleProfileProperties

Décrit les propriétés de rôle.

CloudServiceRoleSku

Décrit la référence SKU du rôle de service Cloud.

CloudServiceUpgradeMode

Mode de mise à jour pour le service Cloud. Les instances de rôle sont allouées aux domaines de mise à jour lorsque le service est déployé. Les mises à jour peuvent être appelées manuellement dans chaque domaine de mise à jour ou automatiquement dans tous les domaines de mise à jour. Les valeurs possibles sont

Automatique

Manuel

Dictionnaire

S’il n’est pas spécifié, la valeur par défaut est auto. S’il est défini sur manuel, PUT UpdateDomain doit être appelé pour appliquer la mise à jour. Si cette option est définie sur auto, la mise à jour est automatiquement appliquée à chaque domaine de mise à jour dans l’ordre.

CloudServiceVaultAndSecretReference
CloudServiceVaultCertificate

Décrit une référence de certificat unique dans un Key Vault, et où le certificat doit résider sur l’instance de rôle.

CloudServiceVaultSecretGroup

Décrit un ensemble de certificats qui se trouvent tous dans le même Key Vault.

Extension

Décrit une extension de service Cloud.

InnerError

Détails de l’erreur interne.

LoadBalancerConfiguration

Décrit la configuration de l’équilibrage de charge.

LoadBalancerConfigurationProperties
LoadBalancerFrontendIPConfiguration
LoadBalancerFrontendIPConfigurationProperties

Décrit une configuration IP de service Cloud

SubResource

ApiError

Erreur d’API.

Name Type Description
code
  • string

Code d'erreur.

details

Détails de l’erreur de l’API

innererror

Erreur interne de l’API

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs d’API.

Name Type Description
code
  • string

Code d'erreur.

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur particulière.

CloudError

Réponse d’erreur du service de calcul.

Name Type Description
error

Erreur d’API.

CloudService

Décrit le service Cloud.

Name Type Description
id
  • string

ID de ressource.

location
  • string

Emplacement de la ressource.

name
  • string

Nom de la ressource.

properties

Propriétés du service Cloud

tags
  • object

Balises de ressource.

type
  • string

Type de ressource.

CloudServiceExtensionProfile

Décrit un profil d’extension de service Cloud.

Name Type Description
extensions

Liste des extensions pour le service Cloud.

CloudServiceExtensionProperties

Propriétés d’extension.

Name Type Description
autoUpgradeMinorVersion
  • boolean

Spécifiez explicitement si la plateforme peut automatiquement mettre à niveau typeHandlerVersion vers des versions mineures plus élevées lorsqu’elles deviennent disponibles.

forceUpdateTag
  • string

Tag à forcer appliquez les paramètres publics et protégés fournis. La modification de la valeur de balise permet de réexécuter l’extension sans modifier les paramètres publics ou protégés. Si forceUpdateTag n’est pas modifié, les mises à jour des paramètres publics ou protégés sont toujours appliquées par le gestionnaire. Si ni forceUpdateTag ni aucun des paramètres publics ou protégés ne sont modifiés, l’extension serait transmise à l’instance de rôle avec le même numéro de séquence, et il s’agit d’une implémentation du gestionnaire, qu’elle soit réexécutée ou non

protectedSettings
  • string

Paramètres protégés pour l’extension qui sont chiffrés avant d’être envoyés à l’instance de rôle.

protectedSettingsFromKeyVault
provisioningState
  • string

État d’approvisionnement, qui apparaît uniquement dans la réponse.

publisher
  • string

Nom de l’éditeur du gestionnaire d’extensions.

rolesAppliedTo
  • string[]

Liste facultative de rôles pour appliquer cette extension. Si la propriété n’est pas spécifiée ou si « * » est spécifié, l’extension est appliquée à tous les rôles dans le service Cloud.

settings
  • string

Paramètres publics pour l’extension. Pour les extensions JSON, il s’agit des paramètres JSON pour l’extension. Pour l’extension XML (comme RDP), il s’agit du paramètre XML pour l’extension.

type
  • string

Spécifie le type de l'extension.

typeHandlerVersion
  • string

Spécifie la version de l'extension. Spécifie la version de l'extension. Si cet élément n’est pas spécifié ou si un astérisque (*) est utilisé comme valeur, la version la plus récente de l’extension est utilisée. Si la valeur est spécifiée avec un numéro de version principale et un astérisque comme numéro de version secondaire (X.), la dernière version mineure de la version principale spécifiée est sélectionnée. Si un numéro de version principale et un numéro de version mineure sont spécifiés (X. Y), la version d’extension spécifique est sélectionnée. Si une version est spécifiée, une mise à niveau automatique est effectuée sur l'instance de rôle.

CloudServiceListResult

Name Type Description
nextLink
  • string
value

Décrit le service Cloud.

CloudServiceNetworkProfile

Profil réseau pour le service Cloud.

Name Type Description
loadBalancerConfigurations

Liste des configurations de l’équilibrage de charge. Le service Cloud peut avoir jusqu’à deux configurations d’équilibrage de charge, ce qui correspond à un Load Balancer public et à un Load Balancer interne.

swappableCloudService

Référence d’ID du service Cloud contenant l’adresse IP cible avec laquelle le service Cloud subject peut effectuer un échange. Cette propriété ne peut pas être mise à jour une fois qu’elle est définie. Le service Cloud remplaçable référencé par cet ID doit être présent. sinon, une erreur est levée.

CloudServiceOsProfile

Décrit le profil du système d’exploitation pour le service Cloud.

Name Type Description
secrets

Spécifie le jeu de certificats qui doit être installé sur les instances de rôle.

CloudServiceProperties

Propriétés du service Cloud

Name Type Description
allowModelOverride
  • boolean

Facultatif Indique si les propriétés de la référence SKU du rôle (roleProfile. Roles. SKU) spécifiées dans le modèle/modèle doivent remplacer le nombre d’instances de rôle et la taille de machine virtuelle spécifiées dans les cscfg et. csdef, respectivement. La valeur par défaut est false.

configuration
  • string

Spécifie la configuration du service XML (. cscfg) pour le service Cloud.

configurationUrl
  • string

Spécifie une URL qui fait référence à l’emplacement de la configuration du service dans le service BLOB. L’URL du package de services peut être un URI de signature d’accès partagé (SAS) à partir de n’importe quel compte de stockage. Il s’agit d’une propriété en écriture seule qui n’est pas retournée dans les appels d’accès.

extensionProfile

Décrit un profil d’extension de service Cloud.

networkProfile

Profil réseau pour le service Cloud.

osProfile

Décrit le profil du système d’exploitation pour le service Cloud.

packageUrl
  • string

Spécifie une URL qui fait référence à l'emplacement du package de service dans le service BLOB. L’URL du package de services peut être un URI de signature d’accès partagé (SAS) à partir de n’importe quel compte de stockage. Il s’agit d’une propriété en écriture seule qui n’est pas retournée dans les appels d’accès.

provisioningState
  • string

État d’approvisionnement, qui apparaît uniquement dans la réponse.

roleProfile

Décrit le profil de rôle pour le service Cloud.

startCloudService
  • boolean

Facultatif Indique si le service Cloud doit être démarré immédiatement après avoir été créé. La valeur par défaut est true. Si la valeur est false, le modèle de service est toujours déployé, mais le code n’est pas exécuté immédiatement. Au lieu de cela, le service est PoweredOff jusqu’à ce que vous appeliez Start, moment auquel le service sera démarré. Un service déployé engendre toujours des frais, même s’il s’agit d’poweredoff.

uniqueId
  • string

Identificateur unique du service Cloud.

upgradeMode

Mode de mise à jour pour le service Cloud. Les instances de rôle sont allouées aux domaines de mise à jour lorsque le service est déployé. Les mises à jour peuvent être appelées manuellement dans chaque domaine de mise à jour ou automatiquement dans tous les domaines de mise à jour. Les valeurs possibles sont

Automatique

Manuel

Dictionnaire

S’il n’est pas spécifié, la valeur par défaut est auto. S’il est défini sur manuel, PUT UpdateDomain doit être appelé pour appliquer la mise à jour. Si cette option est définie sur auto, la mise à jour est automatiquement appliquée à chaque domaine de mise à jour dans l’ordre.

CloudServiceRoleProfile

Décrit le profil de rôle pour le service Cloud.

Name Type Description
roles

Liste des rôles pour le service Cloud.

CloudServiceRoleProfileProperties

Décrit les propriétés de rôle.

Name Type Description
name
  • string

Nom de la ressource.

sku

Décrit la référence SKU du rôle de service Cloud.

CloudServiceRoleSku

Décrit la référence SKU du rôle de service Cloud.

Name Type Description
capacity
  • integer

Spécifie le nombre d’instances de rôle dans le service Cloud.

name
  • string

Nom de la référence (SKU). Remarque : si la nouvelle référence (SKU) n’est pas prise en charge sur le matériel sur lequel le service Cloud est actuellement utilisé, vous devez supprimer et recréer le service Cloud ou revenir à l’ancienne référence SKU.

tier
  • string

Spécifie le niveau du service Cloud. Les valeurs possibles sont

Standard

De base

CloudServiceUpgradeMode

Mode de mise à jour pour le service Cloud. Les instances de rôle sont allouées aux domaines de mise à jour lorsque le service est déployé. Les mises à jour peuvent être appelées manuellement dans chaque domaine de mise à jour ou automatiquement dans tous les domaines de mise à jour. Les valeurs possibles sont

Automatique

Manuel

Dictionnaire

S’il n’est pas spécifié, la valeur par défaut est auto. S’il est défini sur manuel, PUT UpdateDomain doit être appelé pour appliquer la mise à jour. Si cette option est définie sur auto, la mise à jour est automatiquement appliquée à chaque domaine de mise à jour dans l’ordre.

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

CloudServiceVaultAndSecretReference

Name Type Description
secretUrl
  • string
sourceVault

CloudServiceVaultCertificate

Décrit une référence de certificat unique dans un Key Vault, et où le certificat doit résider sur l’instance de rôle.

Name Type Description
certificateUrl
  • string

Il s’agit de l’URL d’un certificat qui a été chargé sur Key Vault en tant que secret.

CloudServiceVaultSecretGroup

Décrit un ensemble de certificats qui se trouvent tous dans le même Key Vault.

Name Type Description
sourceVault

URL relative de l’Key Vault contenant tous les certificats dans VaultCertificates.

vaultCertificates

Liste des références de coffre de clés dans SourceVault qui contiennent des certificats.

Extension

Décrit une extension de service Cloud.

Name Type Description
name
  • string

Le nom de l'entité d'extension.

properties

Propriétés d’extension.

InnerError

Détails de l’erreur interne.

Name Type Description
errordetail
  • string

Le message d’erreur interne ou le vidage de l’exception.

exceptiontype
  • string

Type d'exception.

LoadBalancerConfiguration

Décrit la configuration de l’équilibrage de charge.

Name Type Description
id
  • string

ID de ressource

name
  • string

Nom de l’équilibreur de charge

properties

Propriétés de la configuration de l’équilibrage de charge.

LoadBalancerConfigurationProperties

Name Type Description
frontendIPConfigurations

Spécifie l’adresse IP frontale à utiliser pour l’équilibrage de charge. Seule l’adresse IP frontale IPv4 est prise en charge. Chaque configuration d’équilibrage de charge doit avoir une seule configuration IP frontale.

LoadBalancerFrontendIPConfiguration

Name Type Description
name
  • string

Nom de la ressource qui est unique dans le jeu de configurations IP frontales utilisé par l’équilibreur de charge. Ce nom peut être utilisé pour accéder à la ressource.

properties

Propriétés de la configuration d’adresse IP frontale d’équilibrage de charge.

LoadBalancerFrontendIPConfigurationProperties

Décrit une configuration IP de service Cloud

Name Type Description
privateIPAddress
  • string

Adresse IP privée du réseau virtuel de la configuration IP.

publicIPAddress

Référence à la ressource d’adresse IP publique.

subnet

Référence à la ressource de sous-réseau de réseau virtuel.

SubResource

Name Type Description
id
  • string

ID de ressource