Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente un bureau virtuel géré dans le cloud. Ce PC cloud est également inscrit dans Intune et géré via le portail Microsoft Endpoint Manager, de sorte que le PC cloud dispose également d’un ID d’appareil correspondant géré par Intune.
Méthodes
| Méthode | Type de retour | Description |
|---|---|---|
| Répertorier les PC cloudPCs | Collection cloudPC | Répertorier les propriétés et les relations des objets PC cloud. |
| Obtenir cloudPC | Le cloudPC | Lire les propriétés et les relations d’un objet PC cloud. |
| Obtenir des PC cloud configurés | Collection cloudPC | Obtenez tous les PC cloud provisionnés d’un plan de service spécifique pour les utilisateurs d’un groupe d’utilisateurs Microsoft Entra. |
| Modifier le type de compte utilisateur | Aucun | Modifiez le type de compte de l’utilisateur sur un PC cloud spécifique. |
| Mettre fin à la période de grâce | Aucun | Mettre fin à la période de grâce pour un objet PC cloud. |
| Activer | Aucun | Allumez un objet PC cloud de première ligne Windows spécifique. Cette action prend en charge les scénarios d’administration du Gestionnaire de point de terminaison. |
| Éteindre | Aucun | Éteignez un objet PC cloud de première ligne Windows spécifique. Cette action prend en charge les scénarios d’administration du Gestionnaire de point de terminaison. |
| Redémarrer | Aucun | Redémarrez un objet PC cloud spécifique. |
| Rename | Aucun | Renommer un objet PC cloud spécifique. Utilisez cette API pour mettre à jour le displayName de l’entité Cloud PC. |
| Réapprovisionner | Aucun | Réapprovisionner un objet PC cloud. |
| Resize | Aucun | Mettez à niveau ou rétrogradez un PC cloud existant vers une configuration avec un nouveau processeur virtuel (vCPU) et une nouvelle taille de stockage. |
| Start | Aucun | Démarrez un PC cloud spécifique. Actuellement, seuls les PC cloud de première ligne Windows 365 sont pris en charge. |
| Stop | Aucun | Arrêter un cloud spécifique. Actuellement, seuls les PC cloud de première ligne Windows 365 sont pris en charge. |
| Résoudre des problèmes | Aucun | Dépannez un objet PC cloud spécifique. Utilisez cette API pour case activée le status d’intégrité du PC cloud et de l’hôte de session. |
| Restaurer | Aucun | Restaurer un objet PC cloud à un état antérieur à partir d’un instantané. |
| Définir le status de la révision | Aucun | Définissez le status de révision d’un appareil Cloud PC spécifique à l’aide de l’ID Cloud PC. |
| Récupérer le statut de révision | cloudPcReviewStatus | Obtenez le status de révision d’un PC cloud. |
| Récupérer le nombre de PC cloud par status | collection cloudPcStatusSummary | Récupérez le nombre de PC cloud regroupés par status. |
| Liste pour l’utilisateur | Collection cloudPC | Répertorier les appareils PC cloud attribués à l’utilisateur connecté. |
| Récupérer les détails du lancement | cloudPcLaunchDetail | Obtenez le cloudPcLaunchDetail pour un PC cloud spécifique appartenant à l’utilisateur connecté actuel. |
| Obtenir l’historique de connectivité | collection cloudPcConnectivityEvent | Obtenir l’historique de connectivité du PC cloud. |
| Obtenir des actions à distance prises en charge | collection cloudPcRemoteActionCapability | Obtenez une liste des actions distantes de PC cloud prises en charge pour un appareil Cloud PC spécifique, y compris les noms d’action et les fonctionnalités. |
| Récupérer les résultats des actions distantes | collection cloudPcRemoteActionResult | Récupérez les résultats d’une action à distance et case activée la status d’une action à distance spécifique effectuée sur l’appareil Cloud PC associé. |
| Réessayer l’installation de l’agent partenaire | Aucun | Retentez l’installation pour les agents partenaires dont l’installation a échoué sur le PC cloud. |
| Valider le redimensionnement en bloc | collecte cloudPcResizeValidateResult | Vérifiez qu’un ensemble d’appareils Cloud PC répond aux exigences pour être redimensionné en bloc. |
| Créer un instantané | Aucun | Créez un instantané pour un appareil PC cloud spécifique. |
| Récupérer des instantanés | collection cloudPcSnapshot | Obtenez une liste des ressources cloudPcSnapshot pour un PC cloud. |
| Partager l’instantané | Aucun | Partagez un instantané pour un appareil PC cloud spécifique. |
| Obtenir l’état d’accès de première ligne | frontlineCloudPcAccessState | Obtenez l’état d’accès du PC cloud de première ligne. Les valeurs possibles sont unassigned, noLicensesAvailable, activationFailed, active, activating, standbyMode, unknownFutureValue. Le noLicensesAvailable membre est déconseillé et a cessé de revenir le 30 septembre 2024. |
| Obtenir des informations de lancement (déconseillé) | cloudPcLaunchInfo | Obtenez le cloudPCLaunchInfo pour un PC cloud spécifique appartenant à l’utilisateur connecté actuel. Cette API est déconseillée et cessera de retourner des données le 30 octobre 2026. À l’avenir, utilisez l’API Récupérer les détails du lancement . |
| Récupérer les détails du PC cloud de première ligne | frontlineCloudPcDetail | Obtenez le frontlineCloudPcDetail d’un PC Cloud de première ligne. |
| Déclencher une action d’organisation Cloud PC | cloudPcOrganizationActionDetail | Déclencher une action d’organisation Cloud PC. |
| Récupérer un PC cloud détail de l’action de l’organisation | cloudPcOrganizationActionDetail | Récupérez les détails d’un cloudPcOrganizationActionDetail. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| aadDeviceId | String | ID de périphérique Microsoft Entra du PC cloud. |
| allotmentDisplayName | String | Le nom de l’allotment divise les licences client en lots ou groupes plus petits qui permettent de limiter le nombre de licences disponibles pour une attribution spécifique. Lorsque provisioningType est dedicated, le nom de l’allocation est null. En lecture seule. |
| Résultat de connectivité | cloudPcConnectivityResult | Résultat du case activée de l’intégrité de la connectivité d’un PC cloud, y compris l’horodatage mis à jour et la possibilité de connecter le PC cloud. |
| deviceRegionName | String | Nom de la région géographique dans laquelle le PC cloud est actuellement configuré. Par exemple, westus3, et southeastasia. eastus2 En lecture seule. |
| disasterRecoveryCapability | cloudPcDisasterRecoveryCapability | Le status de reprise d’activité du PC cloud, y compris la région principale, la région secondaire et le type de capacité. La valeur par défaut indique null que le paramètre de récupération d’urgence est désactivé. Pour recevoir une réponse avec la propriété disasterRecoveryCapability , $select et $filter dans l’URL disasterRecoveryCapability/{subProperty} de demande. Pour plus d’informations, consultez l’exemple 3 : répertorier les PC cloud filtrés par type de capacité de récupération d’urgence. En lecture seule. |
| diskEncryptionState | cloudPcDiskEncryptionState | Chiffrement de disque appliqué au PC cloud. Les valeurs possibles sont notAvailable, notEncrypted, encryptedUsingPlatformManagedKey, encryptedUsingCustomerManagedKey et unknownFutureValue. |
| displayName | String | Nom d’affichage du PC cloud. |
| gracePeriodEndDateTime | DateTimeOffset | Date et heure auxquelles la période de grâce se termine et où le réapprovisionnement ou le déprovisionnement se produit. Obligatoire uniquement si le status est inGracePeriod. L’horodatage est indiqué au format ISO 8601 et UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| groupDetail | cloudPcEntraGroupDetail | Détails du groupe Microsoft Entra (par exemple, ID et nom complet) pour le groupe ID Entra associé à l’attribution Réserver un PC cloud de l’utilisateur. En lecture seule. |
| id | String | Identifiant unique du PC cloud. En lecture seule. |
| imageDisplayName | String | Nom de l’image du système d’exploitation qui se trouve sur le PC cloud. |
| lastLoginResult | cloudPcLoginResult | Le dernier résultat de connexion du PC cloud. Par exemple : { "time": "2014-01-01T00:00:00Z"}. |
| lastLogoffDateTime | DateTimeOffset | Date et heure de la dernière déconnexion de la session PC cloud par l’utilisateur. Retourne null si l’utilisateur n’a jamais établi de session ou si une session est actuellement active. L’horodatage est affiché au format ISO 8601 et toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. En lecture seule. Renvoyé uniquement lorsqu’il est explicitement sélectionné avec $select. |
| lastModifiedDateTime | DateTimeOffset | Date et heure de la dernière modification du PC cloud. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, minuit UTC le 1er janvier 2014 est 2014-01-01T00:00:00Z. |
| lastRemoteActionResult | cloudPcRemoteActionResult | Le résultat de la dernière action à distance des PC Cloud d’entreprise. Les actions distantes prises en charge sont les suivantes : Reboot, , Rename, ReprovisionRestoreTroubleshoot, , . |
| managedDeviceId | String | ID de l’appareil Intune du PC cloud. |
| managedDeviceName | String | Nom de périphérique Intune du PC cloud. |
| onPremisesConnectionName | String | Connexion réseau Azure qui est appliquée lors de l’approvisionnement des PC cloud. |
| osVersion | cloudPcOperatingSystem | Version du système d’exploitation à configurer sur les PC cloud. Les valeurs possibles sont windows10, windows11, unknownFutureValue. |
| partnerAgentInstallResults | collecte cloudPcPartnerAgentInstallResult | Les résultats de l’installation de chaque agent partenaire status sur le PC cloud. |
| powerState | cloudPcPowerState | L’état d’alimentation d’un PC cloud. Les valeurs possibles sont running, poweredOff, unknown. Cette propriété ne prend en charge que le travail posté sur PC cloud. |
| productType | cloudPcProductType | Type de produit du PC cloud. Les valeurs possibles sont enterprise, frontline, devBox, powerAutomate, business, unknownFutureValue. Pour connaître les plans de service disponibles et les tarifs pour enterprise, frontlinevoir businessWindows 365 pour les entreprises. Pour plus d’informations sur la tarification de devBox, consultez Tarification de Microsoft Dev Box. Pour connaître les plans disponibles et les tarifs de powerAutomate, consultez Tarification de Power Automate. La valeur par défaut est enterprise. Prend en charge $filter et $select. Pour plus d’informations, consultez l’exemple 4 : répertorier les PC cloud filtrés par type de produit. En lecture seule. |
| provisionedDateTime | DateTimeOffset | La dernière date et heure approvisionnées, générées et attribuées automatiquement lors du provisionnement initial ou de tout réapprovisionnement ultérieur du PC cloud. Le type d’horodatage représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| provisioningPolicyId | String | ID de stratégie d’approvisionnement du PC cloud. |
| nom_stratégie de provisionnement | String | Stratégie d’approvisionnement appliquée lors de l’approvisionnement des PC cloud. |
| ApprovisionnementType | cloudPcProvisioningType | Type de licences à utiliser lors de l’approvisionnement des PC cloud à l’aide de cette stratégie. Les valeurs possibles sont dedicated, shared, unknownFutureValue, sharedByUser, sharedByEntraGroup, reserve. Utilisez l’en-tête de Prefer: include-unknown-enum-members requête pour obtenir les valeurs suivantes à partir de cette énumération évolutive : sharedByUser, , sharedByEntraGroupreserve. La valeur par défaut est dedicated. Le shared membre est déconseillé et cessera de revenir le 30 avril 2027 ; à l’avenir, utilisez le sharedByUser membre. |
| scopeIds | String collection | ID d’étendue de l’autorisation correspondante. Actuellement, il s’agit de l’ID de balise d’étendue Intune. En lecture seule. |
| servicePlanId | String | ID de plan de service du PC cloud. |
| servicePlanName | String | Nom du plan de service du PC cloud. |
| servicePlanType | cloudPcServicePlanType | Type de plan de service du PC cloud. |
| sharedDeviceDetail | cloudPcFrontlineSharedDeviceDetail | Indique les détails de l’appareil PC cloud associé au plan de services partagés de première ligne, y compris l’UPN de l’utilisateur et la date et l’heure de début de session. |
| status | cloudPcStatus | L’état du PC cloud. Les valeurs possibles sont : notProvisioned, , provisionedprovisioning, inGracePeriodfailedrestoringresizingpendingProvisionunknownFutureValueprovisionedWithWarningsdeprovisioningresizePendingLicensemodifyingSingleSignOnmovingRegionrefreshPolicyConfigurationet .preparing Utilisez l’en-tête de Prefer: include-unknown-enum-members requête pour obtenir les valeurs suivantes à partir de cette énumération évolutive : movingRegion, resizePendingLicense, modifyingSingleSignOn, refreshPolicyConfigurationet preparing. |
| Détail de l’état | cloudPcStatusDetail | Indique le status détaillé associé à Cloud PC, y compris le code d’erreur/avertissement, le message d’erreur/d’avertissement et les informations supplémentaires. Par exemple : { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. |
| connectionSetting | cloudPcConnectionSetting | Paramètre de connexion du PC cloud. Valeurs possibles : enableSingleSignOn. En lecture seule. |
| userAccountType | cloudPcUserAccountType | Type de compte de l’utilisateur sur les PC cloud configurés. Les valeurs possibles sont standardUser, administrator, unknownFutureValue. |
| userExperienceType | cloudPcUserExperienceType | Spécifie le type d’objet cloud auquel l’utilisateur final peut accéder. Les valeurs possibles sont cloudPc, cloudApp, unknownFutureValue. Lorsque la valeur est , elle indique que l’utilisateur final peut accéder à cloudPcl’intégralité du bureau. Lorsque la valeur est , cloudAppelle indique que l’utilisateur final peut uniquement accéder aux applications cloud publiées dans le cadre de la stratégie d’approvisionnement associée. Étant donné que l’expérience d’application cloud crée également des périphériques Cloud PC qui apparaissent dans la liste des périphériques Cloud PC, cette propriété permet de les différencier. La valeur par défaut est cloudPc. Cette propriété est définie dans la stratégie d’approvisionnement. |
| userDetail | cloudPcEntraUserDetail | Détails de l’utilisateur (par exemple, ID et nom d’affichage) de l’utilisateur associé à une attribution de PC Reserve Cloud. En lecture seule. |
| userPrincipalName | String | Nom d’utilisateur principal (UPN) de l’utilisateur affecté au PC cloud. |
| connectionSettings (déconseillé) | cloudPcConnectionSettings | Les paramètres de connexion du PC cloud. Valeurs possibles : enableSingleSignOn. En lecture seule. Cette propriété est déconseillée et a cessé de réajuster les données le 31 août 2024. Ensuite, utilisez la propriété connectionSetting . |
| frontlineCloudPcAvailability (déconseillé) | frontlineCloudPcAvailability | La disponibilité actuelle d’un PC cloud affecté en première ligne. Valeurs possibles : notApplicable, available, notAvailableet unknownFutureValue. La valeur par défaut est notApplicable. En lecture seule. Cette propriété est déconseillée et cessera de retourner des données le 30 octobre 2025. À l’avenir, utilisez l’API retrieveFrontlineCloudPcDetail . |
| statusDetails (déconseillé) | cloudPcStatusDetails | Détails du status du PC cloud. Par exemple : { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. Cette propriété est déconseillée et ne sera plus prise en charge à compter du 31 août 2024. Utilisez plutôt statusDetail. |
cloudPcDiskEncryptionState values
| Member | Description |
|---|---|
| notAvailable | Le PC cloud n’est pas approvisionné ou se trouve dans un état où le chiffrement n’est pas disponible. |
| notEncrypted | Le PC cloud doit être chiffré, mais le chiffrement ne l’est pas encore (réservé, cela ne devrait pas se produire). |
| encryptedUsingPlatformManagedKey | Le PC cloud est chiffré à l’aide d’une clé gérée par la plateforme. Ce membre est la valeur par défaut si la clé gérée par le client n’est pas activée. |
| encryptedUsingCustomerManagedKey | Le PC cloud est chiffré à l’aide d’une clé gérée par le client. |
| unknownFutureValue | Valeur sentinelle d’énumération évolutive. Ne pas utiliser. |
valeurs cloudPcPowerState
| Member | Description |
|---|---|
| exécution en cours | Le status PC cloud est en cours d’exécution. |
| poweredOff | Le status PC cloud est désactivé. |
| unknown | Le status du PC cloud est inconnu. |
Valeurs cloudPcStatus
Le tableau suivant répertorie les membres d’une énumération évolutive. Vous devez utiliser l’en-tête de Prefer: include-unknown-enum-members requête pour obtenir les valeurs suivantes dans cette énumération évolutive : movingRegion, resizePendingLicense, modifyingSingleSignOn, preparing, .
| Member | Description |
|---|---|
| notProvisioned | Le PC cloud n’a pas encore été approvisionné. |
| Approvisionnement | Le provisionnement des PC cloud est en cours. |
| mis en service | Le PC cloud est configuré et les utilisateurs peuvent y accéder. |
| inGracePeriod | Le PC cloud est dans la période de grâce d’une semaine avant la déprovisionnabilité. |
| annulation de l’approvisionnement | Le PC cloud est en cours d’annulation d’approvisionnement. |
| a échoué | Échec de l’opération sur PC cloud. |
| provisionedWithWarnings | Le PC cloud est configuré et les utilisateurs finaux peuvent y accéder avec quelques avertissements. L’utilisateur peut continuer à utiliser ce PC cloud. |
| Redimensionnement | Le PC cloud est en cours de redimensionnement. |
| pendingProvision | Le provisionnement est en attente sur le PC cloud. Dans ce cas, le nombre de PC cloud pendant la période de grâce est supérieur au nombre total de licences disponibles. |
| restauration | Le PC cloud est en cours de restauration. |
| unknownFutureValue | Valeur sentinelle d’énumération évolutive. Ne pas utiliser. |
| movingRegion | Indique que le PC cloud est déplacé d’une région à une autre. |
| resizePendingLicense | Indique que le processus de redimensionnement de PC cloud a été lancé, mais ne peut pas être terminé, car la licence cible n’a pas été identifiée. Il attend actuellement une action du client pour résoudre le problème de licence. |
| modification de l’authentification unique | Indique que le PC cloud met à jour le paramètre d’authentification unique. |
| refreshPolicyConfiguration | Indique que le PC cloud est en train d’actualiser les nouvelles configurations de stratégie. |
| Préparation | Indique que le PC cloud se prépare avec la configuration définie par l’administrateur informatique (Applications, Configuration et sécurité), apparaît après le status d’approvisionnement. Appliquer uniquement aux appareils partagés de première ligne. |
valeurs frontlineCloudPcAccessState
| Member | Description |
|---|---|
| non attribué | Défini sur Non affecté si le PC cloud ne consomme aucune licence d’utilisation partagée. La valeur par défaut est unassigned. |
| noLicensesAvailable (déconseillé) | Indique que toutes les licences d’utilisation partagée sont en cours d’utilisation. Le noLicensesAvailable membre est déconseillé et cessera de revenir le 30 septembre 2024. |
| activationFailed | Indique que l’activation du PC cloud de première ligne a échoué après que l’utilisateur a demandé un PC cloud de première ligne. |
| Actif | Indique que le PC cloud de première ligne est dans un état actif avec une licence d’utilisation partagée attribuée, et que l’utilisateur peut se connecter au PC cloud. |
| Activation | Indique qu’un utilisateur a demandé à connecter le PC cloud et que le service démarre. |
| mode veille | Indique que le PC cloud de première ligne est en état de veille avant d’être arrêté et libéré. Un PC cloud de première ligne en état de veille est toujours accessible par l’utilisateur. |
| unknownFutureValue | Valeur sentinelle d’énumération évolutive. Ne pas utiliser. |
Valeurs cloudPcProductType
| Member | Description |
|---|---|
| Entreprise | Valeur par défaut. Indique le type de produit PC cloud pour les grandes entreprises qui souhaitent déployer des PC cloud dans leur organisation pour un nombre illimité d’utilisateurs. |
| ligne de front | Indique le type de produit Cloud PC pour que les travailleurs de première ligne et à temps partiel partagent des appareils, ce qui leur permet d’utiliser des PC Cloud pendant leurs shifts. |
| DevBox | Indique le type de produit PC cloud préconfiguré avec des outils, des services et des ressources pour les développeurs, les équipes de développement et les professionnels de l’informatique. |
| powerAutomate | Indique le type de produit PC cloud pour que les clients Power Automate exécutent des APR (automatisation de processus robotisées) assistées et non assistées sur leurs PC cloud. |
| les entreprises | Indique le type de produit PC cloud pour les clients des petites entreprises comptant jusqu’à 300 utilisateurs. |
| unknownFutureValue | Valeur sentinelle d’énumération évolutive. Ne pas utiliser. |
Relations
Aucun.
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "String",
"allotmentDisplayName": "String",
"connectivityResult": {"@odata.type": "microsoft.graph.cloudPcConnectivityResult"},
"connectionSetting": {"@odata.type": "microsoft.graph.cloudPcConnectionSetting"},
"connectionSettings": {"@odata.type": "microsoft.graph.cloudPcConnectionSettings"},
"deviceRegionName": "String",
"disasterRecoveryCapability": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryCapability"},
"diskEncryptionState": "String",
"displayName": "String",
"gracePeriodEndDateTime": "String (timestamp)",
"groupDetail": {"@odata.type": "microsoft.graph.cloudPcEntraGroupDetail"},
"id": "String (identifier)",
"imageDisplayName": "String",
"lastLoginResult": {"@odata.type": "microsoft.graph.cloudPcLoginResult"},
"lastLogoffDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"lastRemoteActionResult": {"@odata.type": "microsoft.graph.cloudPcRemoteActionResult"},
"managedDeviceId": "String",
"managedDeviceName": "String",
"onPremisesConnectionName": "String",
"osVersion": "String",
"partnerAgentInstallResults": [{"@odata.type": "microsoft.graph.cloudPcPartnerAgentInstallResult"}],
"powerState": "String",
"productType": "String",
"provisionedDateTime": "String (timestamp)",
"provisioningPolicyId": "String",
"provisioningPolicyName": "String",
"provisioningType": "String",
"servicePlanId": "String",
"servicePlanName": "String",
"servicePlanType": "String",
"scopeIds": ["String"],
"sharedDeviceDetail": {"@odata.type": "microsoft.graph.cloudPcFrontlineSharedDeviceDetail"},
"status": "String",
"statusDetail": {"@odata.type": "microsoft.graph.cloudPcStatusDetail"},
"userAccountType": "String",
"userExperienceType": "String",
"userDetail": {"@odata.type": "microsoft.graph.cloudPcEntraUserDetail"},
"userPrincipalName": "String"
}