Obtention d'un déploiement
L'opération Get Deployment
renvoie les données de configuration, l'état, et les propriétés système d'un déploiement.
Requête
La demande Get Deployment
permet de récupérer des événements de déploiement pour un emplacement de déploiement (intermédiaire ou de production) ou pour un nom de déploiement spécifique. Si vous voulez récupérer des informations par nom de déploiement, vous devez d'abord obtenir le nom unique du déploiement. Ce nom unique fait partie de la réponse lorsque vous faites une demande pour obtenir le déploiement dans un emplacement de déploiement.
Par exemple, si vous avez un service cloud déployé dans l'environnement de production, vous pouvez obtenir le nom unique en faisant une demande à …/deploymentslots/production
. La réponse inclut un élément Name
pour le service cloud. Cette valeur d'élément Name
peut être utilisée pour effectuer une demande à …/deployments/<Name>
si vous souhaitez récupérer des informations sur ce déploiement spécifique.
Pour générer l'URI de la demande, remplacez <subscription-id>
par votre ID d'abonnement, <cloudservice-name>
par le nom du service cloud, <deployment-slot>
par staging
ou production
, et <deployment-name>
par le nom du déploiement.
Méthode | URI de demande |
---|---|
GET | https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot> |
GET | https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name> |
Paramètres URI
Aucun.
En-têtes de requête
Le tableau suivant décrit les en-têtes de la demande.
En-tête de requête | Description |
---|---|
x-ms-version |
Obligatoire. Spécifie la version de l'opération à utiliser pour cette demande. Cet en-tête doit avoir la valeur 2009-10-01 ou une valeur supérieure. |
Corps de la requête
Aucun.
response
La réponse inclut un code d'état HTTP, un ensemble d'en-têtes de réponse et un corps de réponse.
Code d’état
Une opération réussie envoie le code d'état 200 (OK).
En-têtes de réponse
La réponse de l'opération inclut les en-têtes suivants. La réponse peut aussi inclure des en-têtes HTTP standard supplémentaires.
En-tête de réponse | Description |
---|---|
x-ms-request-id |
Valeur qui identifie de façon unique une demande effectuée au service de gestion. |
Corps de la réponse
L'exemple suivant illustre le format du corps de la réponse :
<?xml version="1.0" encoding="utf-8"?>
<Deployment xmlns="http://schemas.microsoft.com/windowsazure">
<Name>name-of-deployment</Name>
<DeploymentSlot>current-deployment-environment</DeploymentSlot>
<PrivateID>identifier-of-deployment</PrivateID>
<Status>status-of-deployment</Status>
<Label>base64-encoded-name-of-deployment</Label>
<Url>url-of-deployment</Url>
<Configuration>base-64-encoded-configuration-file</Configuration>
<RoleInstanceList>
<RoleInstance>
<RoleName>name-of-role</RoleName>
<InstanceName>name-of-role-instance</InstanceName>
<InstanceStatus>status-of-role-instance</InstanceStatus>
<ExtendedInstanceStatus>additional-status-details</ExtendedInstanceStatus>
<InstanceUpgradeDomain>update-domain-of-role-instance</InstanceUpgradeDomain>
<InstanceFaultDomain>fault-domain-of-role-instance</InstanceFaultDomain>
<InstanceSize>size-of-role-instance</InstanceSize>
<InstanceStateDetails>state-of-role-instance</InstanceStateDetails>
<InstanceErrorCode>error-code-returned-for-role-instance</InstanceErrorCode>
<IpAddress>ip-address-of-role-instance</IpAddress>
<InstanceEndpoints>
<InstanceEndpoint>
<Name>name-of-endpoint</Name>
<Vip>virtual-ip-address-of-instance-endpoint</Vip>
<PublicPort>public-facing-port-of-instance-endpoint</PublicPort>
<LocalPort>internal-facing-port-of-instance-endpoint</LocalPort>
<Protocol>protocol-of-instance-endpoint</Protocol>
</InstanceEndpoint>
</InstanceEndpoints>
<PowerState>state-of-role-instance</PowerState>
<HostName>dns-name-of-service</HostName>
<RemoteAccessCertificateThumbprint>cert-thumbprint-for-remote-access</RemoteAccessCertificateThumbprint>
<GuestAgentStatus>
<ProtocolVersion>version-of-protocol</ProtocolVersion>
<Timestamp>status-report-time</Timestamp>
<GuestAgentVersion>version-of-agent</GuestAgentVersion>
<Status>status-of-agent</Status>
<FormattedMessage>
<Language>language-of-message</Language>
<Message>agent-message</Message>
</FormattedMessage>
</GuestAgentStatus>
<ResourceExtensionStatusList>
<ResourceExtensionStatus>
<HandlerName>name-of-extension</HandlerName>
<Version>version-of-extension</Version>
<Status>status-of-extension</Status>
<Code>status-code-of-extension</Code>
<FormattedMessage>
<Language>language-of-message</Language>
<Message>extension-message</Message>
</FormattedMessage>
<ExtensionSettingStatus>
<Timestamp>status-report-time</Timestamp>
<Name>name-of-setting</Name>
<Operation>operation-performed</Operation>
<Status>status-of-setting</Status>
<Code>status-code</Code>
<FormattedMessage>
<Language>language-of-status-message</Language>
<Message>status-message</Message>
</FormattedMessage>
<SubStatusList>
<SubStatus>
<Name>name-of-substatus-object</Name>
<Status>status-of-object</Status>
<FormattedMessage>
<Language>language-of-message</Language>
<Message>status-message</Message>
</FormattedMessage>
</SubStatus>
</SubStatusList>
</ExtensionSettingStatus>
</ResourceExtensionStatus>
</ResourceExtensionStatusList>
<PublicIPs>
<PublicIP>
<Name>name-of-public-ip</Name>
<Address>ip-address</Address>
<IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
<DomainNameLabel>domain-label</DomainNameLabel>
<Fqdns>
<Fqdn>fqdn</Fqdn>
</Fqdns>
<PublicIP>
<PublicIPs>
<NetworkInterfaces>
<NetworkInterface>
<Name>interface-name</Name>
<MacAddress>mac-address</MacAddress>
<IPConfigurations>
<IPConfiguration>
<SubnetName>subnet-name</SubnetName>
<Address>ip-address</Address>
</IPConfiguration>
<IPConfigurations>
</NetworkInterface>
</NetworkInterfaces>
</RoleInstance>
</RoleInstanceList>
<UpgradeStatus>
<UpgradeType>type-of-upgrade</UpgradeType>
<CurrentUpgradeDomainState>current-status-of-upgrade</CurrentUpgradeDomainState>
<CurrentUpgradeDomain>n</CurrentUpgradeDomain>
</UpgradeStatus>
<UpgradeDomainCount>number-of-upgrade-domains-in-deployment</UpgradeDomainCount>
<RoleList>
<Role>
<RoleName>name-of-role</RoleName>
<OsVersion>operating-system-version</OsVersion>
<ConfigurationSets>
<ConfigurationSet>
<ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>
<InputEndpoints>
<InputEndpoint>
<Port>port-number-of-input-endpoint-in-network</Port>
<Protocol>protocol-of-input-endpoint-in-network</Protocol>
<Vip>virtual-ip-address-of-input-endpoint-in-network</Vip>
</InputEndpoint>
</InputEndpoints>
<PublicIPs>
<PublicIP>
<Name>PublicIPName</Name>
<StaticVirtualNetworkIPAddress></StaticVirtualNetworkIPAddress>
<IdleTimeoutInMinutes></IdleTimeoutInMinutes>
<DomainNameLabel>domain-name</DomainNameLabel>
</PublicIP>
</PublicIPs>
<NetworkInterfaces>
<NetworkInterface>
<Name>interface-name</Name>
<IPConfigurations>
<IPConfiguration>
<SubnetName>subnet-name</SubnetName>
<StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>
</IPConfiguration>
</IPConfigurations>
</NetworkInterface>
<NetworkInterfaces>
</ConfigurationSet>
</ConfigurationSets>
</Role>
<Role>
<RoleName>name-of-role</RoleName>
<OsVersion>operating-system-version</OsVersion>
<RoleType>PersistentVMRole</RoleType>
<LicenseType>type-of-license</LicenseType>
<ConfigurationSets>
<ConfigurationSet>
<ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>
<InputEndpoints>
<InputEndpoint>
<LoadBalancedEndpointSetName>name-of-load-balanced-endpoint-set</LoadBalancedEndpointSetName>
<LocalPort>internal-facing-port-of-input-endpoint</LocalPort>
<Name>name-of-input-endpoint</Name>
<Port>external-facing-port-of-input-endpoint</Port>
<LoadBalancerProbe>
<Path>path-of-probe</Path>
<Port>port-assigned-to-probe</Port>
<Protocol>protocol-of-probe-port</Protocol>
</LoadBalancerProbe>
<LoadBalancerName>name-of-internal-loadbalancer</LoadBalancerName>
<IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
<Protocol>protocol-of-input-endpoint</Protocol>
<Vip>virtual-ip-address-of-input-endpoint</Vip>
</InputEndpoint>
<InputEndpoints>
<SubnetNames>
<SubnetName>name-of-subnet</SubnetName>
</SubnetNames>
<StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>
</ConfigurationSet>
</ConfigurationSets>
<ResourceExtensionReferences>
<ResourceExtensionReference>
<ReferenceName>name-of-reference</ReferenceName>
<Publisher>name-of-publisher</Publisher>
<Name>name-of-extension</Name>
<Version>version-of-extension</Version>
<ResourceExtensionParameterValues>
<ResourceExtensionParameterValue>
<Key>name-of-parameter-key</Key>
<Value>parameter-value</Value>
<Type>type-of-parameter</Type>
</ResourceExtensionParameterValue>
</ResourceExtensionParameterValues>
<State>state-of-resource</State>
</ResourceExtensionReference>
</ResourceExtensionReferences>
<AvailabilitySetName>name-of-availability-set</AvailabilitySetName>
<DataVirtualHardDisks>
<DataVirtualHardDisk>
<HostCaching>host-caching-mode-of-data-disk</HostCaching>
<DiskName>name-of-data-disk</DiskName>
<Lun>logical-unit-number-of-data-disk</Lun>
<LogicalDiskSizeInGB>size-of-data-disk</LogicalDiskSizeInGB>
<MediaLink>path-to-vhd</MediaLink>
<IOType>IO-Type<IOType>
</DataVirtualHardDisk>
</DataVirtualHardDisks>
<OSVirtualHardDisk>
<HostCaching>host-caching-mode-of-os-disk</HostCaching>
<DiskName>name-of-os-disk</DiskName>
<MediaLink>path-to-vhd</MediaLink>
<SourceImageName>image-used-to-create-os-disk</SourceImageName>
<OS>operating-system-on-os-disk</OS>
<RemoteSourceImageLink>path-to-source-image</RemoteSourceImageLink>
<IOType>IO-Type<IOType>
</OSVirtualHardDisk>
<RoleSize>size-of-instance</RoleSize>
<ProvisionGuestAgent>install-an-agent</ProvisionGuestAgent>
</Role>
</RoleList>
<SdkVersion>sdk-version-used-to-create-package</SdkVersion>
<Locked>status-of-deployment-write-allowed</Locked>
<RollbackAllowed>rollback-operation-allowed</RollbackAllowed>
<VirtualNetworkName>name-of-virtual-network</VirtualNetworkName>
<Dns>
<DnsServers>
<DnsServer>
<Name>name-of-dns-server</Name>
<Address>address-of-dns-server</Address>
</DnsServer>
</DnsServers>
</Dns>
<LoadBalancers>
<LoadBalancer>
<Name>name-of-internal-load-balancer</Name>
<FrontendIpConfiguration>
<Type>type-of-ip-address</Type>
<SubnetName>name-of-subnet</SubnetName>
<StaticVirtualNetworkIPAddress>static-ip-address</StaticVirtualNetworkIPAddress>
</FrontendIpConfiguration>
</LoadBalancer>
</LoadBalancers>
<ExtendedProperties>
<ExtendedProperty>
<Name>name-of-property</Name>
<Value>value-of-property</Value>
</ExtendedProperty>
</ExtendedProperties>
<PersistentVMDowntime>
<StartTime>start-of-downtime</StartTime>
<EndTime>end-of-downtime</EndTime>
<Status>status-of-downtime</Status>
</PersistentVMDowntime>
<VirtualIPs>
<VirtualIP>
<Address>virtual-ip-address-of-deployment</Address>
<IsReserved>indicator-of-ip-reservation</IsReserved>
<ReservedIPName>name-of-reserved-ip</ReservedIpName>
<Type>type-of-ip</Type>
</VirtualIP>
</VirtualIPs>
<ExtensionConfiguration>
<AllRoles>
<Extension>
<Id>identifier-of-extension</Id>
<SequenceNumber>configuration-sequence</SequenceNumber>
<State>state-of-extension</State>
</Extension>
</AllRoles>
<NamedRoles>
<Role>
<RoleName>role_name1</RoleName>
<Extensions>
<Extension>
<Id>identifier-of-extension</Id>
<SequenceNumber>configuration-sequence</SequenceNumber>
<State>state-of-extension</State>
</Extension>
</Extensions>
</Role>
</NamedRoles>
</ExtensionConfiguration>
<ReservedIPName>name-of-reserved-ip</ReservedIpName>
<InternalDnsSuffix>dns-suffix</InternalDnsSuffix>
</Deployment>
Le tableau suivant décrit les éléments dans le corps de la réponse.
Nom de l'élément | Description |
---|---|
Nom | Spécifie le nom du déploiement. |
DeploymentSlot | Spécifie l'environnement vers lequel le service cloud est déployé, staging ou production . |
PrivateID | Spécifie un identificateur unique généré en interne pour ce déploiement. |
Statut | Spécifie l'état du déploiement. Les valeurs possibles sont les suivantes : - Running - Suspended - RunningTransitioning - SuspendedTransitioning - Starting - Suspending - Deploying - Deleting |
Étiquette | Spécifie l'identificateur encodé en base 64 du déploiement. Cet identificateur peut être utilisé pour identifier l'offre à des fins de suivi. |
Url | Spécifie l'URL utilisée pour accéder au service cloud. Par exemple, si le nom du service est MyService, vous pouvez accéder à l’accès au service en appelant : http:// MyService.cloudapp.net |
Configuration | Spécifie le fichier de configuration encodé en base 64 du déploiement. |
RoleInstanceList | Contient la liste des instances de rôle dans le déploiement. |
UpgradeStatus | Contient les paramètres de mise à niveau du déploiement. |
UpgradeDomainCount | Contient un entier qui représente le nombre total de domaines de mise à niveau pour le déploiement. L’élément UpgradeDomainCount est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
RoleList | Contient la liste des rôles dans le déploiement. |
SdkVersion | Spécifie la version du kit de développement logiciel utilisé pour générer le package du déploiement. L’élément SdkVersion est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
Verrouillé | True pour empêcher une nouvelle opération d'écriture sur le déploiement pendant qu'il est mis à jour ; sinon false .L’élément Locked est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
RollbackAllowed | True si l'opération RollbackDeploymentUpdateOrUpgrade est autorisée sur le déploiement ; sinon false .L’élément RollbackAllowed est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
CreatedTime | Spécifie l'heure de création du déploiement. |
LastModifiedTime | Spécifie l'heure de la dernière modification apportée au déploiement. |
VirtualNetworkName | Spécifie le nom du réseau virtuel auquel la machine virtuelle se connecte. L’élément VirtualNetworkName est disponible uniquement à l’aide de la version 2012-03-01 ou ultérieure. |
Dns | Contient les paramètres DNS personnalisés qui sont spécifiés pour le déploiement. L’élément Dns est disponible uniquement à l’aide de la version 2012-03-01 ou ultérieure. |
LoadBalancers | Contient une liste de programmes d'équilibrage de charge internes qui peuvent être affectés à des points de terminaison d'entrée. L’élément LoadBalancers est disponible uniquement à l’aide de la version 2014-05-01 ou ultérieure. |
ExtendedProperties | Spécifie les propriétés utilisées pour fournir plus informations sur le déploiement. |
PersistentVMDowntime | Spécifie les informations relatives aux derniers démarrage et arrêt de la machine virtuelle. L’élément PersistentVMDowntime est disponible uniquement à l’aide de la version 2012-03-01 ou ultérieure. |
VirtualIPs | Spécifie les adresses IP virtuelles du déploiement. L’élément VirtualIPs est disponible uniquement à l’aide de la version 2012-03-01 ou ultérieure. |
ExtensionConfiguration | Spécifie une extension qui est ajoutée au service cloud. Dans Azure, un processus peut fonctionner comme une extension d'un service cloud. Vous pouvez ajouter une extension à un service cloud à l’aide de l’option Ajouter une extension et vous pouvez ajouter l’extension au déploiement en utilisant Mettre à niveau le déploiement ou Modifier la configuration du déploiement. L’élément ExtensionConfiguration est disponible uniquement à l’aide de la version 2013-03-01 ou ultérieure. |
ReservedIPName | Indique le nom d'une adresse IP réservée à affecter au déploiement. L’élément ReservedIPName est disponible uniquement à l’aide de la version 2014-05-01 ou ultérieure. |
InternalDnsSuffix | Spécifie le suffixe du nom de domaine pour la résolution de noms internes attribuée automatiquement par Azure. Le suffixe de nom de domaine est attribué automatiquement à toutes les instances de machines virtuelles d'un déploiement. Le suffixe de nom de domaine est attribué automatiquement à toutes les instances de rôles web ou de rôles de travail d'un déploiement lorsque le nom d'ordinateur est attribué à au moins un rôle à l'aide de l'attribut vmName . Un suffixe de nom de domaine interne n'est pas attribué à un déploiement se trouvant dans un VNET avec un serveur DNS configuré.L’élément InternalDnsSuffix est disponible uniquement à l’aide de la version 2013-11-01 ou ultérieure. |
RoleInstanceList
Contient la liste des instances de rôle dans le déploiement.
Nom de l'élément | Description |
---|---|
RoleName | Indique le nom du rôle. |
InstanceName | Spécifie le nom d'une instance de rôle spécifique, si une instance de rôle s'exécute. |
InstanceStatus | Spécifie l'état actuel d'une instance de rôle.Unknown :- Indique que l’état du rôle est actuellement inconnu. CreatingVM :- Indique que des ressources sont en cours de création pour une machine virtuelle. StartingVM :- Indique qu’une machine virtuelle démarre. CreatingRole :- Indique que des ressources sont en cours de création pour un instance de rôle. StartingRole :- Indique qu’un rôle instance démarre. ReadyRole :- Indique qu’un rôle instance a démarré et qu’il est prêt à être utilisé. BusyRole :- Indique qu’un rôle instance n’est pas disponible pour les demandes. Cet état est généralement généré pendant que l'instance de rôle est créée ou arrêtée. StoppingRole :- Indique qu’un instance de rôle s’arrête. StoppingVM :- Indique qu’une machine virtuelle s’arrête. DeletingVM :- Indique qu’une machine virtuelle est en cours de suppression. StoppedVM :- Indique qu’une machine virtuelle n’est pas en cours d’exécution. C'est l'état final du processus d'arrêt, et aucun autre message d'état n'est reçu après StoppedVM .RestartingRole :- Indique qu’un instance de rôle s’est arrêté de manière inattendue ou n’a pas pu démarrer. Cet état indique qu'un problème avec l'instance de rôle provoque le blocage ou empêche le démarrage, et qu'il doit être corrigé pour que l'instance de rôle puisse être démarrée. Les champs InstanceStateDetails et InstanceErrorCode peuvent contenir des informations sur l'erreur de rôle qui a provoqué cet état.CyclingRole :- Indique qu’un rôle s’est continuellement bloqué après avoir été démarré par Azure. Cet état indique qu'un problème empêche le rôle de démarrer, et peut être généré même après que les états StartingRole et ReadyRole sont reçus. Le problème relatif au rôle doit être identifié et corrigé pour démarrer le rôle. Les champs InstanceStateDetails et InstanceErrorCode peuvent contenir des informations sur l'erreur de rôle qui a causé cet état, et peuvent être utilisés pour identifier et déboguer le problème. L'élément CyclingRole est renvoyé uniquement si la version est 2014-02-01 ou une version antérieure.FailedStartingRole :- Le rôle n’a toujours pas pu démarrer. Cet état indique qu'un problème empêche l'instance de rôle de démarrer, et peut être généré même après que le processus renvoie StartingRole . Le problème relatif au rôle doit être identifié et corrigé pour démarrer le rôle. Les champs InstanceStateDetails et InstanceErrorCode peuvent contenir des informations sur l'erreur de rôle qui a causé cet état, et peuvent être utilisés pour identifier et déboguer le problème.FailedStartingVM :- Indique qu’une machine virtuelle n’a pas pu démarrer en permanence. Cet état est généré par Azure, et n'indique pas une erreur relative au rôle. Il peut être généré après l'état StartingRole .UnresponsiveRole :- Indique qu’un instance de rôle a expiré avant de recevoir un message status et ne répond pas aux demandes. StoppedDeallocated :- Indique qu’un rôle instance a été arrêté et que toutes les ressources allouées ont été libérées. Cela arrête la facturation pour l'instance de rôle. Les instances de rôle qui ont un état StoppedDeallocated sont renvoyées dans la liste uniquement si leur version est 2013-06-01 ou une version ultérieure. Si toutes les instances de rôle du déploiement ont un état StoppedDeallocated , le déploiement n'est pas renvoyé si la version est antérieure à 2013-06-01.Preparing :- Indique que l’objet blob est copié à partir de l’emplacement source distant. Cet état est renvoyé uniquement si la version est 2014-05-01 ou une version ultérieure. |
ExtendedInstanceStatus | Spécifie des détails sur l'état supplémentaires si ceux-ci sont disponibles pour le déploiement. Si un objet blob est copié à partir d'un emplacement source distant vers un compte de stockage, la valeur de cet élément contient le pourcentage de l'objet blob qui a été copié. L’élément ExtendedInstanceStatus est disponible uniquement à l’aide de la version 2015-05-01 ou ultérieure. |
InstanceUpgradeDomain | Spécifie le domaine de mise à niveau auquel cette instance de rôle appartient. Pendant un déploiement de mise à niveau, tous les rôles dans le même domaine de mise à niveau sont mis à niveau en même temps. L’élément InstanceUpgradeDomain est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
InstanceFaultDomain | Spécifie le domaine par défaut auquel cette instance de rôle appartient. Les instances de rôle dans le même domaine par défaut peuvent toutes être vulnérables à l'échec d'une seule partie du matériel. L’élément InstanceFaultDomain est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
InstanceSize | Spécifie la taille de l'instance de rôle. L’élément InstanceSize est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
InstanceStateDetails | Fournit un instantané de l'état de l'instance de rôle au moment où l'opération a été appelée. L’élément InstanceStateDetails est disponible uniquement à l’aide de la version 2011-10-01 ou ultérieure. |
InstanceErrorCode | Code d'erreur du dernier démarrage de rôle. Pour les machines virtuelles, les codes d'erreur sont les suivants : - WaitTimeout : le rôle instance n’a pas communiqué dans les 25 minutes. En général, cela indique qu'elle n'a pas démarré ou que l'agent invité n'est pas installé. - VhdTooLarge : l’image de disque dur virtuel sélectionnée était trop grande pour le rôle instance. - AzureInternalError : une erreur interne s’est produite qui a provoqué l’échec du démarrage du instance de rôle. Contactez le support pour obtenir une assistance supplémentaire. Pour les rôles web et de travail, ce champ renvoie un code d'erreur qui peut être fourni à l'assistance d'Azure pour aider à la résolution des erreurs. En général, ce champ est vide. L’élément InstanceErrorCode est disponible uniquement à l’aide de la version 2011-10-01 ou ultérieure. |
IpAddress | Spécifie l'adresse IP de l'instance de rôle (DIP). L’élément IpAddress est disponible uniquement à l’aide de la version 2012-03-01 ou ultérieure. |
InstanceEndpoints | Contient la liste des points de terminaison d'instance pour le rôle. |
PowerState | État d'exécution de la machine virtuelle. Les valeurs possibles sont les suivantes : - Starting - Started - Stopping - Stopped - Unknown |
HostName | Spécifie le nom d'hôte DNS du service cloud dans lequel l'instance de rôle s'exécute. Cet élément est uniquement indiqué pour les déploiements de machine virtuelle. |
RemoteAccessCertificateThumbprint | Spécifie l'empreinte numérique du certificat de serveur RDP (dans Windows) ou du certificat de serveur SSH (dans Linux). L'empreinte numérique est utilisée uniquement pour les machines virtuelles créées à partir d'une image. L’élément RemoteAccessCertificateThumbprint est disponible uniquement à l’aide de la version 2012-08-01 ou ultérieure. |
GuestAgentStatus | Spécifie des informations sur l'agent installé sur une instance. L’élément GuestAgentStatus est disponible uniquement à l’aide de la version 2014-04-01 ou ultérieure. |
ResourceExtensionStatusList | Spécifie des informations sur les extensions installées sur une instance. L’élément ResourceExtensionStatusList est disponible uniquement à l’aide de la version 2014-04-01 ou ultérieure. |
PublicIPs | Optionnel. Contient une adresse IP publique pouvant être utilisée en plus de l'adresse IP virtuelle par défaut pour la machine virtuelle. L’élément PublicIPs est disponible uniquement à l’aide de la version 2014-05-01 ou ultérieure. |
NetworkInterfaces | Facultatif, jeu d'interfaces réseau secondaires. Le nombre autorisé d'interfaces réseau secondaires dépend de la taille de la machine virtuelle. L'élément NetworkInterfaces est disponible uniquement si vous utilisez la version 2014-08-01 ou une version ultérieure. |
InstanceEndpoints
Contient la liste des points de terminaison d'instance pour le rôle.
Nom de l'élément | Description |
---|---|
Nom | Spécifie le nom du point de terminaison. |
Vip | Spécifie l'adresse IP virtuelle du point de terminaison. L’élément Vip est disponible uniquement à l’aide de la version 2011-06-01 ou ultérieure. |
PublicPort | Spécifie le port externe utilisé par le point de terminaison. |
LocalPort | Spécifie le port interne utilisé par le point de terminaison. |
Protocol | Spécifie le protocole du trafic sur le point de terminaison. |
UpgradeStatus
Spécifie des informations sur une mise à niveau se produisant sur le déploiement.
Nom de l'élément | Description |
---|---|
UpgradeType | Spécifie le type de mise à niveau. Les valeurs possibles sont les suivantes : - Auto - Manual - Simultaneous |
CurrentUpgradeDomainState | Spécifie l'état actuel de la mise à niveau. Les valeurs possibles sont Before et During . |
CurrentUpgradeDomain | Contient un entier qui identifie le domaine de mise à niveau actuel. Les domaines de mise à niveau sont identifiés avec un index de base zéro : le premier domaine de mise à niveau a un ID égal à 0, le deuxième un ID égal à 1, etc. |
RoleList
Contient la liste des rôles dans le déploiement.
Nom de l'élément | Description |
---|---|
RoleName | Indique le nom du rôle. |
OsVersion | Spécifie la version du système d'exploitation sur lequel les instances de rôle s'exécutent. |
RoleType | Spécifie le type du rôle. Cet élément est uniquement indiqué pour les déploiements de machine virtuelle ; il est PersistentVMRole par défaut. |
LicenseType | Spécifie que l’image ou le disque utilisé était sous licence locale. Cet élément est utilisé uniquement pour les images qui contiennent le système d’exploitation Windows Server. Les valeurs possibles sont les suivantes : - Windows_Client - Windows_Server |
ConfigurationSets | Contient une collection de valeurs qui représente les paramètres système ou de configuration de l'application. |
AvailabilitySetName | Spécifie le nom de la collection de machines virtuelles. |
DataVirtualHardDisks | Contient les paramètres utilisés pour ajouter un disque de données à une machine virtuelle. |
OSVirtualHardDisk | Contient les paramètres utilisés pour créer le disque de système d'exploitation pour une machine virtuelle. |
RoleSize | Spécifie la taille de l'instance de rôle. |
ProvisionGuestAgent | Optionnel. Indique si l'agent de machine virtuelle est installé sur la machine virtuelle. Pour exécuter une extension de ressource sur une machine virtuelle, ce service doit être installé. Les valeurs possibles sont les suivantes : - true - false |
ResourceExtensionReferences | Optionnel. Contient une collection d'extensions de ressources à installer sur la machine virtuelle. Cet élément est utilisé si ProvisionGuestAgent a la valeur true . |
ConfigurationSets
Contient une collection d'objets qui fournissent les données système ou d'application.
Nom de l'élément | Description |
---|---|
ConfigurationSetType | Spécifie le type de configuration pour le jeu de configurations. Ce paramètre a toujours la valeur NetworkConfiguration. |
InputEndpoints | Contient une collection de points de terminaison externes pour une machine virtuelle. |
SubnetNames | Contient la liste des noms de sous-réseaux du réseau virtuel auxquels le déploiement appartient. |
PublicIPs | Optionnel. Contient une adresse IP publique pouvant être utilisée en plus de l'adresse IP virtuelle par défaut pour la machine virtuelle. L’élément PublicIPs est disponible uniquement à l’aide de la version 2014-05-01 ou ultérieure. |
NetworkInterfaces | Facultatif, jeu d'interfaces réseau secondaires. Le nombre autorisé d'interfaces réseau secondaires dépend de la taille de la machine virtuelle. L'élément NetworkInterfaces est disponible uniquement si vous utilisez la version 2014-08-01 ou une version ultérieure. |
StaticVirtualNetworkIPAddress | Spécifie l'adresse IP interne pour la machine virtuelle dans un réseau virtuel. Si cet élément est spécifié, l'élément SubnetNames contient uniquement un sous-réseau. L'adresse IP spécifiée dans cet élément appartient au sous-réseau défini dans SubnetNames. L’élément StaticVirtualNetworkIPAddress est disponible uniquement à l’aide de la version 2013-11-01 ou ultérieure. |
InputEndpoints
Contient une collection de points de terminaison externes pour une machine virtuelle.
Nom de l'élément | Description |
---|---|
LoadBalancedEndpointSetName | Spécifie un nom pour un ensemble de points de terminaison à charge équilibrée. Cet élément est uniquement indiqué pour les déploiements de machine virtuelle. |
LocalPort | Spécifie le port interne sur lequel la machine virtuelle écoute pour utiliser le point de terminaison. Cet élément est uniquement indiqué pour les déploiements de machine virtuelle. |
Nom | Spécifie le nom du point de terminaison externe. Cet élément est uniquement indiqué pour les déploiements de machine virtuelle. |
Port | Spécifie le port externe à utiliser pour le point de terminaison. |
LoadBalancerProbe | Contient les paramètres de point de terminaison qu'utilise le programme d'équilibrage de charge Azure pour surveiller la disponibilité d'une machine virtuelle avant de transférer le trafic au point de terminaison. |
LoadBalancerName | Optionnel. Spécifie le nom de l'équilibrage de charge interne qui est associé à ce point de terminaison. Le nom de l’équilibreur de charge interne est spécifié dans LoadBalancers. L’élément LoadBalancerName est disponible uniquement à l’aide de la version 2014-05-01 ou ultérieure. |
IdleTimeoutInMinutes | Optionnel. Spécifie le délai d'expiration de la connexion TCP inactive. La valeur peut être comprise entre 4 et 30 minutes. La valeur par défaut est 4 minutes. Cet élément est utilisé uniquement lorsque le protocole est TCP. L’élément IdleTimeoutInMinutes est disponible uniquement à l’aide de la version 2014-06-01 ou ultérieure. |
Protocol | Spécifie le protocole de transport du point de terminaison. Les valeurs possibles sont les suivantes : - TCP - UDP |
Vip | Spécifie l'adresse IP virtuelle du point de terminaison. |
LoadBalancerProbe
Contient les paramètres de point de terminaison qu'utilise le programme d'équilibrage de charge Azure pour surveiller la disponibilité d'une machine virtuelle avant de transférer le trafic au point de terminaison.
Nom de l'élément | Description |
---|---|
Path | Spécifie le nom du chemin d'accès relatif à inspecter pour déterminer l'état de disponibilité. Si le protocole est défini sur TCP, cette valeur doit être NULL. Exemple : path La sonde utilisera https://example.com/path pour effectuer la sonde. |
Port | Spécifie le port utilisé pour inspecter l'état de disponibilité. |
Protocol | Spécifie le protocole utilisé pour inspecter l'état de disponibilité. Les valeurs possibles sont les suivantes : - HTTP - TCP |
DNS
Spécifie les paramètres DNS personnalisés qui sont spécifiés pour le déploiement.
Nom de l'élément | Description |
---|---|
Nom | Spécifie le nom du serveur DNS. |
Adresse | Spécifie l'adresse IP du serveur DNS. |
ExtendedProperties
Spécifie les propriétés utilisées pour fournir plus informations sur le déploiement.
Nom de l'élément | Description |
---|---|
Nom | Spécifie le nom d'une propriété associée au déploiement. |
Valeur | Spécifie la valeur d'une propriété associée au déploiement. |
PersistentVMDowntime
Spécifie les informations relatives aux derniers démarrage et arrêt de la machine virtuelle.
Nom de l'élément | Description |
---|---|
StartTime | Spécifie l'heure à laquelle la machine virtuelle a été démarrée. |
EndTime | Spécifie l'heure à laquelle la machine virtuelle a été arrêtée. |
Statut | Spécifie l'état de la machine virtuelle. |
VirtualIPs
Contient les adresses IP virtuelles qui sont spécifiées pour le déploiement.
Nom de l'élément | Description |
---|---|
Adresse | Spécifie l'adresse IP virtuelle du déploiement. |
IsReserved | Indique si l'adresse IP virtuelle est réservée. Les valeurs possibles sont les suivantes : - true - false |
ReservedIPName | Indique le nom d'une adresse IP réservée qui a été affectée au déploiement. |
Type | Spécifie la valeur Private si l'adresse IP virtuelle est associée à un programme d'équilibrage de charge interne. |
SubnetNames
Contient la liste des sous-réseaux auxquels la machine virtuelle appartiendra.
Nom de l'élément | Description |
---|---|
SubnetName | Obligatoire. Spécifie le nom du sous-réseau auquel la machine virtuelle appartient. |
DataVirtualHardDisks
Contient les paramètres utilisés pour ajouter un disque de données à une machine virtuelle.
Nom de l'élément | Description |
---|---|
HostCaching | Spécifie le comportement de mise en cache de la plateforme pour l'objet blob de disque de données, pour l'efficacité en lecture/écriture. Les valeurs possibles sont les suivantes : - None - ReadOnly - ReadWrite La valeur par défaut est ReadOnly . |
DiskName | Spécifie le nom du disque dur virtuel à utiliser pour créer le disque de données pour la machine virtuelle. |
Lun | Spécifie le numéro d'unité logique (LUN) pour le disque de données. Le numéro d'unité logique spécifie l'emplacement dans lequel le lecteur de données s'affiche une fois monté afin d'être utilisé par la machine virtuelle. Cet élément est uniquement répertorié lorsque plusieurs disques de données sont associés à une machine virtuelle. Les valeurs valides sont comprises entre 0 et 31. |
LogicalDiskSizeInGB | Spécifie la taille, en Go, du disque à joindre à la machine virtuelle. |
MediaLink | Spécifie l'emplacement dans le stockage Azure du disque dur virtuel associé au disque. Exemple : http://example.blob.core.windows.net/disks/mydatadisk.vhd| |
IOType | Cette propriété identifie le type de compte de stockage pour le VHD de sauvegarde. Si le disque dur virtuel de stockage se trouve dans un compte de stockage provisionné, « Provisionné » est retourné sinon « Standard » est retourné. Remarque : cette valeur est renseignée par la plateforme Azure lors de la création du disque, et non par l’utilisateur. Cette propriété est renvoyée uniquement avec un en-tête de version 2014-10-01 ou d'une version ultérieure. |
OSVirtualHardDisk
Contient les paramètres utilisés pour créer le disque de système d'exploitation pour une machine virtuelle.
Nom de l'élément | Description |
---|---|
HostCaching | Spécifie le comportement de mise en cache de la plateforme pour l'objet blob de disque de système d'exploitation, pour l'efficacité en lecture/écriture. Les valeurs possibles sont les suivantes : - ReadOnly - ReadWrite |
DiskName | Spécifie le nom d'une image de système d'exploitation dans le référentiel d'images. |
MediaLink | Spécifie l'emplacement dans le stockage Azure du disque dur virtuel associé au disque de système d'exploitation. |
SourceImageName | Spécifie le nom de l'image source qui a été utilisé pour créer le disque de système d'exploitation. |
Système d''exploitation | Spécifie le système d'exploitation exécuté sur la machine virtuelle. Les valeurs possibles sont les suivantes : - Windows - Linux |
RemoteSourceImageLink | Spécifie un URI vers l'emplacement où est stockée une image de système d'exploitation qui a permis de créer la machine virtuelle. Cet emplacement peut être un emplacement différent des référentiels de plateforme ou d'utilisateur dans Azure. Une image est toujours associée à un disque dur virtuel, qui est un fichier .vhd stocké en tant qu'objet blob de pages dans un compte de stockage. Si vous spécifiez le chemin d'accès d'une image à l'aide de cet élément, un disque dur virtuel associé est créé et vous devez utiliser l'élément MediaLink pour spécifier l'emplacement où se trouvera le disque dur virtuel dans le stockage. Si vous utilisez cet élément, SourceImageName n'est pas utilisé. L’élément RemoteSourceImageLink est disponible uniquement à l’aide de la version 2014-05-01 ou ultérieure. |
IOType | Cette propriété identifie le type de compte de stockage pour le VHD de sauvegarde. Si le VHD de sauvegarde est dans un compte de stockage déployé, « Provisioned » est renvoyé, dans le cas contraire « Standard » est renvoyé. Remarque : cette valeur est renseignée par la plateforme Azure lors de la création du disque, et non par l’utilisateur. Cette propriété est renvoyée uniquement avec un en-tête de version 2014-10-01 ou d'une version ultérieure. |
ResourceExtensionReferences
Contient une collection d'extensions de ressources à installer sur la machine virtuelle. Une extension de ressource est un composant logiciel installé sur la machine virtuelle. Pour installer les extensions de ressource, l'agent de machine virtuelle doit être installé sur la machine virtuelle.
Nom de l'élément | Description |
---|---|
ResourceExtensionReference | Obligatoire. Spécifie les propriétés d'une extension de ressource qui doit être installée sur la machine virtuelle. |
ReferenceName | Obligatoire. Spécifie le nom de la référence de l'extension de ressource. |
Serveur de publication | Obligatoire. Spécifie le nom du serveur de publication qui a créé l'extension de ressource. Vous pouvez utiliser List Resource Extensions pour rechercher le nom d’éditeur d’une extension de ressource. |
Nom | Obligatoire. Spécifie le nom de l'extension de ressource. Vous pouvez utiliser Lister les extensions de ressources pour rechercher les noms des extensions de ressources disponibles. |
Version | Obligatoire. Spécifie la version de l'extension de ressource. Vous pouvez utiliser lister les versions de l’extension de ressource pour rechercher la version de l’extension de ressource. |
ResourceExtensionParameterValues | Optionnel. Contient une collection de paramètres qui sont transmis à l'extension de ressource lors de son installation. |
État | Optionnel. Spécifie l'état de l'extension de ressource. Les valeurs possibles sont les suivantes : - Enable - Disable La valeur par défaut est Enable . |
ResourceExtensionParameterValues
Contient une collection de paramètres qui sont transmis à l'extension de ressource lors de son installation.
Nom de l'élément | Description |
---|---|
ResourceExtensionParameterValue | Obligatoire. Spécifie la clé, la valeur et le type du paramètre. |
Clé | Obligatoire. Spécifie la clé du paramètre. |
Valeur | Obligatoire. Spécifie la valeur encodée en base 64 du paramètre. |
Type | Obligatoire. Spécifie le type de l'extension de ressource. Les valeurs possibles sont les suivantes : - Public - Private Si cette valeur est définie sur Private , le paramètre n’est pas retourné par Get Deployment. Vous pouvez spécifier un seul paramètre public et un seul paramètre privé pour un maximum de deux paramètres. |
ExtensionConfiguration
Contient les extensions ajoutées au service cloud.
Nom de l'élément | Description |
---|---|
AllRoles | Spécifie une liste d'extensions qui sont appliquées à tous les rôles dans un déploiement. |
Extension | Spécifie une extension qui doit être déployée dans un rôle dans un service cloud. |
NamedRoles | Spécifie une liste d'extensions qui sont appliquées aux rôles spécifiques dans un déploiement. |
Extension
Spécifie une extension qui doit être déployée dans un rôle dans un service cloud.
Nom de l'élément | Description |
---|---|
Id | Spécifie l'identificateur de l'extension. L'identificateur est créé lorsque l'extension est ajoutée au service cloud. Vous pouvez trouver l’ID d’une extension qui a été ajoutée à un service cloud à l’aide des extensions de liste. |
SequenceNumber | Spécifie le numéro de la dernière configuration appliquée à l'extension. Ce numéro est attribué par Azure et est incrémenté à chaque modification de configuration. L’élément SequenceNumber est disponible uniquement à l’aide de la version 2014-06-01 ou ultérieure. |
État | Optionnel. Spécifie l'état de l'extension. Cet élément s'applique uniquement aux extensions JSON configurées. Les valeurs possibles sont les suivantes : - Enable - Disable - Uninstall La valeur par défaut est Enable .L’élément State est disponible uniquement à l’aide de la version 2014-06-01 ou ultérieure. |
NamedRoles
Spécifie une liste d'extensions qui sont appliquées aux rôles spécifiques dans un déploiement.
Nom de l'élément | Description |
---|---|
Role | Spécifie un rôle spécifique auquel l'extension est ajoutée. |
RoleName | Indique le nom du rôle. |
Extension | Spécifie une extension qui doit être déployée dans un rôle dans un service cloud. |
GuestAgentStatus
Spécifie des informations sur l'agent installé sur une instance.
Nom de l'élément | Description |
---|---|
ProtocolVersion | Spécifie la version du protocole utilisé par l'agent pour la création de rapports d'état. |
Timestamp | Spécifie l'heure UTC à laquelle le rapport d'état a été créé. |
GuestAgentVersion | Spécifie la version de l'agent installé sur l'instance. |
Statut | Spécifie l'état de l'agent. Les valeurs possibles sont les suivantes : - Ready - NotReady |
FormattedMessage | Spécifie un message d'état localisé. |
FormattedMessage
Spécifie un message d'état localisé.
Nom de l'élément | Description |
---|---|
Language | Spécifie la langue du message. |
Message | Spécifie le message. |
ResourceExtensionStatusList
Spécifie des informations sur les extensions installées sur une instance.
Nom de l'élément | Description |
---|---|
ResourceExtensionStatus | Spécifie des informations sur une extension spécifique. |
ResourceExtensionStatus
Spécifie des informations sur une extension spécifique.
Nom de l'élément | Description |
---|---|
HandlerName | Spécifie le nom de l'extension. |
Version | Spécifie la version de l'extension. |
Statut | Spécifie l'état de l'extension. Les valeurs possibles sont les suivantes : - Installing - Ready - NotReady - Unresponsive |
Code | Spécifie le code d'état renvoyé par l'extension. |
FormattedMessage | Spécifie un message d'état localisé. |
ExtensionSettingStatus | Spécifie des informations d'état concernant les paramètres transmis à l'extension. |
PublicIPs
Contient une adresse IP publique pouvant être utilisée en plus de l'adresse IP virtuelle par défaut pour la machine virtuelle.
Nom de l'élément | Description |
---|---|
PublicIP | Obligatoire. Spécifie une adresse IP publique supplémentaire qui peut être utilisée pour communiquer avec la machine virtuelle. |
Nom | Obligatoire. Spécifie le nom de l'adresse IP publique. |
Adresse | Obligatoire. Spécifie l’adresse IP de l’adresse IP publique. |
IdleTimeoutInMinutes | Optionnel. Spécifie le délai d'expiration de la connexion TCP inactive. La valeur peut être comprise entre 4 et 30 minutes. La valeur par défaut est 4 minutes. Cet élément est utilisé uniquement lorsque le protocole est TCP. L’élément IdleTimeoutInMinutes est disponible uniquement à l’aide de la version 2014-06-01 ou ultérieure. |
DomainNameLabel | Optionnel. Spécifie l'étiquette de nom de domaine pour l'adresse IP publique. L’élément DomainNameLabel est disponible uniquement à l’aide de la version 2015-03-01 ou ultérieure. |
Fqdn | Optionnel. Spécifie un nom de domaine complet inscrit pour cette adresse IP publique. |
NetworkInterfaces
Contient un jeu d'interfaces réseau secondaires.
Nom de l'élément | Description |
---|---|
NetworkInterface | Obligatoire. Spécifie une interface réseau secondaire. |
Nom | Obligatoire, spécifie le nom de l'interface réseau secondaire. |
IPConfigurations | Obligatoire. Spécifie un jeu de configurations d'adresse IP pour une interface réseau secondaire. |
IPConfigurations
Spécifie un jeu de configurations d'adresse IP pour une interface réseau secondaire.
Nom de l'élément | Description |
---|---|
IPConfiguration | Obligatoire. Spécifie une configuration d'adresse IP pour une interface réseau secondaire. Actuellement, une seule configuration d'adresse IP est prise en charge pour une interface réseau secondaire. |
SubnetName | Obligatoire. Spécifie le nom du sous-réseau de réseau virtuel auquel appartient cette configuration d'adresse IP. |
Adresse | Obligatoire, spécifie l'adresse IP interne configurée pour une interface réseau secondaire. |
LoadBalancers
Contient une liste de programmes d'équilibrage de charge internes qui peuvent être affectés à des points de terminaison d'entrée.
Nom de l'élément | Description |
---|---|
LoadBalancer | Obligatoire. Spécifie les attributs d'un programme d'équilibrage de charge interne. |
Nom | Obligatoire. Spécifie le nom du programme d'équilibrage de charge interne. |
FrontendIpConfiguration | Obligatoire. Spécifie la configuration pour l'adresse IP virtuelle qui est fournie par le programme d'équilibrage de charge. |
Type | Obligatoire. Spécifie le type de l'adresse IP virtuelle qui est fournie par le programme d'équilibrage de charge. La seule valeur autorisée est Private . |
SubnetName | Obligatoire si le déploiement existe dans un réseau virtuel et qu'un élément StaticVirtualNetworkIPAddress est affecté. Spécifie le sous-réseau du réseau virtuel utilisé par le programme d'équilibrage de charge. L'adresse IP virtuelle qui est gérée par le programme d'équilibrage de charge est contenue dans ce sous-réseau. |
StaticVirtualNetworkIPAddress | Optionnel. Spécifie une adresse IP virtuelle spécifique utilisée par le programme d'équilibrage de charge à partir du sous-réseau dans le réseau virtuel. |
ExtensionSettingStatus
Spécifie des informations d'état concernant les paramètres transmis à l'extension.
Nom de l'élément | Description |
---|---|
Timestamp | Spécifie l'heure UTC à laquelle le rapport d'état a été créé. |
Nom | Spécifie le nom du paramètre transmis à l'extension. |
Opération | Spécifie l'opération réalisée par l'extension à l'aide du paramètre. |
Statut | Spécifie l'état de l'opération. Les valeurs possibles sont les suivantes : - transitioning - error - success - warning |
Code | Spécifie le code d'état de l'opération. |
FormattedMessage | Spécifie un message d'état localisé. |
SubStatusList | Contient une liste d'informations d'état supplémentaires, le cas échéant. |
SubStatusList
Contient une liste d'informations d'état supplémentaires, le cas échéant.
Nom de l'élément | Description |
---|---|
SubStatus | Contient des informations sur les messages d'état supplémentaires renvoyés par l'extension. |
Nom | Spécifie l'identificateur d'état. |
Statut | Spécifie l'état de l'opération. Les valeurs possibles sont les suivantes : - transitioning - error - success - warning |
FormattedMessage | Spécifie un message d'état localisé. |
Notes
Pour obtenir les noms des services cloud dans votre abonnement, vous pouvez utiliser List Services cloud.