Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Cree un nuevo objeto cloudPcOnPremisesConnection para aprovisionar equipos en la nube.
Importante
El nombre de la conexión de red local ha cambiado a Conexión de red de Azure. los objetos cloudPcOnPremisesConnection son equivalentes a la conexión de red de Azure para el producto Cloud PC.
Esta API está disponible en las siguientes implementaciones en la nube nacional.
| Servicio global | Administración pública de EE. UU. | Gobierno de EE. UU. L5 (DOD) | China operado por 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ❌ | ❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
| Tipo de permiso | Permisos con privilegios mínimos | Permisos con privilegios más altos |
|---|---|---|
| Delegado (cuenta profesional o educativa) | CloudPC. ReadWrite. All | No disponible. |
| Delegado (cuenta personal de Microsoft) | No admitida. | No admitida. |
| Aplicación | No admitida. | No admitida. |
Solicitud HTTP
POST /deviceManagement/virtualEndpoint/onPremisesConnections
Encabezados de solicitud
| Nombre | Descripción |
|---|---|
| Authorization | {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización. |
| Content-Type | application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione una representación JSON del objeto cloudPcOnPremisesConnection .
En la tabla siguiente se enumeran las propiedades que puede proporcionar al crear el objeto.
Para una conexión híbrida de unión a Microsoft Entra, proporcione adDomainName y domainJoinCredential o las propiedades adDomainUsername y adDomainPassword obsoletas. Las credenciales de unión a dominio no son necesarias para una conexión de unión a Microsoft Entra.
Cuando especifique domainJoinCredential, establezca su @odata.type en #microsoft.graph.cloudPcPlainTextDomainJoinCredential o #microsoft.graph.cloudPcKeyVaultDomainJoinCredential. Si domainJoinCredential y las propiedades de credenciales en desuso se proporcionan, domainJoinCredential tiene prioridad.
| Propiedad | Tipo | Description |
|---|---|---|
| adDomainName | Cadena | El nombre de dominio completo (FQDN) del dominio de Active Directory al que desea unirse. Necesario para una conexión híbrida de unión a Microsoft Entra. |
| connectionType | cloudPcOnPremisesConnectionType | Especifica el método por el que se une un PC en la nube aprovisionado a Microsoft Entra. La azureADJoin opción indica la ausencia de un Active Directory local (AD) en el inquilino actual, lo que hace que el dispositivo PC en la nube solo se una a Microsoft Entra. La hybridAzureADJoin opción indica la presencia de un AD local en el inquilino actual y que el PC en la nube se une tanto al AD local como a Microsoft Entra. La opción seleccionada también determina los tipos de usuarios que se pueden asignar y pueden iniciar sesión en un PC en la nube. La azureADJoin opción permite que los usuarios híbridos y de nube se asignen e inicien sesión, mientras que hybridAzureADJoin está restringida solo a usuarios híbridos. El valor predeterminado es hybridAzureADJoin. Los valores posibles son: hybridAzureADJoin, azureADJoin, unknownFutureValue. |
| displayName | Cadena | El nombre para mostrar de la conexión de red de Azure. Obligatorio. |
| domainJoinCredential | cloudPcDomainJoinCredential | Credencial de unión al dominio de Active Directory. Necesario para una conexión híbrida de unión a Microsoft Entra a menos que se proporcionen las propiedades adDomainUsername y adDomainPassword obsoletas. |
| organizationalUnit | Cadena | La unidad organizativa (OU) en la que se crea la cuenta informática. Si se omite, se usa el contenedor de objetos de equipo predeterminado del dominio de Active Directory. Opcional. |
| resourceGroupId | Cadena | Id. del grupo de recursos de destino. Formato requerido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}. Obligatorio. |
| subnetId | Cadena | Id. de la subred de destino. Formato requerido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Obligatorio. |
| subscriptionId | Cadena | El identificador de la suscripción de Azure de destino asociada a su inquilino. Obligatorio. |
| virtualNetworkId | Cadena | Id. de la red virtual de destino. Formato requerido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}. Obligatorio. |
| adDomainPassword (obsoleto) | Cadena | La contraseña asociada a adDomainUsername. Requerido con adDomainUsername para una conexión híbrida de unión a Microsoft Entra cuando no se proporciona domainJoinCredential. Esta propiedad está en desuso y se quitará el 31 de diciembre de 2026. En el futuro, use la propiedad domainJoinCredential en su lugar. |
| adDomainUsername (obsoleto) | Cadena | El UPN de una cuenta de Active Directory que tiene permisos para crear objetos de equipo en Active Directory, por ejemplo, dcadmin@contoso001.com. Requerido con adDomainPassword para una conexión híbrida de unión a Microsoft Entra cuando no se proporciona domainJoinCredential. Esta propiedad está en desuso y se quitará el 31 de diciembre de 2026. En el futuro, use la propiedad domainJoinCredential en su lugar. |
| Tipo (en desuso) | cloudPcOnPremisesConnectionType | Especifica cómo se une el PC en la nube aprovisionado a Microsoft Entra ID. El valor predeterminado es hybridAzureADJoin. Los valores posibles son: hybridAzureADJoin, azureADJoin, unknownFutureValue. La propiedad type quedó en desuso y dejó de devolver datos el 31 de enero de 2024. Usa connectionType en su lugar. |
Respuesta
Si se realiza correctamente, este método devuelve un 201 Created código de respuesta y un objeto cloudPcOnPremisesConnection en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: Crear una conexión mediante las propiedades adDomainPassword y adDomainUsername
Por motivos de compatibilidad, en el ejemplo siguiente se muestra cómo crear una conexión mediante las propiedades en desuso. En el futuro, use domainJoinCredential como se muestra en los ejemplos siguientes.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections
Content-Type: application/json
{
"displayName": "test-canary-02",
"connectionType": "hybridAzureADJoin",
"type": "hybridAzureADJoin",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
"adDomainName": "contoso001.com",
"adDomainPassword": "ExamplePassword!42",
"adDomainUsername": "dcadmin@contoso001.com",
"organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet"
}
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"id": "ac2ad805-167e-49ee-9bef-196c4ce7ffff",
"managedBy": "windows365",
"displayName": "test-canary-02",
"connectionType": "hybridAzureADJoin",
"type": "hybridAzureADJoin",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
"subscriptionName": "CPC customer 001 test subscription",
"adDomainName": "contoso001.com",
"adDomainUsername": "dcadmin@contoso001.com",
"organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
"healthCheckStatus": "pending"
}
Ejemplo 2: Crear una conexión con una contraseña almacenada en Azure Key Vault
En el ejemplo siguiente se proporciona el nombre principal del usuario de unión al dominio directamente y se hace referencia a un secreto Azure Key Vault para la contraseña.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections
Content-Type: application/json
{
"displayName": "test-canary-02",
"connectionType": "hybridAzureADJoin",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
"adDomainName": "contoso001.com",
"organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
"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@contoso001.com"
}
}
}
}
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"id": "ac2ad805-167e-49ee-9bef-196c4ce7ffff",
"managedBy": "windows365",
"displayName": "test-canary-02",
"connectionType": "hybridAzureADJoin",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
"subscriptionName": "CPC customer 001 test subscription",
"adDomainName": "contoso001.com",
"adDomainUsername": "dcadmin@contoso001.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@contoso001.com"
}
}
},
"organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
"healthCheckStatus": "pending"
}
Ejemplo 3: Crear una conexión con una credencial de texto sin formato
En el ejemplo siguiente se proporciona el nombre de entidad de seguridad de usuario de unión a dominio y la contraseña a través de domainJoinCredential, sin las propiedades de credenciales obsoletas.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections
Content-Type: application/json
{
"displayName": "Contoso plain-text connection",
"connectionType": "hybridAzureADJoin",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
"adDomainName": "contoso001.com",
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
"domainJoinCredential": {
"@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
"domainUserPrincipalName": "dcadmin@contoso001.com",
"domainPassword": "ExamplePassword!42"
}
}
Respuesta
En el ejemplo siguiente se muestra la respuesta. No se devuelve la propiedad domainPassword .
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"id": "5ab42e01-828b-4a80-8a5f-e80bd4b78534",
"managedBy": "windows365",
"displayName": "Contoso plain-text connection",
"connectionType": "hybridAzureADJoin",
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
"adDomainName": "contoso001.com",
"adDomainUsername": "dcadmin@contoso001.com",
"domainJoinCredential": {
"@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
"domainUserPrincipalName": "dcadmin@contoso001.com"
},
"resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
"virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
"subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
"healthCheckStatus": "pending"
}