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 .
Mettez à jour les propriétés d’un objet cloudPcOnPremisesConnection .
Importante
La connexion réseau locale a été renommée connexion réseau Azure. Les objets cloudPcOnPremisesConnection sont ici équivalents à la connexion réseau Azure pour le produit Cloud PC.
Cette API est disponible dans les déploiements cloud nationaux suivants.
| Service global | Gouvernement américain L4 | Gouvernement américain L5 (DOD) | Chine exploitée par 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ❌ | ❌ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.
| Type d’autorisation | Autorisations les moins privilégiées | Autorisations à privilèges plus élevés |
|---|---|---|
| Déléguée (compte professionnel ou scolaire) | CloudPC.ReadWrite.All | Non disponible. |
| Déléguée (compte Microsoft personnel) | Non prise en charge. | Non prise en charge. |
| Application | Non prise en charge. | Non prise en charge. |
Requête HTTP
PATCH /deviceManagement/virtualEndpoint/onPremisesConnections/{id}
En-têtes de demande
| Nom | Description |
|---|---|
| Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations. |
| Content-Type | application/json. Obligatoire. |
Corps de la demande
Dans le corps de la demande, fournissez une représentation JSON de l’objet cloudPcOnPremisesConnection .
Le tableau suivant répertorie les propriétés que vous pouvez mettre à jour. Fournissez uniquement les propriétés que vous souhaitez modifier ; Les propriétés omises conservent leurs valeurs actuelles.
Lorsque vous spécifiez domainJoinCredential, définissez son @odata.type sur #microsoft.graph.cloudPcPlainTextDomainJoinCredential ou #microsoft.graph.cloudPcKeyVaultDomainJoinCredential. Si domainJoinCredential et adDomainPassword sont tous deux fournis, domainJoinCredential est prioritaire.
Pour faire pivoter les informations d’identification de jonction de domaine sur une connexion réussie, utilisez updateAdDomainPassword.
| Propriété | Type | Description |
|---|---|---|
| adDomainName | String | Le nom de domaine complet (FQDN) du domaine Active Directory que vous souhaitez joindre. |
| connectionType | cloudPcOnPremisesConnectionType | Spécifie la méthode par laquelle un PC cloud configuré est joint à Microsoft Entra. L’option azureADJoin indique l’absence d’un Active Directory local (AD) dans le client actuel, ce qui entraîne la jonction du périphérique PC cloud uniquement à Microsoft Entra. L’option hybridAzureADJoin indique la présence d’un AD local dans le client actuel et que le Cloud PC rejoint à la fois AD local et Microsoft Entra. L’option sélectionnée détermine également les types d’utilisateurs qui peuvent être affectés et qui peuvent se connecter à un PC cloud. L’option azureADJoin permet d’attribuer et de se connecter aux utilisateurs cloud uniquement et hybrides, alors qu’elle hybridAzureADJoin est réservée aux utilisateurs hybrides uniquement. La valeur par défaut est hybridAzureADJoin. Les valeurs possibles sont hybridAzureADJoin, azureADJoin, unknownFutureValue. |
| displayName | String | Nom complet de la connexion réseau Azure. |
| domainJoinCredential | cloudPcDomainJoinCredential | Informations d’identification de jonction de domaine Active Directory. Facultatif. Si elles sont fournies, incluez toutes les propriétés requises du type d’informations d’identification sélectionné. |
| OrganizationalUnit | String | Unité d’organisation dans laquelle le compte d’ordinateur est créé. |
| resourceGroupId | String | ID du groupe de ressources cible. Format obligatoire : /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}. |
| subnetId | String | ID du sous-réseau cible. Format obligatoire : /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. |
| subscriptionId | String | ID de l’abonnement Azure cible associé à votre client. |
| virtualNetworkId | String | ID du réseau virtuel cible. Format obligatoire : /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}. |
| adDomainPassword (déconseillé) | String | Mot de passe associé à adDomainUsername. Cette propriété est déconseillée et sera supprimée le 31 décembre 2026. À l’avenir, utilisez plutôt la propriété domainJoinCredential . |
| adDomainUsername (déconseillé) | String | L’UPN d’un compte Active Directory disposant d’autorisations pour créer des objets ordinateur dans Active Directory, par exemple. dcadmin@contoso.com Cette propriété est déconseillée et sera supprimée le 31 décembre 2026. Ensuite, utilisez plutôt la propriété domainJoinCredential/domainUserPrincipalName . |
| Type (déconseillé) | cloudPcOnPremisesConnectionType | Spécifie comment le PC cloud configuré se joint à Microsoft Entra ID. La valeur par défaut est hybridAzureADJoin. Les valeurs possibles sont hybridAzureADJoin, azureADJoin, unknownFutureValue. La propriété type est déconseillée et ne renvoie plus de données depuis le 31 janvier 2024. Utilisez plutôt connectionType . |
Réponse
En cas de succès, cette méthode renvoie un 200 OK code de réponse et un objet cloudPcOnPremisesConnection mis à jour dans le corps de la réponse.
Exemples
Exemple 1 : mettre à jour les propriétés de connexion à l’aide de adDomainPassword et adDomainUsername
L’exemple suivant montre comment mettre à jour les propriétés de connexion à l’aide de adDomainPassword et adDomainUsername. Pour les modifications d’informations d’identification à l’avenir, utilisez domainJoinCredential comme illustré dans les exemples suivants.
Demande
L’exemple suivant illustre une demande.
PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections/{id}
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"displayName": "Display Name value",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
"subscriptionName": "Subscription Name value",
"adDomainName": "Active Directory Domain Name value",
"adDomainUsername": "Active Directory Domain User Name value",
"organizationalUnit": "Organization Unit value",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default"
}
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff",
"managedBy": "windows365",
"type": "hybridAzureADJoin",
"connectionType": "hybridAzureADJoin",
"displayName": "Display Name value",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
"subscriptionName": "Subscription Name value",
"adDomainName": "Active Directory Domain Name value",
"adDomainUsername": "Active Directory Domain User Name value",
"organizationalUnit": "Organization Unit value",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default",
"healthCheckStatus": "running",
"virtualNetworkLocation": "westus2"
}
Exemple 2 : utiliser un mot de passe stocké dans Azure Key Vault
L’exemple suivant montre comment mettre à jour les informations d’identification de jonction de domaine pour référencer un secret Azure Key Vault.
Demande
L’exemple suivant illustre une demande.
PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff
Content-Type: application/json
{
"domainJoinCredential": {
"@odata.type": "#microsoft.graph.cloudPcKeyVaultDomainJoinCredential",
"keyVaultResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.KeyVault/vaults/contoso-kv",
"secretName": "ad-domain-join-password",
"serviceConnectorResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.Windows365/serviceConnectors/anc-kv-connector",
"keyVaultIntentConfiguration": {
"@odata.type": "#microsoft.graph.cloudPcDomainJoinKeyVaultPasswordConfiguration",
"userIdentity": {
"@odata.type": "#microsoft.graph.cloudPcDomainJoinPlainTextUserIdentity",
"domainUserPrincipalName": "dcadmin@contoso.com"
}
}
}
}
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff",
"managedBy": "windows365",
"connectionType": "hybridAzureADJoin",
"displayName": "Contoso Azure network connection",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
"subscriptionName": "Contoso subscription",
"adDomainName": "contoso.com",
"adDomainUsername": "dcadmin@contoso.com",
"domainJoinCredential": {
"@odata.type": "#microsoft.graph.cloudPcKeyVaultDomainJoinCredential",
"keyVaultResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.KeyVault/vaults/contoso-kv",
"secretName": "ad-domain-join-password",
"serviceConnectorResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.Windows365/serviceConnectors/anc-kv-connector",
"keyVaultIntentConfiguration": {
"@odata.type": "#microsoft.graph.cloudPcDomainJoinKeyVaultPasswordConfiguration",
"userIdentity": {
"@odata.type": "#microsoft.graph.cloudPcDomainJoinPlainTextUserIdentity",
"domainUserPrincipalName": "dcadmin@contoso.com"
}
}
},
"organizationalUnit": "OU=Cloud PCs,DC=contoso,DC=com",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/ExampleRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default",
"healthCheckStatus": "running",
"virtualNetworkLocation": "westus2"
}
Exemple 3 : Mettre à jour des informations d’identification en texte brut
L’exemple suivant fournit le nom d’utilisateur principal et le mot de passe de l’utilisateur de jonction de domaine via domainJoinCredential.
Demande
L’exemple suivant illustre une demande.
PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff
Content-Type: application/json
{
"domainJoinCredential": {
"@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
"domainUserPrincipalName": "dcadmin@contoso.com",
"domainPassword": "ExamplePassword!42"
}
}
Réponse
L’exemple suivant illustre la réponse. La propriété domainPassword n’est pas renvoyée.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff",
"displayName": "Contoso Azure network connection",
"connectionType": "hybridAzureADJoin",
"adDomainName": "contoso.com",
"adDomainUsername": "dcadmin@contoso.com",
"domainJoinCredential": {
"@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
"domainUserPrincipalName": "dcadmin@contoso.com"
},
"healthCheckStatus": "running"
}