cloudPcExportJob を作成する

名前空間: microsoft.graph

重要

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

新しい cloudPcExportJob リソースを作成して、レポートの全体または指定された部分のダウンロードを開始します。

GET cloudPcExportJob 操作を使用して、cloudPcExportJob リソースの exportJobStatus プロパティを確認します。 プロパティの結果が completedされると、 レポートは exportUrl プロパティで指定された場所へのダウンロードを完了します。

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

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

アクセス許可

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

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

HTTP 要求

POST /deviceManagement/virtualEndpoint/reports/exportJobs

要求ヘッダー

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

要求本文

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

cloudPcExportJob を作成するときに、次のプロパティを指定できます。

プロパティ 種類 説明
filter String レポートに適用されたフィルター。 省略可能。
reportName cloudPcReportName レポート名。 使用できる値は、 remoteConnectionHistoricalReportsdailyAggregatedRemoteConnectionReportstotalAggregatedRemoteConnectionReportssharedUseLicenseUsageReportsharedUseLicenseUsageRealTimeReportunknownFutureValuenoLicenseAvailableConnectivityFailureReportfrontlineLicenseUsageReportfrontlineLicenseUsageRealTimeReportremoteConnectionQualityReportsinaccessibleCloudPcReportscrossRegionDisasterRecoveryReportです。 Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型で次の値を取得する必要があります。noLicenseAvailableConnectivityFailureReportfrontlineLicenseUsageReportfrontlineLicenseUsageRealTimeReportremoteConnectionQualityReportsinaccessibleCloudPcReportscrossRegionDisasterRecoveryReport
select String collection レポートの選択した列。 省略可能。

応答

成功した場合、このメソッドは応答コード 201 Created と、応答本文に cloudPcExportJob オブジェクトを返します。

例 1: TotalAggregatedRemoteConnectionReports レポートをダウンロードするエクスポート ジョブを作成する

次の例では、エクスポート ジョブを作成して TotalAggregatedRemoteConnectionReports レポートをダウンロードする方法を示します。

要求

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

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/exportJobs
Content-Type: application/json
Content-length: 315

{
  "reportName": "TotalAggregatedRemoteConnectionReports",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "DaysSinceLastSignIn",
    "TotalUsageInHour"
  ]
}

応答

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/reports/exportJobs/$entity",
  "id": "TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff",
  "reportName": "totalAggregatedRemoteConnectionReports",
  "filter": null,
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "DaysSinceLastSignIn",
    "TotalUsageInHour"
  ],
  "format": null,
  "expirationDateTime": "0001-01-01T00:00:00Z",
  "requestDateTime": "2022-09-16T12:00:06.5137388Z",
  "exportJobStatus": "inProgress",
  "exportUrl": null
}

例 2: エクスポート ジョブを作成して RemoteConnectionQualityReports レポートをダウンロードします。

次の例では、エクスポート ジョブを作成して RemoteConnectionQualityReports レポートをダウンロードする方法を示します。

要求

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

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/exportJobs
Content-Type: application/json
Content-length: 315

{
  "reportName": "RemoteConnectionQualityReports",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "AvgRoundTripTimeInMsP50",
    "LastConnectionRoundTripTimeInMs",
    "AvgAvailableBandwidthInMBpsP50",
    "LastConnectionAvailableBandWidthInMSps",
    "AvgRemoteSignInTimeInSecP50",
    "UDPConnectionPercentage",
    "LastConnectionGateway",
    "LastConnectionProtocol",
    "EventDateTime"
  ],
  "filter": "EventDateTime gt datetime'2023-06-14T07:40:41.694Z'"
}

応答

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/reports/exportJobs/$entity",
  "id": "RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330",
  "reportName": "remoteConnectionQualityReports",
  "filter": "EventDateTime gt datetime'2023-06-14T07:40:41.694Z'",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "AvgRoundTripTimeInMsP50",
    "LastConnectionRoundTripTimeInMs",
    "AvgAvailableBandwidthInMBpsP50",
    "LastConnectionAvailableBandWidthInMSps",
    "AvgRemoteSignInTimeInSecP50",
    "UDPConnectionPercentage",
    "LastConnectionGateway",
    "LastConnectionProtocol",
    "EventDateTime"
  ],
  "format": null,
  "expirationDateTime": null,
  "requestDateTime": "2023-06-14T07:40:41.694Z",
  "exportJobStatus": "inProgress",
  "exportUrl": null
}