cloudPcReports : retrieveCrossregionDisasterRecoveryReport

Article
07/03/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Récupérez le rapport de récupération d’urgence interrégion Windows 365, notamment CloudPcId, UserId, DeviceId, CloudPCDeviceDisplayName, UserPrincipalName, IsCrossRegionEnabled, CrossRegionHealthStatus, LicenseType, DisasterRecoveryStatus, CurrentRestorePointDateTime et ActivationExpirationDateTime.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	❌	❌	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	CloudPC.Read.All	CloudPC.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	CloudPC.Read.All	CloudPC.ReadWrite.All

Requête HTTP

POST /deviceManagement/virtualEndpoint/reports/retrieveCrossRegionDisasterRecoveryReport

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON des paramètres.

Le tableau suivant présente les paramètres que vous pouvez utiliser avec cette action.

Paramètre	Type	Description
filtre	Chaîne	Syntaxe OData `$filter` . Les filtres pris en charge sont : `and`, `orlt`, `le`, `gt`, `ge`, et `eq`.
groupBy	String collection	Spécifie comment regrouper les rapports. S’il est utilisé, doit avoir le même contenu que le paramètre select .
orderBy	String collection	Spécifie comment trier les rapports.
recherche	Chaîne	Spécifie une chaîne à rechercher.
select	String collection	Syntaxe OData `$select` . Colonnes sélectionnées des rapports.
skip	Int32	Nombre d’enregistrements à ignorer.
top	Int32	Nombre d’enregistrements principaux à retourner.

Réponse

Si elle réussit, cette action renvoie un 200 OK code de réponse et un flux dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

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

