次の方法で共有

cloudPcOnPremisesConnection を更新する

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

cloudPcOnPremisesConnection オブジェクトのプロパティを更新します。

重要

オンプレミスのネットワーク接続 の名前が Azure ネットワーク接続として変更されました。 cloudPcOnPremisesConnection オブジェクトは、クラウド PC 製品の Azure ネットワーク接続 と同じです。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) CloudPC.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

HTTP 要求

PATCH /deviceManagement/virtualEndpoint/onPremisesConnections/{id}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 cloudPcOnPremisesConnection オブジェクトの JSON 表現を指定します。

次の表に、 cloudPcOnPremisesConnection オブジェクトを作成するときに必要なプロパティを示します。

プロパティ 型 説明
adDomainName String 参加する Active Directory ドメインの完全修飾ドメイン名 (FQDN)。
adDomainPassword String adDomainUsername に関連付けられているパスワード。
adDomainUsername String Active Directory でコンピューター オブジェクトを作成するためのアクセス許可を持つ Active Directory アカウント (ユーザーまたはサービス アカウント) のユーザー名。 必須の形式: username@contoso.com。
connectionType cloudPcOnPremisesConnectionType プロビジョニングされたクラウド PC をMicrosoft Entraに参加させる方法を指定します。 オプションはazureADJoin、現在のテナントにオンプレミスの Active Directory (AD) が存在しないことを示します。その結果、クラウド PC デバイスはMicrosoft Entraにのみ参加します。 オプションはhybridAzureADJoin、現在のテナントにオンプレミス AD が存在し、クラウド PC がオンプレミス AD とMicrosoft Entraの両方に参加していることを示します。 選択したオプションは、割り当て可能なユーザーの種類と、クラウド PC にサインインできるユーザーの種類も決定します。 オプション azureADJoin を使用すると、クラウド専用ユーザーとハイブリッド ユーザーの両方を割り当ててサインインできますが、 hybridAzureADJoin ハイブリッド ユーザーのみに制限されます。 既定値は hybridAzureADJoin です。 使用可能な値: hybridAzureADJoin、azureADJoin、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}"
type (非推奨) cloudPcOnPremisesConnectionType プロビジョニングされたクラウド PC がMicrosoft Entra IDに参加する方法を指定します。 既定値は hybridAzureADJoin です。 可能な値は hybridAzureADJoin、azureADJoin、unknownFutureValue です。 type プロパティは非推奨であり、2024 年 1 月 31 日にデータの返しを停止しました。 Goind forward では、 connectionType プロパティを使用します。
subscriptionId String テナントに関連付けられているターゲット Azure サブスクリプションの ID。
type cloudPcOnPremisesConnectionType プロビジョニングされたクラウド PC がMicrosoft Entra IDに参加する方法を指定します。 既定値は hybridAzureADJoin です。 可能な値は azureADJoin、hybridAzureADJoin、unknownFutureValue です。
virtualNetworkId String ターゲット仮想ネットワークの ID。 必須の形式: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}"

応答

成功した場合、このメソッドは応答コードと、応答本文で更新された cloudPcOnPremisesConnection オブジェクトを返200 OKします。

例

要求

次の例は要求を示しています。

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

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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