cloudPcReports: getCloudPCPerformanceReport

Статья
12/18/2024

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получите отчет, связанный с производительностью облачных компьютеров.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	CloudPC.Read.All	CloudPC.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	CloudPC.Read.All	CloudPC.ReadWrite.All

HTTP-запрос

POST /deviceManagement/virtualEndpoint/reports/getCloudPCPerformanceReport

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление параметров в формате JSON.

В следующей таблице показаны параметры, которые можно использовать с этим методом.

Параметр	Тип	Описание
filter	String	Синтаксис OData `$filter` . Поддерживаемые фильтры: `and`, `or`, `gt`и `eq`.
groupBy	Коллекция строк	Указывает, как группировать отчеты. Если используется, содержимое должно совпадать с параметром select .
orderBy	Коллекция строк	Указывает способ сортировки отчетов.
reportName	cloudPCPerformanceReportName	Имя отчета. Возможные значения: `performanceTrendReport`, `unknownFutureValue`.
search	String	Указывает строку для поиска.
select	Коллекция строк	Синтаксис OData `$select` . Выбранные столбцы отчетов.
skip	Int32	Количество записей, которые нужно пропустить.
top	Int32	Задает размер страницы. Если значение не определено, значение по умолчанию равно 25 и не более 100.

значения cloudPCPerformanceReportName

Member Описание

performanceTrendReport Указывает ежедневный агрегированный отчет, предоставляющий список метрик качества подключения для облачных компьютеров за последние семь дней в клиенте. Метрики включают SlowRoundTripTimeCloudPcCount, LowUdpConnectionPercentageCount, NoTimeConnectedCloudPcCountи LowTimeConnectedCloudPcCount. Каждый ежедневный отчет — это агрегат предыдущих 28 дней, отсчитываемый из времени триггера.

unknownFutureValue Изменяемое значение перечисления sentinel. Не используйте.

Member	Описание
performanceTrendReport	Указывает ежедневный агрегированный отчет, предоставляющий список метрик качества подключения для облачных компьютеров за последние семь дней в клиенте. Метрики включают `SlowRoundTripTimeCloudPcCount`, `LowUdpConnectionPercentageCount`, `NoTimeConnectedCloudPcCount`и `LowTimeConnectedCloudPcCount`. Каждый ежедневный отчет — это агрегат предыдущих 28 дней, отсчитываемый из времени триггера.
unknownFutureValue	Изменяемое значение перечисления sentinel. Не используйте.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект Stream в теле отклика.

Примеры

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getCloudPcPerformanceReport
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
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.Reports.GetCloudPcPerformanceReport;
using Microsoft.Graph.Beta.Models;

var requestBody = new GetCloudPcPerformanceReportPostRequestBody
{
	ReportName = CloudPCPerformanceReportName.PerformanceTrendReport,
	Filter = "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
	Select = new List<string>
	{
		"EventDateTime",
		"SlowRoundTripTimeCloudPcCount",
		"LowUdpConnectionPercentageCount",
		"NoActiveTimeConnectedCount",
		"LowActiveTimeConnectedCount",
	},
	Search = "",
	Skip = 0,
	Top = 50,
};

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.VirtualEndpoint.Reports.GetCloudPcPerformanceReport.PostAsync(requestBody);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



mgc-beta device-management virtual-endpoint reports get-cloud-pc-performance-report post --body '{\
  "reportName": "performanceTrendReport",\
  "filter": "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",\
  "select": [\
    "EventDateTime",\
    "SlowRoundTripTimeCloudPcCount",\
    "LowUdpConnectionPercentageCount",\
    "NoActiveTimeConnectedCount",\
    "LowActiveTimeConnectedCount"\
  ],\
  "search": "",\
  "skip": 0,\
  "top": 50\
}\
'

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



// 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"
	  graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphdevicemanagement.NewGetCloudPcPerformanceReportPostRequestBody()
