cloudPcReports: getInaccessibleCloudPcReports

Artigo
10/28/2023

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 PCs de nuvem inacessíveis com detalhes, incluindo o estado de integridade mais recente, a contagem de conexões com falha, a contagem de marcar de integridade com falha e a status do sistema. Um PC de Nuvem inacessível representa um PC de Nuvem que está em um estado indisponível (pelo menos uma das verificações de integridade falhou) ou tem falha consecutiva nas conexões de usuário.

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/getInaccessibleCloudPcReports

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 esse método.

Parâmetro	Tipo	Descrição
filter	Cadeia de caracteres	Sintaxe OData `$filter` . Somente `and`, `or`, `gt` e`geeq` atualmente há suporte.
select	String collection	Sintaxe OData `$select` . Representa as colunas selecionadas dos relatórios.
search	Cadeia de caracteres	Especifica uma cadeia de caracteres a ser pesquisada.
Groupby	String collection	Especifica como agrupar os relatórios. Se usado, deve ter o mesmo conteúdo que o parâmetro de seleção.
Orderby	Coleção String	Especifica como classificar os relatórios.
skip	Int32	Número de registros a serem pulados.
top	Int32	O número de registros principais a serem retornados.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto 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/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
}


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

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

var requestBody = new GetInaccessibleCloudPcReportsPostRequestBody
{
	Filter = "region eq 'westus2'",
	OrderBy = new List<string>
	{
		"cloudPcId",
	},
	Select = new List<string>
	{
		"cloudPcId",
		"aadDeviceId",
		"cloudPcName",
		"userPrincipalName",
		"provisioningStatus",
		"region",
		"deviceHealthStatus",
		"deviceHealthStatusDateTime",
		"recentDeviceHealthFailureCount",
		"recentConnectionFailureCount",
		"systemStatus",
		"systemStatusDateTime",
	},
	Top = 10,
	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.GetInaccessibleCloudPcReports.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.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta device-management virtual-endpoint reports get-inaccessible-cloud-pc-reports post --body '{\
  "filter": "region eq 'westus2'",\
  "orderBy": [\
    "cloudPcId"\
  ],\
  "select": [\
    "cloudPcId",\
    "aadDeviceId",\
    "cloudPcName",\
    "userPrincipalName",\
    "provisioningStatus",\
    "region",\
    "deviceHealthStatus",\
    "deviceHealthStatusDateTime",\
    "recentDeviceHealthFailureCount",\
    "recentConnectionFailureCount",\
    "systemStatus",\
    "systemStatusDateTime"\
  ],\
  "top": 10,\
  "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.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphdevicemanagement.NewGetInaccessibleCloudPcReportsPostRequestBody()
filter := "region eq 'westus2'"
requestBody.SetFilter(&filter) 
orderBy := []string {
	"cloudPcId",
}
requestBody.SetOrderBy(orderBy)
select := []string {
	"cloudPcId",
	"aadDeviceId",
	"cloudPcName",
	"userPrincipalName",
	"provisioningStatus",
	"region",
	"deviceHealthStatus",
	"deviceHealthStatusDateTime",
	"recentDeviceHealthFailureCount",
	"recentConnectionFailureCount",
	"systemStatus",
	"systemStatusDateTime",
}
requestBody.SetSelect(select)
top := int32(10)
requestBody.SetTop(&top) 
skip := int32(0)
requestBody.SetSkip(&skip) 

graphClient.DeviceManagement().VirtualEndpoint().Reports().GetInaccessibleCloudPcReports().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.getinaccessiblecloudpcreports.GetInaccessibleCloudPcReportsPostRequestBody getInaccessibleCloudPcReportsPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.getinaccessiblecloudpcreports.GetInaccessibleCloudPcReportsPostRequestBody();
getInaccessibleCloudPcReportsPostRequestBody.setFilter("region eq 'westus2'");
LinkedList<String> orderBy = new LinkedList<String>();
orderBy.add("cloudPcId");
getInaccessibleCloudPcReportsPostRequestBody.setOrderBy(orderBy);
LinkedList<String> select = new LinkedList<String>();
select.add("cloudPcId");
select.add("aadDeviceId");
select.add("cloudPcName");
select.add("userPrincipalName");
select.add("provisioningStatus");
select.add("region");
select.add("deviceHealthStatus");
select.add("deviceHealthStatusDateTime");
select.add("recentDeviceHealthFailureCount");
select.add("recentConnectionFailureCount");
select.add("systemStatus");
select.add("systemStatusDateTime");
getInaccessibleCloudPcReportsPostRequestBody.setSelect(select);
getInaccessibleCloudPcReportsPostRequestBody.setTop(10);
getInaccessibleCloudPcReportsPostRequestBody.setSkip(0);
graphClient.deviceManagement().virtualEndpoint().reports().getInaccessibleCloudPcReports().post(getInaccessibleCloudPcReportsPostRequestBody);

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: 'region eq \'westus2\'',
  orderBy: [
    'cloudPcId'
  ],
  select: [
    'cloudPcId',
    'aadDeviceId',
    'cloudPcName',
    'userPrincipalName',
    'provisioningStatus',
    'region',
    'deviceHealthStatus',
    'deviceHealthStatusDateTime',
    'recentDeviceHealthFailureCount',
    'recentConnectionFailureCount',
    'systemStatus',
    'systemStatusDateTime'
  ],
  top: 10,
  skip: 0
};

