Partager via


Cloud Services - List

Obtient la liste de tous les services cloud sous un groupe de ressources. Utilisez la propriété nextLink dans la réponse pour obtenir la page suivante de Services cloud. Effectuez cette opération jusqu’à ce que nextLink soit null pour extraire tous les Services cloud.

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

Paramètres URI

Nom Dans Obligatoire 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 l’abonnement Microsoft Azure. 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

Nom Type Description
200 OK

CloudServiceListResult

Ok

Other Status Codes

CloudError

Erreur

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

List Cloud Services in a Resource Group

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
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 de l’extension.

CloudServiceListResult

Résultat de l’opération de liste.

CloudServiceNetworkProfile

Profil réseau pour le service cloud.

CloudServiceOsProfile

Décrit le profil de 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 du rôle.

CloudServiceRoleSku

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

CloudServiceSlotType

Type d’emplacement pour le service cloud. Les valeurs possibles sont

Production

Préproduction

Si elle n’est pas spécifiée, la valeur par défaut est Production.

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

Simultanée

Si elle n’est pas spécifiée, la valeur par défaut est Auto. Si la valeur est Manuelle, PUT UpdateDomain doit être appelée pour appliquer la mise à jour. Si elle est définie sur Auto, la mise à jour est automatiquement appliquée à chaque domaine de mise à jour dans l’ordre.

CloudServiceVaultAndSecretReference

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

CloudServiceVaultCertificate

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

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’équilibreur de charge.

LoadBalancerConfigurationProperties

Décrit les propriétés de la configuration de l’équilibreur de charge.

LoadBalancerFrontendIpConfiguration

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

LoadBalancerFrontendIpConfigurationProperties

Décrit une configuration IP de service cloud

SubResource
SystemData

Métadonnées système relatives à cette ressource.

ApiError

Erreur d’API.

Nom Type Description
code

string

Code d'erreur.

details

ApiErrorBase[]

Détails de l’erreur api

innererror

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.

Nom 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.

Nom Type Description
error

ApiError

Erreur d’API.

CloudService

Décrit le service cloud.

Nom Type Description
id

string

ID de ressource.

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties

CloudServiceProperties

Propriétés du service cloud

systemData

SystemData

Métadonnées système relatives à cette ressource.

tags

object

Balises de ressource.

type

string

Type de ressource.

zones

string[]

Liste de la zone de disponibilité logique de la ressource. La liste ne doit contenir que 1 zone dans laquelle le service cloud doit être provisionné. Ce champ est facultatif.

CloudServiceExtensionProfile

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

Nom Type Description
extensions

Extension[]

Liste des extensions pour le service cloud.

CloudServiceExtensionProperties

Propriétés de l’extension.

Nom Type Description
autoUpgradeMinorVersion

boolean

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

forceUpdateTag

string

Balise pour forcer l’application des 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 paramètre public ou protégé ne change, l’extension est transmise au rôle instance avec le même numéro de séquence, et il appartient à l’implémentation du gestionnaire de la réexécuter ou non

protectedSettings

object

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

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

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

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 des 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

object

