Skip to content

cloudpcprovisioningpolicy-get.md

Latest commit

 

History

History
381 lines (304 loc) · 13.1 KB

cloudpcprovisioningpolicy-get.md

File metadata and controls

381 lines (304 loc) · 13.1 KB
title Get cloudPcProvisioningPolicy
description Read the properties and relationships of a cloudPcProvisioningPolicy object.
author AshleyYangSZ
ms.localizationpriority medium
ms.subservice cloud-pc
doc_type apiPageType
ms.date 08/19/2024

Get cloudPcProvisioningPolicy

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Read the properties and relationships of a cloudPcProvisioningPolicy 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 /deviceManagement/virtualEndpoint/provisioningPolicies/{id}

Optional query parameters

This method supports $select and $expand OData query parameters to help customize the response. For general information, see OData query parameters.

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 cloudPcProvisioningPolicy object in the response body.

Examples

Example 1: Get the properties of the specified provisioning policy

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/{id}

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.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy",
    "description": "Description value",
    "displayName": "Display Name value",
    "domainJoinConfigurations": [
      {
        "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
        "type": "hybridAzureADJoin"
      },
      {
        "onPremisesConnectionId": "26e16c71-f210-438b-88ac-d481ccafffff",
        "type": "hybridAzureADJoin"
      }
    ],
    "microsoftManagedDesktop": {
        "managedType": "starterManaged",
        "profile": null
    },
    "autopatch": {
        "autopatchGroupId": "91197a0b-3a74-408d-ba88-bce3fdc4e5eb"
    },
    "autopilotConfiguration": {
        "devicePreparationProfileId": "59e5d3d2-ec68-4bfe-9693-27975b318990",
        "applicationTimeoutInMinutes": 60,
        "onFailureDeviceAccessDenied": false
    },
    "enableSingleSignOn": true,
    "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",
    "imageDisplayName": "Image Display Name value",
    "imageId": "Image ID value",
    "imageType": "custom",
    "windowsSetting": {
        "locale": "en-US"
    },
    "managedBy": "windows365",
    "provisioningType": "dedicated",
    "userSettingsPersistenceConfiguration": {
        "userSettingsPersistenceEnabled": false,
        "userSettingsPersistenceStorageSizeCategory": "fourGB"
    }
}

Example 2: Get the properties of the specified provisioning policy and expand on the assignments

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/{id}?$expand=assignments

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.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy",
    "description": "Description value",
    "displayName": "Display Name value",
    "domainJoinConfigurations": [
      {
        "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
        "type": "hybridAzureADJoin"
      },
      {
        "onPremisesConnectionId": "26e16c71-f210-438b-88ac-d481ccafffff",
        "type": "hybridAzureADJoin"
      }
    ],
    "microsoftManagedDesktop": {
        "managedType": "starterManaged",
        "profile": null
    },
    "autopatch": {
        "autopatchGroupId": "91197a0b-3a74-408d-ba88-bce3fdc4e5eb"
    },
    "autopilotConfiguration": {
        "devicePreparationProfileId": "59e5d3d2-ec68-4bfe-9693-27975b318990",
        "applicationTimeoutInMinutes": 60,
        "onFailureDeviceAccessDenied": false
    },
    "enableSingleSignOn": true,
    "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",
    "imageDisplayName": "Image Display Name value",
    "imageId": "Image ID value",
    "imageType": "custom",
    "windowsSetting": {
        "locale": "en-US"
    },
    "assignments": [
      {
        "@odata.type": "microsoft.graph.cloudPcProvisioningPolicyAssignment",
        "id": "b0c2d35f-3385-46c8-a6f5-6c3dfad7708b_64ff06de-9c00-4a5a-98b5-7f5abe26ffff",
        "target": {
          "@odata.type":"microsoft.graph.cloudPCManagementGroupAssignmentTarget",
          "groupId":"64ff06de-9c00-4a5a-98b5-7f5abe26bfd9"
          }
      }
    ],
    "managedBy": "windows365",
    "provisioningType": "dedicated",
    "userSettingsPersistenceConfiguration": {
        "userSettingsPersistenceEnabled": false,
        "userSettingsPersistenceStorageSizeCategory": "fourGB"
    }
}

Example 3: Get the selected properties of the specified provisioning policy

The following example shows a request that retrieves the selected properties of the specified provisioning policy.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfigurations,imageDisplayName,imageId,imageType,windowsSetting,managedBy,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl

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.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy",
    "alternateResourceUrl": "https://ms.portal.azure.com/#contoso.com/resource/subscriptions/827f2432-9c7b-4637-b694-570b3c2f969c/resourceGroups/myResourceGroupName/providers/Microsoft.Fidalgo/projects/myProjectName/pools/myPoolName",
    "cloudPcGroupDisplayName": "MyCloudPcGroup",
    "description": "The ProvisioningPolicy for West US employees.",
    "displayName": "WestUsPolicy",
    "domainJoinConfigurations": [
      {
        "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
        "type": "hybridAzureADJoin"
      },
      {
        "onPremisesConnectionId": "26e16c71-f210-438b-88ac-d481ccafffff",
        "type": "hybridAzureADJoin"
      }
    ],
    "enableSingleSignOn": true,
    "gracePeriodInHours": 2,
    "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",
    "imageDisplayName": "myCustomImage",
    "imageId": "d4e0541a-f7bb-4bdf-ad8f-b92b915a229f",
    "imageType": "custom",
    "localAdminEnabled": true,
    "managedBy": "windows365",
    "windowsSetting": {
        "locale": "en-US"
    },
    "provisioningType": "dedicated",
    "userSettingsPersistenceConfiguration": {
        "userSettingsPersistenceEnabled": false,
        "userSettingsPersistenceStorageSizeCategory": "fourGB"
    }
}