Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Создайте объект cloudPcOnPremisesConnection для подготовки облачных компьютеров.
Важно!
Локальное сетевое подключение было переименовано в Azure сетевое подключение. Объекты cloudPcOnPremisesConnection здесь эквивалентны Azure сетевому подключению для облачного компьютера.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба |
Правительство США L4 |
Правительство США L5 (DOD) |
Китай управляется 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения |
Разрешения с наименьшими привилегиями |
Более высокие привилегированные разрешения |
| Делегированные (рабочая или учебная учетная запись) |
CloudPC.ReadWrite.All |
Недоступно. |
| Делегированные (личная учетная запись Майкрософт) |
Не поддерживается. |
Не поддерживается. |
| Для приложений |
Не поддерживается. |
Не поддерживается. |
HTTP-запрос
POST /deviceManagement/virtualEndpoint/onPremisesConnections
Текст запроса
В тексте запроса укажите представление объекта cloudPcOnPremisesConnection в формате JSON.
В следующей таблице перечислены свойства, необходимые при создании объекта cloudPcOnPremisesConnection .
| Свойство |
Тип |
Описание |
| displayName |
String |
Отображаемое имя сетевого подключения Azure. |
| connectionType |
cloudPcOnPremisesConnectionType |
Указывает метод, с помощью которого подготовленный облачный компьютер присоединяется к Microsoft Entra. Параметр azureADJoin указывает на отсутствие локальная служба Active Directory (AD) в текущем клиенте, что приводит к присоединению устройства облачного компьютера только к Microsoft Entra. Параметр hybridAzureADJoin указывает на наличие локальной службы AD в текущем клиенте и на то, что облачный компьютер присоединяется как к локальному AD, так и к Microsoft Entra. Выбранный параметр также определяет типы пользователей, которые могут быть назначены и могут входить в облачный компьютер. Этот azureADJoin параметр позволяет назначать и выполнять вход только облачным и гибридным пользователям, тогда как он ограничен только гибридными hybridAzureADJoin пользователями. Значение по умолчанию — hybridAzureADJoin. Допустимые значения: hybridAzureADJoin, azureADJoin, unknownFutureValue. |
| subscriptionId |
String |
Идентификатор целевой Azure подписки, связанной с вашим клиентом. |
| adDomainName |
String |
Полное доменное имя домена Active Directory, к которому вы хотите присоединиться. |
| adDomainPassword |
String |
Пароль, связанный с adDomainUsername. |
| adDomainUsername |
String |
Имя пользователя учетной записи Active Directory (пользователя или учетной записи службы), которая имеет разрешения на создание объектов-компьютеров в Active Directory. Обязательный формат: admin@contoso.com. |
| displayName |
String |
Отображаемое имя сетевого подключения Azure. |
| resourceGroupId |
String |
Идентификатор целевой группы ресурсов. Обязательный формат: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}". |
| subnetId |
String |
Идентификатор целевой подсети. Обязательный формат: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}". |
| type (не рекомендуется) |
cloudPcOnPremisesConnectionType |
Указывает, как подготовленный облачный компьютер присоединяется к Microsoft Entra ID. Значение по умолчанию — hybridAzureADJoin. Допустимые значения: hybridAzureADJoin, azureADJoin, unknownFutureValue. Свойство type устарело и не возвращает данные 31 января 2024 г. Перейдите вперед, используйте свойство connectionType . |
| subscriptionId |
String |
Идентификатор целевой Azure подписки, связанной с вашим клиентом. |
| virtualNetworkId |
String |
Идентификатор целевой виртуальной сети. Обязательный формат: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}". |
| type |
cloudPcOnPremisesConnectionType |
Указывает, как подготовленный облачный компьютер присоединяется к Microsoft Entra ID. Значение по умолчанию — hybridAzureADJoin. Допустимые значения: azureADJoin, hybridAzureADJoin, unknownFutureValue. |
Отклик
В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект cloudPcOnPremisesConnection в теле отклика.
Примеры
Запрос
Ниже показан пример запроса.
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",
"adDomainUsername": "dcadmin",
"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"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new CloudPcOnPremisesConnection
{
DisplayName = "test-canary-02",
ConnectionType = CloudPcOnPremisesConnectionType.HybridAzureADJoin,
Type = CloudPcOnPremisesConnectionType.HybridAzureADJoin,
SubscriptionId = "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
AdDomainName = "contoso001.com",
AdDomainUsername = "dcadmin",
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",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.VirtualEndpoint.OnPremisesConnections.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewCloudPcOnPremisesConnection()
displayName := "test-canary-02"
requestBody.SetDisplayName(&displayName)
connectionType := graphmodels.HYBRIDAZUREADJOIN_CLOUDPCONPREMISESCONNECTIONTYPE
requestBody.SetConnectionType(&connectionType)
type := graphmodels.HYBRIDAZUREADJOIN_CLOUDPCONPREMISESCONNECTIONTYPE
requestBody.SetType(&type)
subscriptionId := "0ac520ee-14c0-480f-b6c9-0a90c585ffff"
requestBody.SetSubscriptionId(&subscriptionId)
adDomainName := "contoso001.com"
requestBody.SetAdDomainName(&adDomainName)
adDomainUsername := "dcadmin"
requestBody.SetAdDomainUsername(&adDomainUsername)
organizationalUnit := "OU=Domain Controllers, DC=contoso001, DC=com"
requestBody.SetOrganizationalUnit(&organizationalUnit)
resourceGroupId := "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG"
requestBody.SetResourceGroupId(&resourceGroupId)
virtualNetworkId := "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET"
requestBody.SetVirtualNetworkId(&virtualNetworkId)
subnetId := "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet"
requestBody.SetSubnetId(&subnetId)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
onPremisesConnections, err := graphClient.DeviceManagement().VirtualEndpoint().OnPremisesConnections().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPcOnPremisesConnection cloudPcOnPremisesConnection = new CloudPcOnPremisesConnection();
cloudPcOnPremisesConnection.setDisplayName("test-canary-02");
cloudPcOnPremisesConnection.setConnectionType(CloudPcOnPremisesConnectionType.HybridAzureADJoin);
cloudPcOnPremisesConnection.setType(CloudPcOnPremisesConnectionType.HybridAzureADJoin);
cloudPcOnPremisesConnection.setSubscriptionId("0ac520ee-14c0-480f-b6c9-0a90c585ffff");
cloudPcOnPremisesConnection.setAdDomainName("contoso001.com");
cloudPcOnPremisesConnection.setAdDomainUsername("dcadmin");
cloudPcOnPremisesConnection.setOrganizationalUnit("OU=Domain Controllers, DC=contoso001, DC=com");
cloudPcOnPremisesConnection.setResourceGroupId("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG");
cloudPcOnPremisesConnection.setVirtualNetworkId("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET");
cloudPcOnPremisesConnection.setSubnetId("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet");
CloudPcOnPremisesConnection result = graphClient.deviceManagement().virtualEndpoint().onPremisesConnections().post(cloudPcOnPremisesConnection);
const options = {
authProvider,
};
const client = Client.init(options);
const cloudPcOnPremisesConnection = {
displayName: 'test-canary-02',
connectionType: 'hybridAzureADJoin',
type: 'hybridAzureADJoin',
subscriptionId: '0ac520ee-14c0-480f-b6c9-0a90c585ffff',
adDomainName: 'contoso001.com',
adDomainUsername: 'dcadmin',
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'
};
await client.api('/deviceManagement/virtualEndpoint/onPremisesConnections')
.version('beta')
.post(cloudPcOnPremisesConnection);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CloudPcOnPremisesConnection;
use Microsoft\Graph\Beta\Generated\Models\CloudPcOnPremisesConnectionType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CloudPcOnPremisesConnection();
$requestBody->setDisplayName('test-canary-02');
$requestBody->setConnectionType(new CloudPcOnPremisesConnectionType('hybridAzureADJoin'));
$requestBody->setType(new CloudPcOnPremisesConnectionType('hybridAzureADJoin'));
$requestBody->setSubscriptionId('0ac520ee-14c0-480f-b6c9-0a90c585ffff');
$requestBody->setAdDomainName('contoso001.com');
$requestBody->setAdDomainUsername('dcadmin');
$requestBody->setOrganizationalUnit('OU=Domain Controllers, DC=contoso001, DC=com');
$requestBody->setResourceGroupId('/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG');
$requestBody->setVirtualNetworkId('/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET');
$requestBody->setSubnetId('/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet');
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->onPremisesConnections()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.DeviceManagement.Administration
$params = @{
displayName = "test-canary-02"
connectionType = "hybridAzureADJoin"
type = "hybridAzureADJoin"
subscriptionId = "0ac520ee-14c0-480f-b6c9-0a90c585ffff"
adDomainName = "contoso001.com"
adDomainUsername = "dcadmin"
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"
}
New-MgBetaDeviceManagementVirtualEndpointOnPremiseConnection -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.cloud_pc_on_premises_connection import CloudPcOnPremisesConnection
from msgraph_beta.generated.models.cloud_pc_on_premises_connection_type import CloudPcOnPremisesConnectionType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CloudPcOnPremisesConnection(
display_name = "test-canary-02",
connection_type = CloudPcOnPremisesConnectionType.HybridAzureADJoin,
type = CloudPcOnPremisesConnectionType.HybridAzureADJoin,
subscription_id = "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
ad_domain_name = "contoso001.com",
ad_domain_username = "dcadmin",
organizational_unit = "OU=Domain Controllers, DC=contoso001, DC=com",
resource_group_id = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
virtual_network_id = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
subnet_id = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
)
result = await graph_client.device_management.virtual_endpoint.on_premises_connections.post(request_body)
Отклик
Ниже приводится пример отклика.
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",
"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"
}