cloudPcOnPremisesConnection を作成する
[アーティクル]
04/22/2024
3 人の共同作成者
フィードバック
この記事の内容
名前空間: microsoft.graph
クラウド PC をプロビジョニングするための新しい cloudPcOnPremisesConnection オブジェクトを作成します。
重要
オンプレミスのネットワーク接続 の名前が Azure ネットワーク接続 として変更されました。 cloudPcOnPremisesConnection オブジェクトは、クラウド PC 製品の Azure ネットワーク接続 と同じです。
この API は、次の国内クラウド展開 で使用できます。
グローバル サービス
米国政府機関 L4
米国政府機関 L5 (DOD)
21Vianet が運営する中国
✅
❌
❌
❌
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ 、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類 」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください 。
アクセス許可の種類
最小特権アクセス許可
特権の高いアクセス許可
委任 (職場または学校のアカウント)
CloudPC.ReadWrite.All
注意事項なし。
委任 (個人用 Microsoft アカウント)
サポートされていません。
サポートされていません。
アプリケーション
サポートされていません。
サポートされていません。
HTTP 要求
POST /deviceManagement/virtualEndpoint/onPremisesConnections
名前
説明
Authorization
ベアラー {token}。 必須です。
Content-Type
application/json. 必須です。
要求本文
要求本文で、 cloudPcOnPremisesConnection オブジェクトの JSON 表現を指定します。
次の表に、 cloudPcOnPremisesConnection オブジェクトを作成するときに必要なプロパティを示します。
プロパティ
型
説明
adDomainName
String
参加する Active Directory ドメインの完全修飾ドメイン名 (FQDN)。
adDomainPassword
String
adDomainUsername に関連付けられているパスワード。
adDomainUsername
String
Active Directory でコンピューター オブジェクトを作成するためのアクセス許可を持つ Active Directory アカウント (ユーザーまたはサービス アカウント) のユーザー名。 必須の形式: admin@contoso.com。
connectionType
cloudPcOnPremisesConnectionType
プロビジョニングされたクラウド PC をMicrosoft Entra IDに参加させる方法を指定します。 既定値は hybridAzureADJoin
です。 可能な値は azureADJoin
、hybridAzureADJoin
、unknownFutureValue
です。
displayName
String
Azure ネットワーク接続の表示名。
resourceGroupId
String
ターゲット リソース グループの ID。 必須の形式: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}"
subnetId
String
ターゲット サブネットの ID。 必須の形式: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}"
subscriptionId
String
テナントに関連付けられているターゲット Azure サブスクリプションの ID。
virtualNetworkId
String
ターゲット仮想ネットワークの ID。 必須の形式: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}"
応答
成功した場合、このメソッドは応答コードと、応答本文に cloudPcOnPremisesConnection オブジェクトを返201 Created
します。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections
Content-Type: application/json
{
"displayName": "test-canary-02",
"connectionType": "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.Models;
var requestBody = new CloudPcOnPremisesConnection
{
DisplayName = "test-canary-02",
ConnectionType = 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);
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
mgc device-management virtual-endpoint on-premises-connections create --body '{\
"displayName": "test-canary-02",\
"connectionType": "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"\
}\
'
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewCloudPcOnPremisesConnection()
displayName := "test-canary-02"
requestBody.SetDisplayName(&displayName)
connectionType := graphmodels.HYBRIDAZUREADJOIN_CLOUDPCONPREMISESCONNECTIONTYPE
requestBody.SetConnectionType(&connectionType)
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)
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// 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.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);
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const cloudPcOnPremisesConnection = {
displayName: 'test-canary-02',
connectionType: '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')
.post(cloudPcOnPremisesConnection);
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\CloudPcOnPremisesConnection;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CloudPcOnPremisesConnection();
$requestBody->setDisplayName('test-canary-02');
$requestBody->setConnectionType(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();
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
Import-Module Microsoft.Graph.DeviceManagement.Administration
$params = @{
displayName = "test-canary-02"
connectionType = "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-MgDeviceManagementVirtualEndpointOnPremiseConnection -BodyParameter $params
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
from msgraph import GraphServiceClient
from msgraph.generated.models.cloud_pc_on_premises_connection import CloudPcOnPremisesConnection
graph_client = GraphServiceClient(credentials, scopes)
request_body = CloudPcOnPremisesConnection(
display_name = "test-canary-02",
connection_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)
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
応答
次の例は応答を示しています。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"id": "ac2ad805-167e-49ee-9bef-196c4ce7ffff",
"displayName": "test-canary-02",
"connectionType": "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"
}