Actualizar cloudPcOnPremisesConnection

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.

Actualice las propiedades de un objeto cloudPcOnPremisesConnection .

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

PATCH /deviceManagement/virtualEndpoint/onPremisesConnections/{id}

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 actualizar. Suministre solo las propiedades que desea cambiar; Las propiedades omitidas conservan sus valores actuales.

Cuando especifique domainJoinCredential, establezca su @odata.type en #microsoft.graph.cloudPcPlainTextDomainJoinCredential o #microsoft.graph.cloudPcKeyVaultDomainJoinCredential. Si domainJoinCredential y adDomainPassword se proporcionan, domainJoinCredential tiene prioridad.

Para rotar la credencial de unión a dominio en una conexión correcta, use updateAdDomainPassword.

Propiedad Tipo Description
adDomainName Cadena El nombre de dominio completo (FQDN) del dominio de Active Directory al que desea unirse.
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.
domainJoinCredential cloudPcDomainJoinCredential Credencial de unión al dominio de Active Directory. Opcional. Si se proporciona, incluya todas las propiedades necesarias del tipo de credencial seleccionado.
organizationalUnit Cadena La unidad organizativa (OU) en la que se crea la cuenta informática.
resourceGroupId Cadena Id. del grupo de recursos de destino. Formato requerido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}.
subnetId Cadena Id. de la subred de destino. Formato requerido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
subscriptionId Cadena El identificador de la suscripción de Azure de destino asociada a su espacio empresarial.
virtualNetworkId Cadena Id. de la red virtual de destino. Formato requerido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}.
adDomainPassword (obsoleto) Cadena La contraseña asociada a adDomainUsername. 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@contoso.com. Esta propiedad está en desuso y se quitará el 31 de diciembre de 2026. En el futuro, use la propiedad domainJoinCredential/domainUserPrincipalName 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 200 OK código de respuesta y un objeto cloudPcOnPremisesConnection actualizado en el cuerpo de la respuesta.

Ejemplos

Ejemplo 1: Actualizar las propiedades de conexión mediante adDomainPassword y adDomainUsername

El siguiente ejemplo muestra cómo actualizar las propiedades de conexión mediante adDomainPassword y adDomainUsername. Para los cambios de credenciales en el futuro, use domainJoinCredential como se muestra en los ejemplos siguientes.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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"
}

Ejemplo 2: Usar una contraseña almacenada en Azure Key Vault

En el ejemplo siguiente se muestra cómo actualizar las credenciales de unión a dominio para que hagan referencia a un secreto Azure Key Vault.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
      }
    }
  }
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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"
}

Ejemplo 3: Actualizar una credencial de texto sin formato

En el ejemplo siguiente se proporciona el nombre principal de usuario y la contraseña para unirse a un dominio mediante domainJoinCredential.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
  }
}

Respuesta

En el ejemplo siguiente se muestra la respuesta. No se devuelve la propiedad domainPassword .

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"
}