reportName := graphmodels.PERFORMANCETRENDREPORT_CLOUDPCPERFORMANCEREPORTNAME 
requestBody.SetReportName(&reportName) 
filter := "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'"
requestBody.SetFilter(&filter) 
select := []string {
	"EventDateTime",
	"SlowRoundTripTimeCloudPcCount",
	"LowUdpConnectionPercentageCount",
	"NoActiveTimeConnectedCount",
	"LowActiveTimeConnectedCount",
}
requestBody.SetSelect(select)
search := ""
requestBody.SetSearch(&search) 
skip := int32(0)
requestBody.SetSkip(&skip) 
top := int32(50)
requestBody.SetTop(&top) 

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().VirtualEndpoint().Reports().GetCloudPcPerformanceReport().Post(context.Background(), requestBody, nil)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.getcloudpcperformancereport.GetCloudPcPerformanceReportPostRequestBody getCloudPcPerformanceReportPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.getcloudpcperformancereport.GetCloudPcPerformanceReportPostRequestBody();
getCloudPcPerformanceReportPostRequestBody.setReportName(CloudPCPerformanceReportName.PerformanceTrendReport);
getCloudPcPerformanceReportPostRequestBody.setFilter("EventDateTime gt datetime'2023-10-13T00:00:00.000Z'");
LinkedList<String> select = new LinkedList<String>();
select.add("EventDateTime");
select.add("SlowRoundTripTimeCloudPcCount");
select.add("LowUdpConnectionPercentageCount");
select.add("NoActiveTimeConnectedCount");
select.add("LowActiveTimeConnectedCount");
getCloudPcPerformanceReportPostRequestBody.setSelect(select);
getCloudPcPerformanceReportPostRequestBody.setSearch("");
getCloudPcPerformanceReportPostRequestBody.setSkip(0);
getCloudPcPerformanceReportPostRequestBody.setTop(50);
graphClient.deviceManagement().virtualEndpoint().reports().getCloudPcPerformanceReport().post(getCloudPcPerformanceReportPostRequestBody);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

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

await client.api('/deviceManagement/virtualEndpoint/reports/getCloudPcPerformanceReport')
	.version('beta')
	.post(stream);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\Reports\GetCloudPcPerformanceReport\GetCloudPcPerformanceReportPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\CloudPCPerformanceReportName;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new GetCloudPcPerformanceReportPostRequestBody();
$requestBody->setReportName(new CloudPCPerformanceReportName('performanceTrendReport'));
$requestBody->setFilter('EventDateTime gt datetime\'2023-10-13T00:00:00.000Z\'');
$requestBody->setSelect(['EventDateTime', 'SlowRoundTripTimeCloudPcCount', 'LowUdpConnectionPercentageCount', 'NoActiveTimeConnectedCount', 'LowActiveTimeConnectedCount', 	]);
$requestBody->setSearch('');
$requestBody->setSkip(0);
$requestBody->setTop(50);

$graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->getCloudPcPerformanceReport()->post($requestBody)->wait();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


Import-Module Microsoft.Graph.Beta.DeviceManagement.Actions

$params = @{
	reportName = "performanceTrendReport"
	filter = "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'"
	select = @(
	"EventDateTime"
"SlowRoundTripTimeCloudPcCount"
"LowUdpConnectionPercentageCount"
"NoActiveTimeConnectedCount"
"LowActiveTimeConnectedCount"
)
search = ""
skip = 0
top = 50
}

Get-MgBetaDeviceManagementVirtualEndpointReportCloudPcPerformanceReport -BodyParameter $params

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.devicemanagement.virtualendpoint.reports.get_cloud_pc_performance_report.get_cloud_pc_performance_report_post_request_body import GetCloudPcPerformanceReportPostRequestBody
from msgraph_beta.generated.models.cloud_p_c_performance_report_name import CloudPCPerformanceReportName
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = GetCloudPcPerformanceReportPostRequestBody(
	report_name = CloudPCPerformanceReportName.PerformanceTrendReport,
	filter = "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
	select = [
		"EventDateTime",
		"SlowRoundTripTimeCloudPcCount",
		"LowUdpConnectionPercentageCount",
		"NoActiveTimeConnectedCount",
		"LowActiveTimeConnectedCount",
	],
	search = "",
	skip = 0,
	top = 50,
)

await graph_client.device_management.virtual_endpoint.reports.get_cloud_pc_performance_report.post(request_body)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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
    ]
  ]
}

Поделиться через

cloudPcReports: getCloudPCPerformanceReport

Разрешения

HTTP-запрос

Заголовки запросов

Текст запроса

значения cloudPCPerformanceReportName

Отклик

Примеры

Запрос

Отклик

Обратная связь

Дополнительные ресурсы