await client.api('/deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports')
	.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\GraphServiceClient;
use Microsoft\Graph\Generated\Models\GetInaccessibleCloudPcReportsPostRequestBody;


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

$requestBody = new GetInaccessibleCloudPcReportsPostRequestBody();
$requestBody->setFilter('region eq \'westus2\'');
$requestBody->setOrderBy(['cloudPcId', 	]);
$requestBody->setSelect(['cloudPcId', 'aadDeviceId', 'cloudPcName', 'userPrincipalName', 'provisioningStatus', 'region', 'deviceHealthStatus', 'deviceHealthStatusDateTime', 'recentDeviceHealthFailureCount', 'recentConnectionFailureCount', 'systemStatus', 'systemStatusDateTime', 	]);
$requestBody->setTop(10);
$requestBody->setSkip(0);

$graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->getInaccessibleCloudPcReports()->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 = "region eq 'westus2'"
	orderBy = @(
	"cloudPcId"
)
select = @(
"cloudPcId"
"aadDeviceId"
"cloudPcName"
"userPrincipalName"
"provisioningStatus"
"region"
"deviceHealthStatus"
"deviceHealthStatusDateTime"
"recentDeviceHealthFailureCount"
"recentConnectionFailureCount"
"systemStatus"
"systemStatusDateTime"
)
top = 10
skip = 0
}

Get-MgBetaDeviceManagementVirtualEndpointReportInaccessibleCloudPcReport -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.


from msgraph import GraphServiceClient
from msgraph.generated.devicemanagement.virtualendpoint.reports.get_inaccessible_cloud_pc_reports.get_inaccessible_cloud_pc_reports_post_request_body import GetInaccessibleCloudPcReportsPostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = GetInaccessibleCloudPcReportsPostRequestBody(
	filter = "region eq 'westus2'",
	order_by = [
		"cloudPcId",
	],
	select = [
		"cloudPcId",
		"aadDeviceId",
		"cloudPcName",
		"userPrincipalName",
		"provisioningStatus",
		"region",
		"deviceHealthStatus",
		"deviceHealthStatusDateTime",
		"recentDeviceHealthFailureCount",
		"recentConnectionFailureCount",
		"systemStatus",
		"systemStatusDateTime",
	],
	top = 10,
	skip = 0,
)

await graph_client.device_management.virtual_endpoint.reports.get_inaccessible_cloud_pc_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.

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

cloudPcReports: getInaccessibleCloudPcReports

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Solicitação

Resposta

Comentários

Comentários

Recursos adicionais