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 表現を指定します。

次の表は、更新できるプロパティの一覧です。 変更するプロパティのみを指定します。省略されたプロパティは、現在の値を保持します。

domainJoinCredential を指定する場合は、その @odata.type を #microsoft.graph.cloudPcPlainTextDomainJoinCredential または #microsoft.graph.cloudPcKeyVaultDomainJoinCredential に設定します。 domainJoinCredential と adDomainPassword の両方が指定されている場合、domainJoinCredential が優先されます。

正常な接続でドメイン参加資格情報をローテーションするには、 updateAdDomainPassword を使用します。

プロパティ 型 説明
adDomainName 文字列 参加する Active Directory ドメインの完全修飾ドメイン名 (FQDN)。
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 文字列 Azure ネットワーク接続の表示名。
domainJoinCredential cloudPcDomainJoinCredential Active Directory ドメイン参加資格情報。 省略可能。 指定した場合は、選択した資格情報の種類のすべての必須プロパティを含めます。
organizationalUnit 文字列 コンピューター アカウントが作成されている組織単位 (OU)。
resourceGroupId 文字列 ターゲット リソース グループの ID。 必要な形式: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}。
subnetId 文字列 ターゲット サブネットの ID。 必要な形式: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。
subscriptionId 文字列 テナントに関連付けられているターゲット Azure サブスクリプションの ID。
virtualNetworkId 文字列 対象の仮想ネットワークの ID。 必要な形式: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}。
adDomainPassword (非推奨) 文字列 adDomainUsername に関連付けられているパスワード。 このプロパティは非推奨であり、2026 年 12 月 31 日に削除されます。 今後は、 代わりに domainJoinCredential プロパティを使用します。
adDomainUsername (非推奨) 文字列 Active Directory でコンピューター オブジェクトを作成するアクセス許可を持つ Active Directory アカウントの UPN ( dcadmin@contoso.com など)。 このプロパティは非推奨であり、2026 年 12 月 31 日に削除されます。 今後は、 代わりに domainJoinCredential/domainUserPrincipalName プロパティを使用します。
種類 (非推奨) cloudPcOnPremisesConnectionType プロビジョニングされたクラウド PC を Microsoft Entra ID に参加させる方法を指定します。 既定値は hybridAzureADJoin です。 使用可能な値: hybridAzureADJoin、azureADJoin、unknownFutureValue。 type プロパティは非推奨となり、2024 年 1 月 31 日にデータの返しを停止しました。 代わりに connectionType を使用してください。

応答

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

例

例 1:adDomainPassword と adDomainUsername を使用して接続プロパティを更新する

次の例は、 adDomainPassword と adDomainUsername を使用して接続プロパティを更新する方法を示しています。 今後資格情報を変更するには、次の例に示すように domainJoinCredential を使用します。

要求

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

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

例 2:Azure Key Vault に保存されているパスワードを使用する

次の例は、Azure Key Vault シークレットを参照するようにドメイン参加資格情報を更新する方法を示しています。

要求

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

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

応答

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

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

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

例 3: プレーンテキストの資格情報を更新する

次の例では、 domainJoinCredential を使用してドメイン参加のユーザー プリンシパル名とパスワードを提供します。

要求

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

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

応答

次の例は応答を示しています。 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"
}