次の方法で共有


cloudPcReports: retrieveCloudPcTroubleshootReports

名前空間: microsoft.graph

重要

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

クラウド PC のトラブルシューティング レポートを取得します。 地域のトラブルシューティング レポート、トラブルシューティングの詳細を含むレポート、トラブルシューティングの傾向を示すレポート、またはトラブルシューティングの問題の数に関するレポートを取得できます。

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

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

アクセス許可

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

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

HTTP 要求

POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTroubleshootReports

要求ヘッダー

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

要求本文

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

次の表に、このアクションで使用できるパラメーターの一覧を示します。

パラメーター 説明
filter String OData $filter 構文。 サポートされているフィルターは、 andorgtgeeqです。 省略可能。
orderBy String collection 列名で順序を指定します。 省略可能。
reportName cloudPCTroubleshootReportType レポート名。 使用可能な値: troubleshootDetailsReporttroubleshootTrendCountReporttroubleshootRegionalReportunknownFutureValuetroubleshootIssueCountReportPrefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型の次の値を取得します:troubleshootIssueCountReport。 既定値は troubleshootDetailsReport です。
search String 検索文字列。 省略可能。
select String collection OData $select 構文。 レポートの選択した列。 省略可能。
skip Int32 スキップするレコードの数。 省略可能。
top Int32 返す上位レコードの数。 指定しない場合、既定の制限は 25 で、最大値は 100 です。 省略可能。

応答

成功した場合、このアクションは200 OK応答コードと応答本文にStreamを返します。

次の表では、API 呼び出しで reportName プロパティにtroubleshootRegionalReportを指定するときに返されるレポートの列について説明します。

メンバー 説明
AvgBandwidthInMbps 特定の HostRegion-GatewayRegion ペアの使用可能な平均帯域幅 (Mbps)。
AvgRoundTripTimeInMs 特定の HostRegion-GatewayRegion ペアの平均ラウンド トリップ時間 (ミリ秒)。
BandwidthIssueCount 使用可能な帯域幅の問題があるクラウド PC インスタンスの数。
BandwidthStabilityIssueCount 帯域幅の安定性に問題があるクラウド PC インスタンスの数。
ConnectErrorIssueCount 接続エラーの問題があるクラウド PC インスタンスの数。
ConnectionErrorCount 特定の HostRegion-GatewayRegion ペアの接続エラーの数。
ConnectionQualityIssueCount 接続品質の問題があるクラウド PC インスタンスの数。
GatewayRegion ゲートウェイが配置されているリージョン。
HostRegion クラウド PC プロビジョニングが配置されているリージョン。
RTTIssueCount ラウンドトリップ時間の問題があるクラウド PC インスタンスの数。
RTTStabilityIssueCount ラウンドトリップ時間の安定性に問題があるクラウド PC インスタンスの数。
StabilityIssueCount 安定性の問題があるクラウド PC インスタンスの数。

次の表では、API 呼び出しで reportName プロパティにtroubleshootDetailsReportを指定するときに返されるレポートの列について説明します。

メンバー 説明
AvailableBandwidthInMbpsAvg 使用可能な平均帯域幅 (Mbps)。
ConnectionErrorCount 接続エラーの数。
CurrentCPU リソースの現在の CPU 使用率。
CurrentDiskInGB 現在のディスク使用量 (GB)。
CurrentRamInGB 現在の RAM 使用量 (GB)。
CurrentSize リソースの現在のサイズ。
HasNetworkIssue ネットワークの問題を示します。
HasPerformanceIssue パフォーマンスの問題を示します。
HasReliabilityIssue 信頼性の問題を示します。
ProvisionPolicyName プロビジョニング ポリシーの名前。
RecommendedRamInGB 推奨される RAM 使用量 (GB)。
RecommendedCPU リソースに推奨される CPU 使用率。
RecommendedDiskInGB 推奨されるディスク使用量 (GB)。
RecommendedSize リソースの推奨サイズ。
RoundTripTimeInMsAvg 平均ラウンドトリップ時間 (ミリ秒)。
UsageInsight リソースの現在の使用状況に関する分析情報。

