Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Crie um novo objeto cloudPcOnPremisesConnection para provisionar PCs na nuvem.
Importante
A conexão de rede local foi renomeada como conexão de rede do Azure. Os objetos cloudPcOnPremisesConnection aqui são equivalentes à conexão de rede do Azure para o produto Cloud PC.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global | Governo dos EUA L4 | US Government L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ❌ | ❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão | Permissões menos privilegiadas | Permissões com privilégios mais elevados |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | CloudPC.ReadWrite.All | Indisponível. |
| Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
| Aplicativo | Sem suporte. | Sem suporte. |
Solicitação HTTP
POST /deviceManagement/virtualEndpoint/onPremisesConnections
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type | application/json. Obrigatório. |
Corpo da solicitação
No corpo da solicitação, forneça uma representação JSON do objeto cloudPcOnPremisesConnection .
A tabela a seguir lista as propriedades que você pode fornecer ao criar o objeto.
Para uma conexão de ingresso do Microsoft Entra híbrida, forneça adDomainName e domainJoinCredential ou as propriedades adDomainUsername e adDomainPassword preteridas. As credenciais de ingresso no domínio não são necessárias para uma conexão de ingresso do Microsoft Entra.
Ao especificar domainJoinCredential, defina seu @odata.type como #microsoft.graph.cloudPcPlainTextDomainJoinCredential ou #microsoft.graph.cloudPcKeyVaultDomainJoinCredential. Se domainJoinCredential e as propriedades de credencial preteridas forem fornecidas, domainJoinCredential terá precedência.
| Propriedade | Tipo | Descrição |
|---|---|---|
| adDomainName | Cadeia de caracteres | O FQDN (nome de domínio totalmente qualificado) do domínio do Active Directory ao qual você deseja ingressar. Necessário para uma conexão híbrida do Microsoft Entra Join. |
| connectionType | cloudPcOnPremisesConnectionType | Especifica o método pelo qual um PC na nuvem provisionado é associado ao Microsoft Entra. A azureADJoin opção indica a ausência de um Active Directory local (AD) no locatário atual, o que faz com que o dispositivo Cloud PC ingresse apenas no Microsoft Entra. A hybridAzureADJoin opção indica a presença de um AD local no locatário atual e que o PC na nuvem ingressa no AD local e no Microsoft Entra. A opção selecionada também determina os tipos de usuários que podem ser atribuídos e podem entrar em um PC na nuvem. A azureADJoin opção permite que usuários somente em nuvem e híbridos sejam atribuídos e entrem, enquanto hybridAzureADJoin é restrita apenas a usuários híbridos. O valor padrão é hybridAzureADJoin. Os valores possíveis são: hybridAzureADJoin, azureADJoin, unknownFutureValue. |
| displayName | Cadeia de caracteres | O nome de exibição da conexão de rede do Azure. Obrigatório. |
| domainJoinCredential | cloudPcDomainJoinCredential | A credencial de ingresso no domínio do Active Directory. Necessário para uma conexão de ingresso do Microsoft Entra híbrida, a menos que as propriedades preteridas adDomainUsername e adDomainPassword sejam fornecidas. |
| organizationalUnit | Cadeia de caracteres | A unidade organizacional (OU) na qual a conta de computador é criada. Se omitido, o contêiner de objeto de computador padrão no domínio do Active Directory será usado. Opcional. |
| resourceGroupId | Cadeia de caracteres | A ID do grupo de recursos de destino. Formato exigido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}. Obrigatório. |
| Id de sub-rede | Cadeia de caracteres | A ID da sub-rede de destino. Formato exigido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Obrigatório. |
| subscriptionId | Cadeia de caracteres | A ID da assinatura do Azure de destino associada ao seu locatário. Obrigatório. |
| virtualNetworkId | Cadeia de caracteres | A ID da rede virtual de destino. Formato exigido: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}. Obrigatório. |
| adDomainPassword (preterido) | Cadeia de caracteres | A senha associada ao adDomainUsername. Necessário com adDomainUsername para uma conexão híbrida de ingresso do Microsoft Entra quando domainJoinCredential não é fornecido. Esta propriedade foi preterida e será removida em 31 de dezembro de 2026. No futuro, use a propriedade domainJoinCredential . |
| adDomainUsername (preterido) | Cadeia de caracteres | O UPN de uma conta do Active Directory que tem permissões para criar objetos de computador no Active Directory, por exemplo, dcadmin@contoso001.com. Necessário com adDomainPassword para uma conexão híbrida de ingresso do Microsoft Entra quando domainJoinCredential não é fornecido. Esta propriedade foi preterida e será removida em 31 de dezembro de 2026. No futuro, use a propriedade domainJoinCredential . |
| Tipo (preterido) | cloudPcOnPremisesConnectionType | Especifica como o PC na nuvem provisionado ingressa no Microsoft Entra ID. O valor padrão é hybridAzureADJoin. Os valores possíveis são: hybridAzureADJoin, azureADJoin, unknownFutureValue. A propriedade type foi preterida e parou de retornar dados em 31 de janeiro de 2024. Em vez disso, use connectionType . |
Resposta
Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto cloudPcOnPremisesConnection no corpo da resposta.
Exemplos
Exemplo 1: Criar uma conexão usando as propriedades adDomainPassword e adDomainUsername
Por motivos de compatibilidade, o exemplo a seguir mostra como criar uma conexão usando as propriedades preteridas. No futuro, use domainJoinCredential conforme mostrado nos exemplos a seguir.
Solicitação
O exemplo a seguir mostra uma solicitação.
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"
}
Resposta
O exemplo a seguir mostra a resposta.
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"
}
Exemplo 2: criar uma conexão com uma senha armazenada no Azure Key Vault
O exemplo a seguir fornece o nome UPN do usuário de ingresso no domínio diretamente e faz referência a um Azure Key Vault segredo para a senha.
Solicitação
O exemplo a seguir mostra uma solicitação.
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"
}
}
}
}
Resposta
O exemplo a seguir mostra a resposta.
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"
}
Exemplo 3: Criar uma conexão com uma credencial de texto sem formatação
O exemplo a seguir fornece o nome principal e a senha do usuário de ingresso no domínio por meio de domainJoinCredential, sem as propriedades de credencial preteridas.
Solicitação
O exemplo a seguir mostra uma solicitação.
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"
}
}
Resposta
O exemplo a seguir mostra a resposta. A propriedade domainPassword não é retornada.
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"
}