cloudPcReports: getInaccessibleCloudPcReports

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Rufen Sie unzugängliche Cloud-PCs mit Details ab, einschließlich des aktuellen Integritätszustands, der Anzahl fehlerhafter Verbindungen, der Anzahl fehlerhafter Integritätsprüfung und der systembasierten status. Ein nicht zugänglicher Cloud-PC stellt einen Cloud-PC dar, der sich in einem nicht verfügbaren Zustand befindet (mindestens eine der Integritätsprüfungen ist fehlgeschlagen) oder bei dem aufeinanderfolgende Benutzerverbindungen ein Fehler aufgetreten ist.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) CloudPC.Read.All CloudPC.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application CloudPC.Read.All CloudPC.ReadWrite.All

HTTP-Anforderung

POST /deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.
Bevorzugen: include-unknown-enum-members Aktiviert verwertbare Enumerationswerte, die über den Sentinelwert hinausgehen. Weitere Informationen finden Sie unter Bewährte Methoden für die Arbeit mit Microsoft Graph. Optional.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.

In der folgenden Tabelle sind die Parameter aufgeführt, die Sie mit dieser Methode verwenden können.

Parameter Typ Beschreibung
filter Zeichenfolge OData-Syntax $filter . Nur and, or, gt ,ge und eq werden derzeit unterstützt.
groupBy String collection Gibt an, wie die Berichte gruppiert werden. Wenn verwendet, muss der gleiche Inhalt wie der Select-Parameter aufweisen.
orderBy String collection Gibt an, wie die Berichte sortiert werden.
reportName cloudPCInaccessibleReportName Der Berichtsname. Mögliche Werte sind: inaccessibleCloudPcReports, inaccessibleCloudPcTrendReport, unknownFutureValue, regionalInaccessibleCloudPcTrendReport. Der Standardwert ist inaccessibleCloudPcReports , wenn reportName leer ist. Sie müssen den Anforderungsheader Prefer: include-unknown-enum-members verwenden, um die folgenden Member in dieser verteilbaren Enumeration abzurufen: regionalInaccessibleCloudPcTrendReport.
search Zeichenfolge Gibt eine Zeichenfolge an, nach der gesucht werden soll.
select String collection OData-Syntax $select . Stellt die ausgewählten Spalten der Berichte dar.
skip Int32 Anzahl der zu überspringenden Datensätze.
Nach oben Int32 Die Anzahl der wichtigsten Datensätze, die zurückgegeben werden sollen.

cloudPCInaccessibleReportName-Werte

Member Beschreibung
inaccessibleCloudPcReports Gibt einen Bericht an, der Details zu Cloud-PCs enthält, auf die nicht zugegriffen werden kann, einschließlich solcher mit aufeinander folgenden Verbindungsfehlern oder in einem nicht verfügbaren Zustand.
inaccessibleCloudPcTrendReport Gibt einen täglichen aggregierten Bericht für einen angegebenen Zeitraum an, der Details zu Cloud-PCs enthält, auf die nicht zugegriffen werden kann, einschließlich solcher mit aufeinanderfolgenden Verbindungsfehlern oder in einem nicht verfügbaren Zustand.
unknownFutureValue Wert des Sentinelwerts für die vervolvbare Enumeration. Nicht verwenden.
regionalInaccessibleCloudPcTrendReport Gibt den wöchentlichen regionalen aggregierten Bericht über nicht zugängliche Cloud-PC-Trends an.

Antwort

Wenn die Methode erfolgreich verläuft, werden der 200 OK Antwortcode und ein Stream -Objekt im Antworttext zurückgegeben.

In der folgenden Tabelle werden die Spalten im zurückgegebenen Bericht beschrieben, wenn Sie für die reportName-Eigenschaft in Ihrem API-Aufruf angebeninaccessibleCloudPcReports. Für inaccessibleCloudPcReportsmüssen die Memberwerte im Camel-Case-Format vorliegen.

Member Beschreibung
cloudPcId Der eindeutige Bezeichner des Cloud-PCs.
cloudPcName Der Anzeigename des Cloud-PCs.
deviceHealthStatus Die aktuelle Integritäts-status des Cloud-PC-Geräts.
deviceHealthStatusDateTime Datum und Uhrzeit der letzten Aktualisierung der Geräteintegrität status.
provisioningStatus Die Bereitstellung status des Cloud-PCs.
recentConnectionFailureCount Die Anzahl der letzten Verbindungsfehler für den Cloud-PC.
recentDeviceHealthFailureCount Die Anzahl der zuletzt aufgetretenen Fehler bei der Geräteintegritätsprüfung.
Region Die Azure Region, in der der Cloud-PC gehostet wird.
systemStatus Das aktuelle System status des Cloud-PCs.
systemStatusDateTime Das Datum und die Uhrzeit der letzten Aktualisierung des System status.
userPrincipalName Der Benutzerprinzipalname (UPN) des Benutzers, der dem Cloud-PC zugewiesen ist.

