名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
現在の プロビジョニング ポリシー の構成を、指定したポリシーの下にあるすべてのクラウド PC デバイスに適用します。
region や singleSignOn などのポリシー設定を適用できます。 このアクションは、 reservePercentage パラメーターを使用してプロセス中に使用可能なクラウド PC の割合を制御することで、現場共有モード クラウド PC の再プロビジョニングもサポートします。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
❌ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
CloudPC.ReadWrite.All |
注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
CloudPC.ReadWrite.All |
注意事項なし。 |
HTTP 要求
POST /deviceManagement/virtualEndpoint/provisioningPolicies/{id}/apply
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、パラメーターの JSON 表現を指定します。
このメソッドで使用できるパラメーターを次の表に示します。
| パラメーター |
型 |
説明 |
| isForceUserLogoffEnabled |
ブール型 |
現場共有 専用 。 再プロビジョニングの開始時に、アクティブなクラウド PC セッションが強制的にサインアウトされるかどうかを示します。
trueすると、接続されたユーザーはすぐにサインアウトされ、再プロビジョニングが直ちに開始されます。このパラメーターが true の場合は、reservePercentage を 0 に設定する必要があります。それ以外の場合は、要求は失敗します。
falseする場合、再プロビジョニングはユーザーが切断するまで待機します。 既定値は false です。 省略可能。 |
| policySettings |
cloudPcPolicySettingType |
適用アクションのターゲット プロパティ。 使用可能な値: region、singleSignOn、unknownFutureValue。 既定値は region です。 このパラメーターがnullの場合、このアクションはregionを値として適用します。 |
| reservePercentage |
Int32 |
現場共有 専用 。 使用可能にしておくクラウド PC の割合。 管理者は、このプロパティを 0 から 99 までの値に設定できます。 クラウド PC は、アクティブな接続されているクラウド PC ユーザーがいない場合にのみ再プロビジョニングされます。 |
応答
成功した場合、このメソッドは 204 No Content 応答コードを返します。
例
例 1: クラウド PC にポリシー設定を適用する
次の例は、指定されたプロビジョニング ポリシーの下にあるすべてのクラウド PC デバイスに region などのポリシー設定を適用する方法を示しています。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply
Content-Type: application/json
{
"policySettings": "region"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.ProvisioningPolicies.Item.Apply;
using Microsoft.Graph.Beta.Models;
var requestBody = new ApplyPostRequestBody
{
PolicySettings = CloudPcPolicySettingType.Region,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.VirtualEndpoint.ProvisioningPolicies["{cloudPcProvisioningPolicy-id}"].Apply.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"
graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphdevicemanagement.NewApplyPostRequestBody()
policySettings := graphmodels.REGION_CLOUDPCPOLICYSETTINGTYPE
requestBody.SetPolicySettings(&policySettings)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().VirtualEndpoint().ProvisioningPolicies().ByCloudPcProvisioningPolicyId("cloudPcProvisioningPolicy-id").Apply().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.ApplyPostRequestBody applyPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.ApplyPostRequestBody();
applyPostRequestBody.setPolicySettings(EnumSet.of(CloudPcPolicySettingType.Region));
graphClient.deviceManagement().virtualEndpoint().provisioningPolicies().byCloudPcProvisioningPolicyId("{cloudPcProvisioningPolicy-id}").apply().post(applyPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const apply = {
policySettings: 'region'
};
await client.api('/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply')
.version('beta')
.post(apply);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\ProvisioningPolicies\Item\Apply\ApplyPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\CloudPcPolicySettingType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ApplyPostRequestBody();
$requestBody->setPolicySettings(new CloudPcPolicySettingType('region'));
$graphServiceClient->deviceManagement()->virtualEndpoint()->provisioningPolicies()->byCloudPcProvisioningPolicyId('cloudPcProvisioningPolicy-id')->apply()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.apply_post_request_body import ApplyPostRequestBody
from msgraph_beta.generated.models.cloud_pc_policy_setting_type import CloudPcPolicySettingType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ApplyPostRequestBody(
policy_settings = CloudPcPolicySettingType.Region,
)
await graph_client.device_management.virtual_endpoint.provisioning_policies.by_cloud_pc_provisioning_policy_id('cloudPcProvisioningPolicy-id').apply.post(request_body)
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content
例 2: 予約割合を使用して現場の共有クラウド PC を再プロビジョニングする
次の例は、指定されたプロビジョニング ポリシーの下で現場の共有クラウド PC を再プロビジョニングし、クラウド PC の 80% を使用可能にしておく方法を示しています。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply
Content-Type: application/json
{
"isForceUserLogoffEnabled": false,
"reservePercentage": 80
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.ProvisioningPolicies.Item.Apply;
var requestBody = new ApplyPostRequestBody
{
IsForceUserLogoffEnabled = false,
ReservePercentage = 80,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.VirtualEndpoint.ProvisioningPolicies["{cloudPcProvisioningPolicy-id}"].Apply.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"
graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
//other-imports
)
requestBody := graphdevicemanagement.NewApplyPostRequestBody()
isForceUserLogoffEnabled := false
requestBody.SetIsForceUserLogoffEnabled(&isForceUserLogoffEnabled)
reservePercentage := int32(80)
requestBody.SetReservePercentage(&reservePercentage)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().VirtualEndpoint().ProvisioningPolicies().ByCloudPcProvisioningPolicyId("cloudPcProvisioningPolicy-id").Apply().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.ApplyPostRequestBody applyPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.ApplyPostRequestBody();
applyPostRequestBody.setIsForceUserLogoffEnabled(false);
applyPostRequestBody.setReservePercentage(80);
graphClient.deviceManagement().virtualEndpoint().provisioningPolicies().byCloudPcProvisioningPolicyId("{cloudPcProvisioningPolicy-id}").apply().post(applyPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const apply = {
isForceUserLogoffEnabled: false,
reservePercentage: 80
};
await client.api('/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply')
.version('beta')
.post(apply);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\ProvisioningPolicies\Item\Apply\ApplyPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ApplyPostRequestBody();
$requestBody->setIsForceUserLogoffEnabled(false);
$requestBody->setReservePercentage(80);
$graphServiceClient->deviceManagement()->virtualEndpoint()->provisioningPolicies()->byCloudPcProvisioningPolicyId('cloudPcProvisioningPolicy-id')->apply()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.apply_post_request_body import ApplyPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ApplyPostRequestBody(
is_force_user_logoff_enabled = False,
reserve_percentage = 80,
)
await graph_client.device_management.virtual_endpoint.provisioning_policies.by_cloud_pc_provisioning_policy_id('cloudPcProvisioningPolicy-id').apply.post(request_body)
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content
例 3: 現場の共有クラウド PC を再プロビジョニングし、ユーザーのサインアウトを強制する
次の例は、アクティブなセッションを強制的にサインアウトすることで、指定されたプロビジョニング ポリシーの下で現場の共有クラウド PC を直ちに再プロビジョニングする方法を示しています。
isForceUserLogoffEnabled がtrueの場合は、reservePercentage を 0 に設定する必要があります。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply
Content-Type: application/json
{
"isForceUserLogoffEnabled": true,
"reservePercentage": 0
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.ProvisioningPolicies.Item.Apply;
var requestBody = new ApplyPostRequestBody
{
IsForceUserLogoffEnabled = true,
ReservePercentage = 0,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.VirtualEndpoint.ProvisioningPolicies["{cloudPcProvisioningPolicy-id}"].Apply.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"
graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
//other-imports
)
requestBody := graphdevicemanagement.NewApplyPostRequestBody()
isForceUserLogoffEnabled := true
requestBody.SetIsForceUserLogoffEnabled(&isForceUserLogoffEnabled)
reservePercentage := int32(0)
requestBody.SetReservePercentage(&reservePercentage)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().VirtualEndpoint().ProvisioningPolicies().ByCloudPcProvisioningPolicyId("cloudPcProvisioningPolicy-id").Apply().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.ApplyPostRequestBody applyPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.ApplyPostRequestBody();
applyPostRequestBody.setIsForceUserLogoffEnabled(true);
applyPostRequestBody.setReservePercentage(0);
graphClient.deviceManagement().virtualEndpoint().provisioningPolicies().byCloudPcProvisioningPolicyId("{cloudPcProvisioningPolicy-id}").apply().post(applyPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const apply = {
isForceUserLogoffEnabled: true,
reservePercentage: 0
};
await client.api('/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply')
.version('beta')
.post(apply);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\ProvisioningPolicies\Item\Apply\ApplyPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ApplyPostRequestBody();
$requestBody->setIsForceUserLogoffEnabled(true);
$requestBody->setReservePercentage(0);
$graphServiceClient->deviceManagement()->virtualEndpoint()->provisioningPolicies()->byCloudPcProvisioningPolicyId('cloudPcProvisioningPolicy-id')->apply()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.devicemanagement.virtualendpoint.provisioningpolicies.item.apply.apply_post_request_body import ApplyPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ApplyPostRequestBody(
is_force_user_logoff_enabled = True,
reserve_percentage = 0,
)
await graph_client.device_management.virtual_endpoint.provisioning_policies.by_cloud_pc_provisioning_policy_id('cloudPcProvisioningPolicy-id').apply.post(request_body)
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content