Cloud Services - Get
Affichez des informations sur un service cloud.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}?api-version=2024-11-04
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
cloud
|
path | True |
string |
Nom du service cloud. |
resource
|
path | True |
string |
Nom du groupe de ressources. |
subscription
|
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 de chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API cliente. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
D’ACCORD |
|
Other Status Codes |
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
Get Cloud Service with Multiple Roles and RDP Extension
Exemple de requête
Exemple de réponse
{
"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"
}
}
Définitions
Nom | Description |
---|---|
Api |
Erreur d’API. |
Api |
Base d’erreurs d’API. |
Cloud |
Réponse d’erreur du service de calcul. |
Cloud |
Décrit le service cloud. |
Cloud |
Décrit un profil d’extension de service cloud. |
Cloud |
Propriétés de l’extension. |
Cloud |
Profil réseau pour le service cloud. |
Cloud |
Décrit le profil du système d’exploitation pour le service cloud. |
Cloud |
Propriétés du service cloud |
Cloud |
Décrit le profil de rôle pour le service cloud. |
Cloud |
Décrit les propriétés du rôle. |
Cloud |
Décrit la référence SKU du rôle de service cloud. |
Cloud |
Type d’emplacement pour le service cloud.
Les valeurs possibles sont |
Cloud |
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 lancées manuellement dans chaque domaine de mise à jour ou lancées automatiquement dans tous les domaines de mise à jour.
Les valeurs possibles sont |
Cloud |
Paramètres protégés de l’extension, référencés à l’aide de KeyVault qui sont chiffrés avant d’être envoyés à l’instance de rôle. |
Cloud |
Décrit une référence de certificat unique dans un coffre de clés et où le certificat doit résider sur l’instance de rôle. |
Cloud |
Décrit un ensemble de certificats qui se trouvent tous dans le même coffre de clés. |
Extension |
Décrit une extension de service cloud. |
Inner |
Détails de l’erreur interne. |
Load |
Décrit la configuration de l’équilibreur de charge. |
Load |
Décrit les propriétés de la configuration de l’équilibreur de charge. |
Load |
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 frontale. |
Load |
Décrit une configuration IP du service cloud |
Sub |
|
System |
Métadonnées système relatives à cette ressource. |
ApiError
Erreur d’API.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. |
details |
Détails de l’erreur 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.
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 |
Erreur d’API. |
CloudService
Décrit le service cloud.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource. |
location |
string |
Emplacement des ressources. |
name |
string |
Nom de la ressource. |
properties |
Propriétés du service cloud |
|
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 où le service cloud doit être approvisionné. Ce champ est facultatif. |
CloudServiceExtensionProfile
Décrit un profil d’extension de service cloud.
Nom | Type | Description |
---|---|---|
extensions |
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 à niveau automatiquement 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écter 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 change, l’extension est transmise à l’instance de rôle avec le même numéro de séquence et elle est jusqu’à l’implémentation du gestionnaire s’il faut le réexécuter ou non |
protectedSettings |
object |
Paramètres protégés pour l’extension qui sont chiffrés avant d’être envoyés à l’instance de rôle. |
protectedSettingsFromKeyVault |
Paramètres protégés de l’extension, référencés à l’aide de KeyVault qui sont chiffrés avant d’être envoyés à l’instance de rôle. |
|
provisioningState |
string |
État d’approvisionnement, qui apparaît uniquement dans la réponse. |
publisher |
string |
Nom du serveur de publication du gestionnaire d’extensions. |
rolesAppliedTo |
string[] |
Liste facultative des rôles à appliquer à cette extension. Si la propriété n’est pas spécifiée ou « * » est spécifiée, l’extension est appliquée à tous les rôles du 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 principal 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 principal 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. |
CloudServiceNetworkProfile
Profil réseau pour le service cloud.
Nom | Type | Description |
---|---|---|
loadBalancerConfigurations |
Liste des configurations de l’équilibreur de charge. Le service cloud peut avoir jusqu’à deux configurations d’équilibreur de charge, correspondant à un équilibreur de charge public et à un équilibreur de charge interne. |
|
slotType |
Type d’emplacement pour le service cloud.
Les valeurs possibles sont |
|
swappableCloudService |
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 dans le cas contraire, une erreur sera levée. |
CloudServiceOsProfile
Décrit le profil du système d’exploitation pour le service cloud.
Nom | Type | Description |
---|---|---|
secrets |
Spécifie le jeu 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 la référence sku de rôle (roleProfile.roles.sku) spécifiées dans le modèle/modèle doivent remplacer respectivement le nombre d’instances de rôle et la taille de machine virtuelle spécifiées dans .cscfg et .csdef.
La valeur par défaut est |
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é (SAP) à partir de n’importe quel compte de stockage. Il s’agit d’une propriété en écriture seule et n’est pas retournée dans les appels GET. |
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 service peut être un URI de signature d’accès partagé (SAP) à partir de n’importe quel compte de stockage. Il s’agit d’une propriété en écriture seule et n’est pas retournée dans les appels GET. |
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 s’il faut démarrer le service cloud immédiatement après sa création. La valeur par défaut est |
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 lancées manuellement dans chaque domaine de mise à jour ou lancées automatiquement dans tous les domaines de mise à jour.
Les valeurs possibles sont |
CloudServiceRoleProfile
Décrit le profil de rôle pour le service cloud.
Nom | Type | Description |
---|---|---|
roles |
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 |
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 activé, 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 |
CloudServiceSlotType
Type d’emplacement pour le service cloud.
Les valeurs possibles sont
production
intermédiaire
Si elle n’est pas spécifiée, la valeur par défaut est Production.
Valeur | Description |
---|---|
Production | |
Staging |
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 lancées manuellement dans chaque domaine de mise à jour ou lancées automatiquement dans tous les domaines de mise à jour.
Les valeurs possibles sont
automatique
manuel
simultanée
S’il n’est pas spécifié, la valeur par défaut est Auto. Si la valeur est Manuelle, PUT UpdateDomain doit être appelée pour appliquer la mise à jour. Si la valeur est Automatique, la mise à jour est automatiquement appliquée à chaque domaine de mise à jour en séquence.
Valeur | Description |
---|---|
Auto | |
Manual | |
Simultaneous |
CloudServiceVaultAndSecretReference
Paramètres protégés de l’extension, référencés à l’aide de KeyVault qui sont chiffrés avant d’être envoyés à l’instance de rôle.
Nom | Type | Description |
---|---|---|
secretUrl |
string |
URL secrète qui contient les paramètres protégés de l’extension |
sourceVault |
ID de ressource ARM du coffre de clés |
CloudServiceVaultCertificate
Décrit une référence de certificat unique dans un coffre de clés et où le certificat doit résider sur l’instance de rôle.
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. |
isBootstrapCertificate |
boolean |
Indicateur indiquant si le certificat fourni est un certificat de démarrage à utiliser par l’extension Key Vault pour extraire les certificats restants. |
CloudServiceVaultSecretGroup
Décrit un ensemble de certificats qui se trouvent tous dans le même coffre de clés.
Nom | Type | Description |
---|---|---|
sourceVault |
URL relative du coffre de clés 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.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de l’extension. |
properties |
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 |
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 |
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 frontale. |
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 frontale.
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 |
Propriétés de la configuration ip frontale de l’équilibreur de charge. |
LoadBalancerFrontendIpConfigurationProperties
Décrit une configuration IP du service cloud
Nom | 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
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 Cloud Service (support étendu) a été créée. |
lastModifiedAt |
string |
Spécifie l’heure UTC à laquelle la ressource Cloud Service (support étendu) a été modifiée pour la dernière fois. |