Skip to content

protectionpolicybase-get.md

Latest commit

 

History

History
237 lines (192 loc) · 8.6 KB

protectionpolicybase-get.md

File metadata and controls

237 lines (192 loc) · 8.6 KB
title Get protectionPolicyBase
description Get a protection policy by ID.
author tushar20
ms.reviewer manikantsinghms
ms.localizationpriority medium
ms.subservice m365-backup-storage
doc_type apiPageType
ms.date 08/26/2024

Get protectionPolicyBase

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a protection policy by ID. Read the properties and relationships of a protectionPolicyBase object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

GET /solutions/backupRestore/protectionPolicies/{protectionPolicyBaseId}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a protectionPolicyBase object in the response body.

For a list of possible error responses, see Backup Storage API error responses.

Examples

Example 1: Get standard protection policy properties

The following example shows how to get the default properties of a protection policy.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/solutions/backupRestore/ProtectionPolicies/845457dc-4bb2-4815-bef3-8628ebd1952e
Authorization: Bearer <Access-Token>

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/ProtectionPolicies/845457dc-4bb2-4815-bef3-8628ebd1952e

{
  "@odata.context": "/solutions/backupRestore/$metadata#ProtectionPolicies/$entity",
  "@odata.id": "/solutions/backupRestore/ProtectionPolicies(845457dc-4bb2-4815-bef3-8628ebd1952e)",
  "@odata.type": "#microsoft.graph.exchangeProtectionPolicy",
  "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
  "displayName": "Exchange Protection",
  "status": "updating",
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "email": "ryan@contoso.com",
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "Ryan"
    }
  },
  "createdDateTime": "2015-06-19T12:01:03.45Z",
  "lastModifiedBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "email": "rian@contoso.com",
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "Rian"
    }
  },
  "lastModifiedDateTime": "2015-06-19T12:01:03.45Z",
  "offboardRequestedDateTime": "2015-07-01T12:01:03.45Z",
  "retentionSettings": [
    {
      "interval": "R/PT10M",
      "period": "P2W"
    },
    {
      "interval": "R/P1W",
      "period": "P1Y"
    }
  ],
  "isEnabled": true
}

Example 2: Use $select to retrieve specific properties of a protection policy

The following example shows how to retrieve specific properties of a protection policy using the $select OData query parameter. For example, to return only the id, displayName, status, and protectionPolicyArtifactCount properties, add the following query expression to the request URL: $select=id,displayName,status,protectionPolicyArtifactCount.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/solutions/backupRestore/ProtectionPolicies/845457dc-4bb2-4815-bef3-8628ebd1952e?$select=id,displayName,status,protectionPolicyArtifactCount
Authorization: Bearer <Access-Token>

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/ProtectionPolicies/845457dc-4bb2-4815-bef3-8628ebd1952e

{
  "@odata.context": "/solutions/backupRestore/$metadata#ProtectionPolicies/$entity",
  "@odata.id": "/solutions/backupRestore/ProtectionPolicies(845457dc-4bb2-4815-bef3-8628ebd1952e)",
  "@odata.type": "#microsoft.graph.exchangeProtectionPolicy",
  "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
  "displayName": "Exchange Protection",
  "status": "updating",
  "offboardRequestedDateTime": "2024-08-01T10:15:30Z",
  "protectionPolicyArtifactCount": {
    "total": 3,
    "completed": 1,
    "inProgress": 1,
    "failed": 1
  }
}