名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
cloudPcExportJob オブジェクトのプロパティとリレーションシップを読み取ります。
レポートをダウンロードするには、最初に 新しい cloudPcExportJob リソースを作成 してダウンロードを開始します。
この GET 操作を使用して、cloudPcExportJob リソースの exportJobStatus プロパティを確認します。 プロパティは、completed
exportUrl プロパティで指定された場所でのレポートのダウンロードが完了するとになります。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
✅ |
✅ |
✅ |
❌ |
アクセス許可
この API を使用してレポートをダウンロードするには、最小特権のアクセス許可またはアクセス許可を選択します。 委任されたアクセスには、エクスポートする必要があるレポートへの読み取りアクセスが必要です。 CloudPC.ReadWrite.All のアプリ専用トークンには、特定のアクセス許可なしですべてのレポートをダウンロードするためのアクセス許可またはアクセス許可があります。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
アクセス許可の種類 |
最小特権アクセス許可 |
特権の高いアクセス許可 |
委任 (職場または学校のアカウント) |
CloudPC.ReadWrite.All |
注意事項なし。 |
委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
アプリケーション |
CloudPC.ReadWrite.All |
注意事項なし。 |
Cloud PC 管理ポータルの 次のアクセス許可は、特定の種類のレポートへのアクセスを提供します。
- ActionStatus/Read
- DeviceRecommendation/Read
- CrossRegionDisasterRecovery/Read
- FrontlineReports/Read
- InaccessibleReports/Read
- PerformanceReports/Read
HTTP 要求
GET /deviceManagement/virtualEndpoint/reports/exportJobs/{cloudPcExportJobId}
省略可能なクエリ パラメーター
また、このメソッドは応答をカスタマイズするための一部の OData クエリ パラメーターをサポートします。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
名前 |
説明 |
Authorization |
ベアラー {token}。 必須です。
認証と承認の詳細については、こちらをご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文に cloudPcExportJob オブジェクトを返します。
例
例 1: TotalAggregatedRemoteConnectionReports レポートのエクスポート ジョブを取得する
次の例は、レポートの POST 要求によって作成されたエクスポート ジョブを取得する方法を TotalAggregatedRemoteConnectionReports
示しています。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/exportJobs/TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff
// Code snippets are only available for the latest version. Current version is 5.x
// 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.Reports.ExportJobs["{cloudPcExportJob-id}"].GetAsync();
mgc-beta device-management virtual-endpoint reports export-jobs get --cloud-pc-export-job-id {cloudPcExportJob-id}
// 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"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
exportJobs, err := graphClient.DeviceManagement().VirtualEndpoint().Reports().ExportJobs().ByCloudPcExportJobId("cloudPcExportJob-id").Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPcExportJob result = graphClient.deviceManagement().virtualEndpoint().reports().exportJobs().byCloudPcExportJobId("{cloudPcExportJob-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let cloudPcExportJob = await client.api('/deviceManagement/virtualEndpoint/reports/exportJobs/TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->exportJobs()->byCloudPcExportJobId('cloudPcExportJob-id')->get()->wait();
Import-Module Microsoft.Graph.Beta.DeviceManagement.Administration
Get-MgBetaDeviceManagementVirtualEndpointReportExportJob -CloudPcExportJobId $cloudPcExportJobId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.device_management.virtual_endpoint.reports.export_jobs.by_cloud_pc_export_job_id('cloudPcExportJob-id').get()
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"@odata.type": "#microsoft.graph.cloudPcExportJob",
"id": "TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff",
"reportName": "totalAggregatedRemoteConnectionReports",
"format": "csv",
"select": ["CloudPcId", "ManagedDeviceName", "UserPrincipalName", "DaysSinceLastSignIn", "TotalUsageInHour"],
"filter": null,
"requestDateTime": "2022-09-16T12:00:06.5137388Z",
"expirationDateTime": "0001-01-01T00:00:00Z",
"exportJobStatus": "completed",
"exportUrl": "https://westus01repexpstorage.blob.core.windows.net/599fe3a3-0285-4e7f-9c83-ffdf37914e27/remoteConnectionEvents_af34378a-cf5a-418d-b735-54b0ee155118.zip"
}
}
例 2: RemoteConnectionQualityReports レポートのエクスポート ジョブを取得する
次の例は、レポートの POST 要求によって作成されたエクスポート ジョブを取得する方法を RemoteConnectionQualityReports
示しています。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/exportJobs/RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330
// Code snippets are only available for the latest version. Current version is 5.x
// 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.Reports.ExportJobs["{cloudPcExportJob-id}"].GetAsync();
mgc-beta device-management virtual-endpoint reports export-jobs get --cloud-pc-export-job-id {cloudPcExportJob-id}
// 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"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
exportJobs, err := graphClient.DeviceManagement().VirtualEndpoint().Reports().ExportJobs().ByCloudPcExportJobId("cloudPcExportJob-id").Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPcExportJob result = graphClient.deviceManagement().virtualEndpoint().reports().exportJobs().byCloudPcExportJobId("{cloudPcExportJob-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let cloudPcExportJob = await client.api('/deviceManagement/virtualEndpoint/reports/exportJobs/RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->exportJobs()->byCloudPcExportJobId('cloudPcExportJob-id')->get()->wait();
Import-Module Microsoft.Graph.Beta.DeviceManagement.Administration
Get-MgBetaDeviceManagementVirtualEndpointReportExportJob -CloudPcExportJobId $cloudPcExportJobId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.device_management.virtual_endpoint.reports.export_jobs.by_cloud_pc_export_job_id('cloudPcExportJob-id').get()
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"@odata.type": "#microsoft.graph.cloudPcExportJob",
"id": "RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330",
"reportName": "remoteConnectionQualityReports",
"format": "csv",
"select": ["CloudPcId", "ManagedDeviceName", "UserPrincipalName", "DaysSinceLastSignIn", "TotalUsageInHour"],
"filter": null,
"requestDateTime": "2023-06-14T07:40:41.694Z",
"expirationDateTime": "",
"exportJobStatus": "completed",
"exportUrl": "https://westus01repexpstorage.blob.core.windows.net/599fe3a3-0285-4e7f-9c83-ffdf37914e27/remoteConnectionHistoricalReports_af34378a-cf5a-418d-b735-54b0ee155118.zip"
}
}