名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
新しい cloudPcUserSetting オブジェクトを 作成します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
✅ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
CloudPC.ReadWrite.All |
注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
CloudPC.ReadWrite.All |
注意事項なし。 |
HTTP 要求
POST /deviceManagement/virtualEndpoint/userSettings
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、 cloudPcUserSetting オブジェクトの JSON 表現を指定します。
次の表に、 cloudPcUserSetting を作成するときに必要なプロパティを示します。
| プロパティ |
型 |
説明 |
| crossRegionDisasterRecoverySetting |
cloudPcCrossRegionDisasterRecoverySetting |
ユーザーのクラウド PC のリージョン間のディザスター リカバリー設定を示します。 |
| displayName |
文字列 |
UI に表示される設定名。 |
| lastModifiedDateTime |
DateTimeOffset |
設定が変更された最後の日付と時刻。 タイムスタンプの種類は、ISO 8601 形式を使用した日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| localAdminEnabled |
ブール型 |
ローカル管理者オプションを有効にするには、この設定を [ true] に変更します。 |
| provisioningSourceType |
cloudPcProvisioningSourceType |
エンド ユーザー向けに準備されたクラウド PC のプロビジョニング ソースを示します。 使用可能な値: image、snapshot、unknownFutureValue。 既定値は image です。 このプロパティが nullに設定または設定されていない場合、その機能は image に設定するのと同じです。 |
| restorePointSetting |
cloudPcRestorePointSetting |
ユーザーのプロビジョニングされたクラウド PC (既定値は 12 時間) に対して復元ポイントを作成する頻度 (つまり、スナップショットを取得する) と、ユーザーが特定の時点で作成されたバックアップに独自のクラウド PC を復元できるかどうかを定義します。 |
| selfServiceEnabled (非推奨) |
ブール型 |
セルフサービス オプションを有効にするには、この設定を [ true] に変更します。
selfServiceEnabled プロパティは非推奨となり、2023 年 12 月 1 日にデータの返しを停止しました。 |
応答
成功した場合、このメソッドは応答コード 201 Created と、応答本文に cloudPcUserSetting オブジェクトを返します。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/userSettings
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcUserSetting",
"displayName": "Example",
"selfServiceEnabled": false,
"localAdminEnabled": true,
"crossRegionDisasterRecoverySetting": {
"crossRegionDisasterRecoveryEnabled": false,
"maintainCrossRegionRestorePointEnabled": true,
"disasterRecoveryNetworkSetting": {
"regionName": "westus",
"regionGroup": "usEast"
},
"disasterRecoveryType": "premium",
"userInitiatedDisasterRecoveryAllowed": true
},
"provisioningSourceType": "image",
"restorePointSetting": {
"frequencyInHours": 16,
"frequencyType": "sixteenHours",
"userRestoreEnabled": true
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new CloudPcUserSetting
{
OdataType = "#microsoft.graph.cloudPcUserSetting",
DisplayName = "Example",
SelfServiceEnabled = false,
LocalAdminEnabled = true,
CrossRegionDisasterRecoverySetting = new CloudPcCrossRegionDisasterRecoverySetting
{
CrossRegionDisasterRecoveryEnabled = false,
MaintainCrossRegionRestorePointEnabled = true,
DisasterRecoveryNetworkSetting = new CloudPcDisasterRecoveryNetworkSetting
{
AdditionalData = new Dictionary<string, object>
{
{
"regionName" , "westus"
},
{
"regionGroup" , "usEast"
},
},
},
DisasterRecoveryType = CloudPcDisasterRecoveryType.Premium,
UserInitiatedDisasterRecoveryAllowed = true,
},
ProvisioningSourceType = CloudPcProvisioningSourceType.Image,
RestorePointSetting = new CloudPcRestorePointSetting
{
FrequencyInHours = 16,
FrequencyType = CloudPcRestorePointFrequencyType.SixteenHours,
UserRestoreEnabled = true,
},
};
// 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.UserSettings.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.NewCloudPcUserSetting()
displayName := "Example"
requestBody.SetDisplayName(&displayName)
selfServiceEnabled := false
requestBody.SetSelfServiceEnabled(&selfServiceEnabled)
localAdminEnabled := true
requestBody.SetLocalAdminEnabled(&localAdminEnabled)
crossRegionDisasterRecoverySetting := graphmodels.NewCloudPcCrossRegionDisasterRecoverySetting()
crossRegionDisasterRecoveryEnabled := false
crossRegionDisasterRecoverySetting.SetCrossRegionDisasterRecoveryEnabled(&crossRegionDisasterRecoveryEnabled)
maintainCrossRegionRestorePointEnabled := true
crossRegionDisasterRecoverySetting.SetMaintainCrossRegionRestorePointEnabled(&maintainCrossRegionRestorePointEnabled)
disasterRecoveryNetworkSetting := graphmodels.NewCloudPcDisasterRecoveryNetworkSetting()
additionalData := map[string]interface{}{
"regionName" : "westus",
"regionGroup" : "usEast",
}
disasterRecoveryNetworkSetting.SetAdditionalData(additionalData)
crossRegionDisasterRecoverySetting.SetDisasterRecoveryNetworkSetting(disasterRecoveryNetworkSetting)
disasterRecoveryType := graphmodels.PREMIUM_CLOUDPCDISASTERRECOVERYTYPE
crossRegionDisasterRecoverySetting.SetDisasterRecoveryType(&disasterRecoveryType)
userInitiatedDisasterRecoveryAllowed := true
crossRegionDisasterRecoverySetting.SetUserInitiatedDisasterRecoveryAllowed(&userInitiatedDisasterRecoveryAllowed)
requestBody.SetCrossRegionDisasterRecoverySetting(crossRegionDisasterRecoverySetting)
provisioningSourceType := graphmodels.IMAGE_CLOUDPCPROVISIONINGSOURCETYPE
requestBody.SetProvisioningSourceType(&provisioningSourceType)
restorePointSetting := graphmodels.NewCloudPcRestorePointSetting()
frequencyInHours := int32(16)
restorePointSetting.SetFrequencyInHours(&frequencyInHours)
frequencyType := graphmodels.SIXTEENHOURS_CLOUDPCRESTOREPOINTFREQUENCYTYPE
restorePointSetting.SetFrequencyType(&frequencyType)
userRestoreEnabled := true
restorePointSetting.SetUserRestoreEnabled(&userRestoreEnabled)
requestBody.SetRestorePointSetting(restorePointSetting)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
userSettings, err := graphClient.DeviceManagement().VirtualEndpoint().UserSettings().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPcUserSetting cloudPcUserSetting = new CloudPcUserSetting();
cloudPcUserSetting.setOdataType("#microsoft.graph.cloudPcUserSetting");
cloudPcUserSetting.setDisplayName("Example");
cloudPcUserSetting.setSelfServiceEnabled(false);
cloudPcUserSetting.setLocalAdminEnabled(true);
CloudPcCrossRegionDisasterRecoverySetting crossRegionDisasterRecoverySetting = new CloudPcCrossRegionDisasterRecoverySetting();
crossRegionDisasterRecoverySetting.setCrossRegionDisasterRecoveryEnabled(false);
crossRegionDisasterRecoverySetting.setMaintainCrossRegionRestorePointEnabled(true);
CloudPcDisasterRecoveryNetworkSetting disasterRecoveryNetworkSetting = new CloudPcDisasterRecoveryNetworkSetting();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("regionName", "westus");
additionalData.put("regionGroup", "usEast");
disasterRecoveryNetworkSetting.setAdditionalData(additionalData);
crossRegionDisasterRecoverySetting.setDisasterRecoveryNetworkSetting(disasterRecoveryNetworkSetting);
crossRegionDisasterRecoverySetting.setDisasterRecoveryType(CloudPcDisasterRecoveryType.Premium);
crossRegionDisasterRecoverySetting.setUserInitiatedDisasterRecoveryAllowed(true);
cloudPcUserSetting.setCrossRegionDisasterRecoverySetting(crossRegionDisasterRecoverySetting);
cloudPcUserSetting.setProvisioningSourceType(CloudPcProvisioningSourceType.Image);
CloudPcRestorePointSetting restorePointSetting = new CloudPcRestorePointSetting();
restorePointSetting.setFrequencyInHours(16);
restorePointSetting.setFrequencyType(CloudPcRestorePointFrequencyType.SixteenHours);
restorePointSetting.setUserRestoreEnabled(true);
cloudPcUserSetting.setRestorePointSetting(restorePointSetting);
CloudPcUserSetting result = graphClient.deviceManagement().virtualEndpoint().userSettings().post(cloudPcUserSetting);
const options = {
authProvider,
};
const client = Client.init(options);
const cloudPcUserSetting = {
'@odata.type': '#microsoft.graph.cloudPcUserSetting',
displayName: 'Example',
selfServiceEnabled: false,
localAdminEnabled: true,
crossRegionDisasterRecoverySetting: {
crossRegionDisasterRecoveryEnabled: false,
maintainCrossRegionRestorePointEnabled: true,
disasterRecoveryNetworkSetting: {
regionName: 'westus',
regionGroup: 'usEast'
},
disasterRecoveryType: 'premium',
userInitiatedDisasterRecoveryAllowed: true
},
provisioningSourceType: 'image',
restorePointSetting: {
frequencyInHours: 16,
frequencyType: 'sixteenHours',
userRestoreEnabled: true
}
};
await client.api('/deviceManagement/virtualEndpoint/userSettings')
.version('beta')
.post(cloudPcUserSetting);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CloudPcUserSetting;
use Microsoft\Graph\Beta\Generated\Models\CloudPcCrossRegionDisasterRecoverySetting;
use Microsoft\Graph\Beta\Generated\Models\CloudPcDisasterRecoveryNetworkSetting;
use Microsoft\Graph\Beta\Generated\Models\CloudPcDisasterRecoveryType;
use Microsoft\Graph\Beta\Generated\Models\CloudPcProvisioningSourceType;
use Microsoft\Graph\Beta\Generated\Models\CloudPcRestorePointSetting;
use Microsoft\Graph\Beta\Generated\Models\CloudPcRestorePointFrequencyType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CloudPcUserSetting();
$requestBody->setOdataType('#microsoft.graph.cloudPcUserSetting');
$requestBody->setDisplayName('Example');
$requestBody->setSelfServiceEnabled(false);
$requestBody->setLocalAdminEnabled(true);
$crossRegionDisasterRecoverySetting = new CloudPcCrossRegionDisasterRecoverySetting();
$crossRegionDisasterRecoverySetting->setCrossRegionDisasterRecoveryEnabled(false);
$crossRegionDisasterRecoverySetting->setMaintainCrossRegionRestorePointEnabled(true);
$crossRegionDisasterRecoverySettingDisasterRecoveryNetworkSetting = new CloudPcDisasterRecoveryNetworkSetting();
$additionalData = [
'regionName' => 'westus',
'regionGroup' => 'usEast',
];
$crossRegionDisasterRecoverySettingDisasterRecoveryNetworkSetting->setAdditionalData($additionalData);
$crossRegionDisasterRecoverySetting->setDisasterRecoveryNetworkSetting($crossRegionDisasterRecoverySettingDisasterRecoveryNetworkSetting);
$crossRegionDisasterRecoverySetting->setDisasterRecoveryType(new CloudPcDisasterRecoveryType('premium'));
$crossRegionDisasterRecoverySetting->setUserInitiatedDisasterRecoveryAllowed(true);
$requestBody->setCrossRegionDisasterRecoverySetting($crossRegionDisasterRecoverySetting);
$requestBody->setProvisioningSourceType(new CloudPcProvisioningSourceType('image'));
$restorePointSetting = new CloudPcRestorePointSetting();
$restorePointSetting->setFrequencyInHours(16);
$restorePointSetting->setFrequencyType(new CloudPcRestorePointFrequencyType('sixteenHours'));
$restorePointSetting->setUserRestoreEnabled(true);
$requestBody->setRestorePointSetting($restorePointSetting);
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->userSettings()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.DeviceManagement.Administration
$params = @{
"@odata.type" = "#microsoft.graph.cloudPcUserSetting"
displayName = "Example"
selfServiceEnabled = $false
localAdminEnabled = $true
crossRegionDisasterRecoverySetting = @{
crossRegionDisasterRecoveryEnabled = $false
maintainCrossRegionRestorePointEnabled = $true
disasterRecoveryNetworkSetting = @{
regionName = "westus"
regionGroup = "usEast"
}
disasterRecoveryType = "premium"
userInitiatedDisasterRecoveryAllowed = $true
}
provisioningSourceType = "image"
restorePointSetting = @{
frequencyInHours = 16
frequencyType = "sixteenHours"
userRestoreEnabled = $true
}
}
New-MgBetaDeviceManagementVirtualEndpointUserSetting -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_user_setting import CloudPcUserSetting
from msgraph_beta.generated.models.cloud_pc_cross_region_disaster_recovery_setting import CloudPcCrossRegionDisasterRecoverySetting
from msgraph_beta.generated.models.cloud_pc_disaster_recovery_network_setting import CloudPcDisasterRecoveryNetworkSetting
from msgraph_beta.generated.models.cloud_pc_disaster_recovery_type import CloudPcDisasterRecoveryType
from msgraph_beta.generated.models.cloud_pc_provisioning_source_type import CloudPcProvisioningSourceType
from msgraph_beta.generated.models.cloud_pc_restore_point_setting import CloudPcRestorePointSetting
from msgraph_beta.generated.models.cloud_pc_restore_point_frequency_type import CloudPcRestorePointFrequencyType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CloudPcUserSetting(
odata_type = "#microsoft.graph.cloudPcUserSetting",
display_name = "Example",
self_service_enabled = False,
local_admin_enabled = True,
cross_region_disaster_recovery_setting = CloudPcCrossRegionDisasterRecoverySetting(
cross_region_disaster_recovery_enabled = False,
maintain_cross_region_restore_point_enabled = True,
disaster_recovery_network_setting = CloudPcDisasterRecoveryNetworkSetting(
additional_data = {
"region_name" : "westus",
"region_group" : "usEast",
}
),
disaster_recovery_type = CloudPcDisasterRecoveryType.Premium,
user_initiated_disaster_recovery_allowed = True,
),
provisioning_source_type = CloudPcProvisioningSourceType.Image,
restore_point_setting = CloudPcRestorePointSetting(
frequency_in_hours = 16,
frequency_type = CloudPcRestorePointFrequencyType.SixteenHours,
user_restore_enabled = True,
),
)
result = await graph_client.device_management.virtual_endpoint.user_settings.post(request_body)
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcUserSetting",
"id": "556092f8-92f8-5560-f892-6055f8926055",
"displayName": "Example",
"selfServiceEnabled": false,
"localAdminEnabled": true,
"crossRegionDisasterRecoverySetting": {
"crossRegionDisasterRecoveryEnabled": false,
"maintainCrossRegionRestorePointEnabled": true,
"disasterRecoveryNetworkSetting": {
"regionName": "westus",
"regionGroup": "usEast"
},
"disasterRecoveryType": "premium",
"userInitiatedDisasterRecoveryAllowed": true
},
"restorePointSetting": {
"frequencyInHours": 16,
"frequencyType": "sixteenHours",
"userRestoreEnabled": true
},
"provisioningSourceType": "image",
"lastModifiedDateTime": "2021-02-01T10:29:57Z"
}