Paramètres publics de l’extension. Pour les extensions JSON, il s’agit des paramètres JSON de l’extension. Pour l’extension XML (comme RDP), il s’agit du paramètre XML de 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 dernière version 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 mineure (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 secondaire 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

Résultat de l’opération de liste.

Nom Type Description
nextLink

string

URI permettant d’extraire la page de ressources suivante. Utilisez-le pour obtenir la page suivante de ressources. Effectuez cette opération jusqu’à ce que nextLink soit null pour extraire toutes les ressources.

value

CloudService[]

Liste des ressources.

CloudServiceNetworkProfile

Profil réseau pour le service cloud.

Nom Type Description
loadBalancerConfigurations

LoadBalancerConfiguration[]

Liste des configurations de l’équilibreur de charge. Le service cloud peut avoir jusqu’à deux configurations d’équilibreur de charge, correspondant à un Load Balancer public et à un Load Balancer interne.

slotType

CloudServiceSlotType

Type d’emplacement pour le service cloud. Les valeurs possibles sont

Production

Préproduction

Si elle n’est pas spécifiée, la valeur par défaut est Production.

swappableCloudService

SubResource

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

CloudServiceOsProfile

Décrit le profil de système d’exploitation pour le service cloud.

Nom Type Description
secrets

CloudServiceVaultSecretGroup[]

Spécifie l’ensemble de certificats qui doivent être installés sur les instances de rôle.

CloudServiceProperties

Propriétés du service cloud

Nom Type Description
allowModelOverride

boolean

(Facultatif) Indique si les propriétés de référence sku de rôle (roleProfile.roles.sku) spécifiées dans le modèle/modèle doivent remplacer le nombre de instance rôle et la taille de machine virtuelle spécifiées respectivement dans .cscfg et .csdef. 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 service 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 GET.

extensionProfile

CloudServiceExtensionProfile

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

networkProfile

CloudServiceNetworkProfile

Profil réseau pour le service cloud.

osProfile

CloudServiceOsProfile

Décrit le profil de 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 service 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 GET.

provisioningState

string

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

roleProfile

CloudServiceRoleProfile

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

startCloudService

boolean

(Facultatif) Indique s’il faut démarrer le service cloud immédiatement après sa création. 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 Alimenté jusqu’à ce que vous appeliez Démarrer, à partir duquel le service sera démarré. Un service déployé entraîne toujours des frais, même s’il est hors tension.

uniqueId

string

Identificateur unique du service cloud.

upgradeMode

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

Simultanée

Si elle n’est pas spécifiée, la valeur par défaut est Auto. Si la valeur est Manuelle, PUT UpdateDomain doit être appelée pour appliquer la mise à jour. Si elle 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.

Nom Type Description
roles

CloudServiceRoleProfileProperties[]

Liste des rôles pour le service cloud.

CloudServiceRoleProfileProperties

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

Nom Type Description
name

string

Nom de la ressource.

sku

CloudServiceRoleSku

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.

Nom 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, 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

CloudServiceSlotType

Type d’emplacement pour le service cloud. Les valeurs possibles sont

Production

Préproduction

Si elle n’est pas spécifiée, la valeur par défaut est Production.

Nom Type Description
Production

string

Staging

string

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

Simultanée

Si elle n’est pas spécifiée, la valeur par défaut est Auto. Si la valeur est Manuelle, PUT UpdateDomain doit être appelée pour appliquer la mise à jour. Si elle est définie sur Auto, la mise à jour est automatiquement appliquée à chaque domaine de mise à jour dans l’ordre.

Nom Type Description
Auto

string

Manual

string

Simultaneous

string

CloudServiceVaultAndSecretReference

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

Nom Type Description
secretUrl

string

URL secrète qui contient les paramètres protégés de l’extension

sourceVault

SubResource

ID de ressource ARM du Key Vault

CloudServiceVaultCertificate

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

Nom Type Description
certificateUrl

string

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

CloudServiceVaultSecretGroup

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

Nom Type Description
sourceVault

SubResource

URL relative du Key Vault contenant tous les certificats dans VaultCertificates.

vaultCertificates

CloudServiceVaultCertificate[]

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

Extension

Décrit une extension de service cloud.

Nom Type Description
name

string

Le nom de l'entité d'extension.

properties

CloudServiceExtensionProperties

Propriétés de l’extension.

InnerError

Détails de l’erreur interne.

Nom Type Description
errordetail

string

Message d’erreur interne ou vidage d’exception.

exceptiontype

string

Type d'exception.

LoadBalancerConfiguration

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

Nom Type Description
id

string

ID de ressource

name

string

Nom de l’équilibreur de charge

properties

LoadBalancerConfigurationProperties

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

LoadBalancerConfigurationProperties

Décrit les propriétés de la configuration de l’équilibreur de charge.

Nom Type Description
frontendIpConfigurations

LoadBalancerFrontendIpConfiguration[]

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

LoadBalancerFrontendIpConfiguration

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

Nom Type Description
name

string

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

properties

LoadBalancerFrontendIpConfigurationProperties

Propriétés de la configuration ip frontale de l’équilibreur de charge.

LoadBalancerFrontendIpConfigurationProperties

Décrit une configuration IP de service cloud

Nom Type Description
privateIPAddress

string

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

publicIPAddress

SubResource

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

subnet

SubResource

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

SubResource

Nom Type Description
id

string

ID de ressource

SystemData

Métadonnées système relatives à cette ressource.

Nom Type Description
createdAt

string

Spécifie l’heure UTC à laquelle la ressource de service cloud (support étendu) a été créée.
Version d’API minimale : 04-04-2022.

lastModifiedAt

string

Spécifie l’heure UTC à laquelle la ressource de service cloud (support étendu) a été modifiée pour la dernière fois.
Version d’API minimale : 04-04-2022.