In der folgenden Tabelle werden die Spalten im zurückgegebenen Bericht beschrieben, wenn Sie für die reportName-Eigenschaft in Ihrem API-Aufruf angebenregionalInaccessibleCloudPcTrendReport.

Member Beschreibung
CloudPcCount Die Gesamtzahl der Cloud-PCs in der Region.
HostRegionName Der Name der Azure Region, in der die Cloud-PCs gehostet werden.
Last24hPeakInaccessibleCloudPcCount Die Spitzenanzahl der nicht zugänglichen Cloud-PCs in den letzten 24 Stunden.
WeeklyInaccessibleTrend Der Trend im wöchentlichen Verhältnis zwischen nicht zugänglichen Cloud-PCs und der Gesamtzahl der Cloud-PCs in der Region. Der Trend wird mithilfe der linearen Regression über vier Wochen berechnet. Werte können (Steigung 0,05), Decreasing (Steigung < -0,05) oder Static (andernfalls) sein Increasing .>
WeeklyPeakInaccessibleCloudPcCount Die Spitzenanzahl der nicht zugänglichen Cloud-PCs in der aktuellen Woche. Der wöchentliche Zeitraum beginnt von Sonntag bis zum aktuellen Tag.

Beispiele

Beispiel 1: Abrufen von Berichten über nicht zugängliche Cloud-PCs in einer bestimmten Region

Das folgende Beispiel zeigt, wie Sie Berichte über nicht zugängliche Cloud-PCs in einer bestimmten Region abrufen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

{
  "filter": "region eq 'westus2'",
  "orderBy": [
    "cloudPcId"
  ],
  "select": [
    "cloudPcId",
    "aadDeviceId",
    "cloudPcName",
    "userPrincipalName",
    "provisioningStatus",
    "region",
    "deviceHealthStatus",
    "deviceHealthStatusDateTime",
    "recentDeviceHealthFailureCount",
    "recentConnectionFailureCount",
    "systemStatus",
    "systemStatusDateTime"
  ],
  "top": 10,
  "skip": 0
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

{
  "TotalRowCount": 2,
  "Schema": [
    {
      "Column": "cloudPcId",
      "PropertyType": "String"
    },
    {
      "Column": "aadDeviceId",
      "PropertyType": "String"
    },
    {
      "Column": "cloudPcName",
      "PropertyType": "String"
    },
    {
      "Column": "userPrincipalName",
      "PropertyType": "String"
    },
    {
      "Column": "provisioningStatus",
      "PropertyType": "String"
    },
    {
      "Column": "region",
      "PropertyType": "String"
    },
    {
      "Column": "deviceHealthStatus",
      "PropertyType": "String"
    },
    {
      "Column": "deviceHealthStatusDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "recentDeviceHealthFailureCount",
      "PropertyType": "Int32"
    },
    {
      "Column": "recentConnectionFailureCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "systemStatus",
      "PropertyType": "String"
    },
    {
      "Column": "systemStatusDateTime",
      "PropertyType": "DateTime"
    }
  ],
  "Values": [
    [
      "04e279c5-b228-4700-93c3-6f1339c7c86d",
      "a8f78191-8e43-4165-9191-16867d372161",
      "CPC-test1-VGTEK",
      "bob@fabrikam.com",
      "Provisioned",
      "westus2",
      "ErrorVMNotRunning",
      "2023-06-26T03:55:04",
      3,
      0,
      "",
      null
    ],
    [
      "818ff73d-9764-4412-ad99-fc65a396daf3",
      "daefef60-a912-4180-a5c0-f607e346878f",
      "CPC-test2-C84W3",
      "megan@fabrikam.com",
      "Provisioned",
      "westus2",
      "ErrorVMNotRunning",
      "2023-06-26T04:03:49",
      3,
      0,
      "",
      null
    ]
  ]
}

Das folgende Beispiel zeigt, wie Sie den wöchentlichen regionalen aggregierten Bericht über nicht zugängliche Cloud-PC-Trends abrufen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
Content-Type: application/json
Prefer: include-unknown-enum-members

{
  "reportName": "regionalInaccessibleCloudPcTrendReport",
  "filter": "",
  "select": [
    "HostRegionName",
    "CloudPcCount",
    "WeeklyPeakInaccessibleCloudPcCount",
    "Last24hPeakInaccessibleCloudPcCount",
    "WeeklyInaccessibleTrend"
  ],
  "search": "",
  "skip": 0,
  "top": 50
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

{
  "TotalRowCount": 2,
  "Schema": [
    {
      "Column": "HostRegionName",
      "PropertyType": "String"
    },
    {
      "Column": "CloudPcCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "WeeklyPeakInaccessibleCloudPcCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "Last24hPeakInaccessibleCloudPcCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "WeeklyInaccessibleTrend",
      "PropertyType": "String"
    }
  ],
  "Values": [
    [ "Japan East", 46, 10, 5, "Increasing" ],
    [ "East US", 1, 0, 0, "Decreasing" ]
  ]
}