cloudPcReports: retrieveCloudPcTenantMetricsReport

[アーティクル]
01/28/2025

名前空間: microsoft.graph

重要

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

クラウド PC のパフォーマンスに関連するレポートを取得します。

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

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

アクセス許可

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

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

HTTP 要求

POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport

要求ヘッダー

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

要求本文

要求本文で、パラメーターの JSON 表現を指定します。

次の表に、このメソッドで使用できるパラメーターを示します。

パラメーター	型	説明
filter	String	OData `$filter` 構文。サポートされているフィルターは、 `and`、 `or`、 `gt`、 `eq`です。
groupBy	String collection	レポートをグループ化する方法を指定します。を使用する場合は、 select パラメーターと同じコンテンツが必要です。
orderBy	String collection	レポートを並べ替える方法を指定します。
reportName	cloudPCPerformanceReportName	レポート名。使用可能な値: `performanceTrendReport`、`unknownFutureValue`、`cloudPcInsightReport`。 `Prefer: include-unknown-enum-members`要求ヘッダーを使用して、この進化可能な列挙型で次の値を取得します:`cloudPcInsightReport`。
search	String	検索する文字列を指定します。
select	String collection	OData `$select` 構文。レポートの選択した列。
skip	Int32	スキップするレコードの数。
top	Int32	ページサイズを指定します。定義されていない場合、既定値は 25 で、最大値は 100 です。

応答

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

例

例 1: パフォーマンス傾向レポートを取得する

次の例は、テナント内の過去 7 日間のクラウド PC の接続品質メトリックの一覧を提供する、日単位の集計データを使用してパフォーマンス傾向レポートを取得する方法を示しています。

要求

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

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

{
  "reportName": "performanceTrendReport",
  "filter": "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
  "select": [
    "EventDateTime",
    "SlowRoundTripTimeCloudPcCount",
    "LowUdpConnectionPercentageCount",
    "NoActiveTimeConnectedCount",
    "LowActiveTimeConnectedCount"
  ],
  "search": "",
  "skip": 0,
  "top": 50
}

応答

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

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

HTTP/1.1 200 OK
Content-Type: application/octet-stream

{
  "TotalRowCount": 2,
  "Schema": [
    {
      "Column": "EventDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "SlowRoundTripTimeCloudPcCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "LowUdpConnectionPercentageCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "NoActiveTimeConnectedCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "LowActiveTimeConnectedCount",
      "PropertyType": "Int64"
    }
  ],
  "Values": [
    [
      "2023-10-16T00:00:00Z",
      3,
      8,
      3,
      92
    ],
    [
      "2023-10-15T00:00:00Z",
      4,
      6,
      5,
      91
    ]
  ]
}

例 2: クラウド PC 分析情報レポートを取得する

次の例は、クラウド PC レベルで構成データと分析情報を提供するクラウド PC 分析情報レポートを取得する方法を示しています。

要求