次の表では、API 呼び出しで reportName プロパティにtroubleshootTrendCountReportを指定するときに返されるレポートの列について説明します。

メンバー 説明
CpuIssueCloudPcCount CPU の問題があるクラウド PC インスタンスの数。
CpuIssueTrend CPU の問題が発生したクラウド PC インスタンスの週数の傾向。
ConnectionQualityIssueCloudPcCount 接続品質の問題があるクラウド PC インスタンスの数。
ConnectionQualityIssueTrend 接続品質の問題があるクラウド PC インスタンスの週数の傾向。
MemoryIssueCloudPcCount メモリの問題があるクラウド PC インスタンスの数。
MemoryIssueTrend メモリの問題があるクラウド PC インスタンスの週数の傾向。
NetworkIssueCount ネットワークの問題の数。
PerformanceIssueCount パフォーマンスの問題の数。
ReliabilityIssueCount 信頼性の問題の数。
RTTIssueCloudPcCount ラウンドトリップ時間の問題があるクラウド PC インスタンスの数。
RTTIssueTrend ラウンドトリップ時間の問題があるクラウド PC インスタンスの週数の傾向。
StabilityIssueCloudPcCount 安定性の問題があるクラウド PC インスタンスの数。
StabilityIssueTrend 安定性の問題があるクラウド PC インスタンスの週数の傾向。
TotalImpactedCloudPcCount 影響を受けたクラウド PC の合計数。

次の表では、API 呼び出しで reportName プロパティにtroubleshootIssueCountReportを指定するときに返されるレポートの列について説明します。

メンバー 説明
AsofDate データが記録された日時。
ConnectionQualityIssueCount 接続品質の問題の数。
CpuIssueCount CPU の問題の数。
MemoryIssueCount メモリの問題の数。
NetworkIssueCount ネットワークの問題の数。
PerformanceIssueCount パフォーマンスの問題の数。
ReliabilityIssueCount 信頼性の問題の数。
RTTIssueCount ラウンド トリップ時間の問題の数。
StabilityIssueCount 安定性の問題の数。

要求

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

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

{
  "reportName": "troubleshootDetailsReport",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "UsageInsight",
    "CurrentSize",
    "CurrentCPU",
    "CurrentRamInGB",
    "CurrentDiskInGB",
    "RecommendedSize",
    "RecommendedCPU",
    "RecommendedRamInGB",
    "RecommendedDiskInGB",
    "ProvisionPolicyName",
    "RoundTripTimeInMsAvg",
    "AvailableBandwidthInMbpsAvg"
  ],
  "search": "",
  "skip": 0,
  "top": 50
}

応答

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

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "TotalRowCount": 1,
  "Schema": [
    {
      "Column": "CloudPcId",
      "PropertyType": "String"
    },
    {
      "Column": "ManagedDeviceName",
      "PropertyType": "String"
    },
    {
      "Column": "UserPrincipalName",
      "PropertyType": "String"
    },
    {
      "Column": "UsageInsight",
      "PropertyType": "String"
    },
    {
      "Column": "CurrentSize",
      "PropertyType": "Int"
    },
    {
      "Column": "CurrentCPU",
      "PropertyType": "Int"
    },
    {
      "Column": "CurrentRamInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "CurrentDiskInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "RecommendedSize",
      "PropertyType": "String"
    },
    {
      "Column": "RecommendedCPU",
      "PropertyType": "Int"
    },
    {
      "Column": "RecommendedRamInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "RecommendedDiskInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "ProvisionPolicyName",
      "PropertyType": "String"
    },
    {
      "Column": "RoundTripTimeInMsAvg",
      "PropertyType": "Double"
    },
    {
      "Column": "AvailableBandwidthInMbpsAvg",
      "PropertyType": "Double"
    }
  ],
  "Values": [
    [
      "f5ff445f-7488-40f8-8ab9-ee784a9c1f33",
      "Cloud PC-Ana Bowman",
      "ana@contoso.com",
      "Performance",
      "2",
      "4",
      "64",
      "Undersized",
      "4",
      "8",
      "128",
      "policy1",
      "200.1",
      "50.65"
    ]
  ]
}