cloudPcReports: getRemoteConnectionHistoricalReports

Artigo
05/20/2024

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha os registros de histórico de conexões remotas de um COMPUTADOR na Nuvem durante um determinado período. Este relatório contém dados como signInDateTime, signOutDateTime, useInHour, remoteSignInTimeInSec e roundTripTimeInMsP50 e assim por diante. Esses dados são agregados por hora para um período de tempo especificado, como os últimos sete dias.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	CloudPC.Read.All	CloudPC.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	CloudPC.Read.All	CloudPC.ReadWrite.All

Solicitação HTTP

POST /deviceManagement/virtualEndpoint/reports/getRemoteConnectionHistoricalReports

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON dos parâmetros.

A tabela a seguir mostra os parâmetros que podem ser usados com esta ação.

Parâmetro	Tipo	Descrição
filter	Cadeia de caracteres	Sintaxe do filtro OData. Os filtros com suporte incluem , , , , , `gt`e `geeq`. `leltorand` O `CloudPcId` filtro é necessário; por exemplo: `CloudPcId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. Se esse filtro estiver ausente, malformado ou inválido, uma configuração de consulta será lançada.
select	String collection	OData selecione sintaxe. As colunas a serem incluídas no relatório.
search	Cadeia de caracteres	A cadeia de caracteres a ser pesquisada.
Groupby	String collection	Uma lista de colunas que descrevem como agrupar os dados no relatório.
Orderby	Coleção String	Uma lista de colunas que descrevem como classificar os dados no relatório.
skip	Int32	Número de registros a serem pulados.
top	Int32	O número superior de registros a serem retornados.

Resposta

Se for bem-sucedida, essa ação retornará um 200 OK código de resposta e um Stream no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

{
    "filter": "CloudPcId eq '40f9315c-5b63-4126-9f89-b7dcb14fffff' and SignInDateTime gt datetime'2022-09-09T01:22:51.849Z'",
    "select": [
        "SignInDateTime",
        "SignOutDateTime",
        "UsageInHour",
        "RoundTripTimeInMsP50",
        "AvailableBandwidthInMBpsP50",
        "RemoteSignInTimeInSec"
    ],
    "top": 25,
    "skip": 0
}


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

// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.Reports.GetRemoteConnectionHistoricalReports;

var requestBody = new GetRemoteConnectionHistoricalReportsPostRequestBody
{
	Filter = "CloudPcId eq '40f9315c-5b63-4126-9f89-b7dcb14fffff' and SignInDateTime gt datetime'2022-09-09T01:22:51.849Z'",
	Select = new List<string>
	{
		"SignInDateTime",
		"SignOutDateTime",
		"UsageInHour",
		"RoundTripTimeInMsP50",
		"AvailableBandwidthInMBpsP50",
		"RemoteSignInTimeInSec",
	},
	Top = 25,
	Skip = 0,
};

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

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



mgc-beta device-management virtual-endpoint reports get-remote-connection-historical-reports post --body '{\
    "filter": "CloudPcId eq '40f9315c-5b63-4126-9f89-b7dcb14fffff' and SignInDateTime gt datetime'2022-09-09T01:22:51.849Z'",\
    "select": [\
        "SignInDateTime",\
        "SignOutDateTime",\
        "UsageInHour",\
        "RoundTripTimeInMsP50",\
        "AvailableBandwidthInMBpsP50",\
        "RemoteSignInTimeInSec"\
    ],\
    "top": 25,\
    "skip": 0\
}\
'

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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"
	  //other-imports
)

requestBody := graphdevicemanagement.NewGetRemoteConnectionHistoricalReportsPostRequestBody()
filter := "CloudPcId eq '40f9315c-5b63-4126-9f89-b7dcb14fffff' and SignInDateTime gt datetime'2022-09-09T01:22:51.849Z'"
requestBody.SetFilter(&filter) 
select := []string {
	"SignInDateTime",
	"SignOutDateTime",
	"UsageInHour",
	"RoundTripTimeInMsP50",
	"AvailableBandwidthInMBpsP50",
	"RemoteSignInTimeInSec",
}
requestBody.SetSelect(select)
top := int32(25)
requestBody.SetTop(&top) 
skip := int32(0)
requestBody.SetSkip(&skip) 

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

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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.getremoteconnectionhistoricalreports.GetRemoteConnectionHistoricalReportsPostRequestBody getRemoteConnectionHistoricalReportsPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.getremoteconnectionhistoricalreports.GetRemoteConnectionHistoricalReportsPostRequestBody();
getRemoteConnectionHistoricalReportsPostRequestBody.setFilter("CloudPcId eq '40f9315c-5b63-4126-9f89-b7dcb14fffff' and SignInDateTime gt datetime'2022-09-09T01:22:51.849Z'");
LinkedList<String> select = new LinkedList<String>();
select.add("SignInDateTime");
select.add("SignOutDateTime");
select.add("UsageInHour");
select.add("RoundTripTimeInMsP50");
select.add("AvailableBandwidthInMBpsP50");
select.add("RemoteSignInTimeInSec");
getRemoteConnectionHistoricalReportsPostRequestBody.setSelect(select);
getRemoteConnectionHistoricalReportsPostRequestBody.setTop(25);
getRemoteConnectionHistoricalReportsPostRequestBody.setSkip(0);
graphClient.deviceManagement().virtualEndpoint().reports().getRemoteConnectionHistoricalReports().post(getRemoteConnectionHistoricalReportsPostRequestBody);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const stream = {
    filter: 'CloudPcId eq \'40f9315c-5b63-4126-9f89-b7dcb14fffff\' and SignInDateTime gt datetime\'2022-09-09T01:22:51.849Z\'',
    select: [
        'SignInDateTime',
        'SignOutDateTime',
        'UsageInHour',
        'RoundTripTimeInMsP50',
        'AvailableBandwidthInMBpsP50',
        'RemoteSignInTimeInSec'
    ],
    top: 25,
    skip: 0
};

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

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\Reports\GetRemoteConnectionHistoricalReports\GetRemoteConnectionHistoricalReportsPostRequestBody;


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

$requestBody = new GetRemoteConnectionHistoricalReportsPostRequestBody();
$requestBody->setFilter('CloudPcId eq \'40f9315c-5b63-4126-9f89-b7dcb14fffff\' and SignInDateTime gt datetime\'2022-09-09T01:22:51.849Z\'');
$requestBody->setSelect(['SignInDateTime', 'SignOutDateTime', 'UsageInHour', 'RoundTripTimeInMsP50', 'AvailableBandwidthInMBpsP50', 'RemoteSignInTimeInSec', 	]);
$requestBody->setTop(25);
$requestBody->setSkip(0);

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

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


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

$params = @{
	filter = "CloudPcId eq '40f9315c-5b63-4126-9f89-b7dcb14fffff' and SignInDateTime gt datetime'2022-09-09T01:22:51.849Z'"
	select = @(
	"SignInDateTime"
"SignOutDateTime"
"UsageInHour"
"RoundTripTimeInMsP50"
"AvailableBandwidthInMBpsP50"
"RemoteSignInTimeInSec"
)
top = 25
skip = 0
}

Get-MgBetaDeviceManagementVirtualEndpointReportRemoteConnectionHistoricalReport -BodyParameter $params

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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_remote_connection_historical_reports.get_remote_connection_historical_reports_post_request_body import GetRemoteConnectionHistoricalReportsPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = GetRemoteConnectionHistoricalReportsPostRequestBody(
	filter = "CloudPcId eq '40f9315c-5b63-4126-9f89-b7dcb14fffff' and SignInDateTime gt datetime'2022-09-09T01:22:51.849Z'",
	select = [
		"SignInDateTime",
		"SignOutDateTime",
		"UsageInHour",
		"RoundTripTimeInMsP50",
		"AvailableBandwidthInMBpsP50",
		"RemoteSignInTimeInSec",
	],
	top = 25,
	skip = 0,
)

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

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
    "TotalRowCount": 4,
    "Schema": [
        {
            "Column": "SignInDateTime",
            "PropertyType": "DateTime"
        },
        {
            "Column": "SignOutDateTime",
            "PropertyType": "DateTime"
        },
        {
            "Column": "UsageInHour",
            "PropertyType": "Double"
        },
        {
            "Column": "RoundTripTimeInMsP50",
            "PropertyType": "Double"
        },
        {
            "Column": "AvailableBandwidthInMBpsP50",
            "PropertyType": "Double"
        },
        {
            "Column": "RemoteSignInTimeInSec",
            "PropertyType": "Double"
        }
    ],
    "Values": [
        [
            "2022-09-06T05:28:52",
            "2022-09-06T07:03:16",
            1.5733333333333333,
            293.0,
            5.22265625,
            19.606
        ],
        [
            "2022-09-06T13:25:04",
            "2022-09-06T13:25:37",
            0.009166666666666667,
            332.0,
            0.9345703125,
            11.264
        ],
        [
            "2022-09-06T13:26:26",
            "2022-09-06T13:48:00",
            0.3591666666666667,
            304.0,
            3.84765625,
            9.075
        ],
        [
            "2022-09-07T00:17:50",
            "2022-09-07T23:56:44",
            23.648055555555555,
            300.0,
            1.9375,
            10.977
        ]
    ]
}

Compartilhar via

cloudPcReports: getRemoteConnectionHistoricalReports

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Solicitação

Resposta

Comentários

Recursos adicionais