cloudPcReports: retrieveCrossregionDisasterRecoveryReport

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Retrieve the Windows 365 cross-region disaster recovery report, including CloudPcId, UserId, DeviceId, CloudPCDeviceDisplayName, UserPrincipalName, IsCrossRegionEnabled, CrossRegionHealthStatus, LicenseType, DisasterRecoveryStatus, CurrentRestorePointDateTime, and ActivationExpirationDateTime.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) CloudPC.Read.All CloudPC.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application CloudPC.Read.All CloudPC.ReadWrite.All

HTTP request

POST /deviceManagement/virtualEndpoint/reports/retrieveCrossRegionDisasterRecoveryReport

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameters that you can use with this action.

Parameter Type Description
filter String OData $filter syntax. The supported filters are: and, or, lt, le, gt, ge, and eq.
groupBy String collection Specifies how to group the reports. If used, must have the same content as the select parameter.
orderBy String collection Specifies how to sort the reports.
search String Specifies a String to search.
select String collection OData $select syntax. The selected columns of the reports.
skip Int32 The number of records to skip.
top Int32 The number of top records to return.

Response

If successful, this action returns a 200 OK response code and a Stream in the response body.

Examples

Request

The following example shows a request.

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
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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