{
  "filter": "DisasterRecoveryStatus eq 'Active outage'",
  "select": [
    "Id",
    "CloudPcId",
    "UserId",
    "UserSettingId",
    "DeviceId",
    "CloudPCDeviceDisplayName",
    "UserPrincipalName",
    "IsCrossRegionEnabled",
    "CrossRegionHealthStatus",
    "LicenseType",
    "DisasterRecoveryStatus",
    "CurrentRestorePointDateTime",
    "ActivationExpirationDateTime"
  ],
  "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.RetrieveCrossRegionDisasterRecoveryReport;

var requestBody = new RetrieveCrossRegionDisasterRecoveryReportPostRequestBody
{
	Filter = "DisasterRecoveryStatus eq 'Active outage'",
	Select = new List<string>
	{
		"Id",
		"CloudPcId",
		"UserId",
		"UserSettingId",
		"DeviceId",
		"CloudPCDeviceDisplayName",
		"UserPrincipalName",
		"IsCrossRegionEnabled",
		"CrossRegionHealthStatus",
		"LicenseType",
		"DisasterRecoveryStatus",
		"CurrentRestorePointDateTime",
		"ActivationExpirationDateTime",
	},
	Skip = 0,
	Top = 50,
};

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

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



mgc-beta device-management virtual-endpoint reports retrieve-cross-region-disaster-recovery-report post --body '{\
  "filter": "DisasterRecoveryStatus eq 'Active outage'",\
  "select": [\
    "Id",\
    "CloudPcId",\
    "UserId",\
    "UserSettingId",\
    "DeviceId",\
    "CloudPCDeviceDisplayName",\
    "UserPrincipalName",\
    "IsCrossRegionEnabled",\
    "CrossRegionHealthStatus",\
    "LicenseType",\
    "DisasterRecoveryStatus",\
    "CurrentRestorePointDateTime",\
    "ActivationExpirationDateTime"\
  ],\
  "skip": 0,\
  "top": 50\
}\
'

Importante



// 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.NewRetrieveCrossRegionDisasterRecoveryReportPostRequestBody()
filter := "DisasterRecoveryStatus eq 'Active outage'"
requestBody.SetFilter(&filter) 
select := []string {
	"Id",
	"CloudPcId",
	"UserId",
	"UserSettingId",
	"DeviceId",
	"CloudPCDeviceDisplayName",
	"UserPrincipalName",
	"IsCrossRegionEnabled",
	"CrossRegionHealthStatus",
	"LicenseType",
	"DisasterRecoveryStatus",
	"CurrentRestorePointDateTime",
	"ActivationExpirationDateTime",
}
requestBody.SetSelect(select)
skip := int32(0)
requestBody.SetSkip(&skip) 
top := int32(50)
requestBody.SetTop(&top) 

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

Importante


// 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.retrievecrossregiondisasterrecoveryreport.RetrieveCrossRegionDisasterRecoveryReportPostRequestBody retrieveCrossRegionDisasterRecoveryReportPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.retrievecrossregiondisasterrecoveryreport.RetrieveCrossRegionDisasterRecoveryReportPostRequestBody();
retrieveCrossRegionDisasterRecoveryReportPostRequestBody.setFilter("DisasterRecoveryStatus eq 'Active outage'");
LinkedList<String> select = new LinkedList<String>();
select.add("Id");
select.add("CloudPcId");
select.add("UserId");
select.add("UserSettingId");
select.add("DeviceId");
select.add("CloudPCDeviceDisplayName");
select.add("UserPrincipalName");
select.add("IsCrossRegionEnabled");
select.add("CrossRegionHealthStatus");
select.add("LicenseType");
select.add("DisasterRecoveryStatus");
select.add("CurrentRestorePointDateTime");
select.add("ActivationExpirationDateTime");
retrieveCrossRegionDisasterRecoveryReportPostRequestBody.setSelect(select);
retrieveCrossRegionDisasterRecoveryReportPostRequestBody.setSkip(0);
retrieveCrossRegionDisasterRecoveryReportPostRequestBody.setTop(50);
graphClient.deviceManagement().virtualEndpoint().reports().retrieveCrossRegionDisasterRecoveryReport().post(retrieveCrossRegionDisasterRecoveryReportPostRequestBody);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const stream = {
  filter: 'DisasterRecoveryStatus eq \'Active outage\'',
  select: [
    'Id',
    'CloudPcId',
    'UserId',
    'UserSettingId',
    'DeviceId',
    'CloudPCDeviceDisplayName',
    'UserPrincipalName',
    'IsCrossRegionEnabled',
    'CrossRegionHealthStatus',
    'LicenseType',
    'DisasterRecoveryStatus',
    'CurrentRestorePointDateTime',
    'ActivationExpirationDateTime'
  ],
  skip: 0,
  top: 50
};

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

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\Reports\RetrieveCrossRegionDisasterRecoveryReport\RetrieveCrossRegionDisasterRecoveryReportPostRequestBody;


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

$requestBody = new RetrieveCrossRegionDisasterRecoveryReportPostRequestBody();
$requestBody->setFilter('DisasterRecoveryStatus eq \'Active outage\'');
$requestBody->setSelect(['Id', 'CloudPcId', 'UserId', 'UserSettingId', 'DeviceId', 'CloudPCDeviceDisplayName', 'UserPrincipalName', 'IsCrossRegionEnabled', 'CrossRegionHealthStatus', 'LicenseType', 'DisasterRecoveryStatus', 'CurrentRestorePointDateTime', 'ActivationExpirationDateTime', 	]);
$requestBody->setSkip(0);
$requestBody->setTop(50);

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

Importante


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

$params = @{
	filter = "DisasterRecoveryStatus eq 'Active outage'"
	select = @(
	"Id"
"CloudPcId"
"UserId"
"UserSettingId"
"DeviceId"
"CloudPCDeviceDisplayName"
"UserPrincipalName"
"IsCrossRegionEnabled"
"CrossRegionHealthStatus"
"LicenseType"
"DisasterRecoveryStatus"
"CurrentRestorePointDateTime"
"ActivationExpirationDateTime"
)
skip = 0
top = 50
}

Get-MgBetaDeviceManagementVirtualEndpointReportCrossRegionDisasterRecoveryReport -BodyParameter $params

Importante


from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.devicemanagement.virtualendpoint.reports.retrieve_cross_region_disaster_recovery_report.retrieve_cross_region_disaster_recovery_report_post_request_body import RetrieveCrossRegionDisasterRecoveryReportPostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = RetrieveCrossRegionDisasterRecoveryReportPostRequestBody(
	filter = "DisasterRecoveryStatus eq 'Active outage'",
	select = [
		"Id",
		"CloudPcId",
		"UserId",
		"UserSettingId",
		"DeviceId",
		"CloudPCDeviceDisplayName",
		"UserPrincipalName",
		"IsCrossRegionEnabled",
		"CrossRegionHealthStatus",
		"LicenseType",
		"DisasterRecoveryStatus",
		"CurrentRestorePointDateTime",
		"ActivationExpirationDateTime",
	],
	skip = 0,
	top = 50,
)

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

Importante

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "TotalRowCount": 1,
  "Schema": [
    {
      "Column": "Id",
      "PropertyType": "String"
    },
    {
      "Column": "CloudPcId",
      "PropertyType": "String"
    },
    {
      "Column": "UserId",
      "PropertyType": "String"
    },
    {
      "Column": "UserSettingId",
      "PropertyType": "String"
    },
    {
      "Column": "DeviceId",
      "PropertyType": "String"
    },
    {
      "Column": "CloudPcDeviceDisplayName",
      "PropertyType": "String"
    },
    {
      "Column": "UserPrincipalName",
      "PropertyType": "String"
    },
    {
      "Column": "IsCrossRegionEnabled",
      "PropertyType": "Boolean"
    },
    {
      "Column": "CrossRegionHealthStatus",
      "PropertyType": "String"
    },
    {
      "Column": "LicenseType",
      "PropertyType": "String"
    },
    {
      "Column": "DisasterRecoveryStatus",
      "PropertyType": "String"
    },
    {
      "Column": "CurrentRestorePointDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "ActivationExpirationDateTime",
      "PropertyType": "DateTime"
    }
  ],
  "Values": [
    [
      "7768debd-7955-4b32-a654-a02894bce953",
      "69360332-619a-4b38-af5d-91ecef72f789",
      "c939b389-979f-4687-945d-d1220b3d4d24",
      "k739b389-979f-4j87-945d-d3220b3d4o24",
      "9330ff50-0a1b-4038-8fe8-3c4a67ec4dc5",
      "CPC-Cross-JG79E",
      "john.doe@contoso.com",
      true,
      "Unhealthy:'ANC unhealthy', 'Network mismatch'",
      "Cross Region",
      "Active outage",
      "2023-10-16 03:05:14.131 AM",
      "2023-10-19 07:05:14.131 AM"
    ]
  ]
}

Partager via

cloudPcReports : retrieveCrossregionDisasterRecoveryReport

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemples

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires