Get cloudPcProvisioningPolicy

Namespace: microsoft.graph

Read the properties and relationships of a cloudPcProvisioningPolicy object.

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

GET /deviceManagement/virtualEndpoint/provisioningPolicies/{id}

Optional query parameters

This method supports the $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

The following example shows how to get the properties of the specified provisioning policy.

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff

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",
  "displayName": "HR provisioning policy",
  "description": "Provisioning policy for India HR employees",
  "domainJoinConfigurations": [
    {
      "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
      "domainJoinType": "hybridAzureADJoin"
    },
    {
      "onPremisesConnectionId": "26e16c71-f210-438b-88ac-d481ccafffff",
      "domainJoinType": "hybridAzureADJoin"
    }
  ],
  "enableSingleSignOn": true,
  "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",
  "imageDisplayName": "Image for India HR employees",
  "imageId": "6d1e37b1-dc44-42fb-9fa3-3f524832d987",
  "imageType": "custom",
  "windowsSetting": {
    "locale": "en-US"
  },
  "provisioningType": "dedicated"
}

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

The following example shows how to get the properties of the specified provisioning policy and expand on the assignments.

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff?$expand=assignments

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",
  "displayName": "HR provisioning policy",
  "description": "Provisioning policy for India HR employees",
  "domainJoinConfigurations": [
    {
      "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
      "domainJoinType": "hybridAzureADJoin"
    },
    {
      "onPremisesConnectionId": "26e16c71-f210-438b-88ac-d481ccafffff",
      "domainJoinType": "hybridAzureADJoin"
    }
  ],
  "enableSingleSignOn": true,
  "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",
  "imageDisplayName": "IndiaHRImage",
  "imageId": "6d1e37b1-dc44-42fb-9fa3-3f524832d987",
  "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"
      }
    }
  ],
  "provisioningType": "dedicated"
}

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.

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

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": "WestUSEmployeesCloudPcGroup",
  "description": "The ProvisioningPolicy for West US employees.",
  "displayName": "WestUsPolicy",
  "domainJoinConfigurations": [
    {
      "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
      "domainJoinType": "hybridAzureADJoin"
    },
    {
      "onPremisesConnectionId": "26e16c71-f210-438b-88ac-d481ccafffff",
      "domainJoinType": "hybridAzureADJoin"
    }
  ],
  "enableSingleSignOn": true,
  "gracePeriodInHours": 2,
  "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",
  "imageDisplayName": "WestUSEmployeesCustomImage",
  "imageId": "d4e0541a-f7bb-4bdf-ad8f-b92b915a229f",
  "imageType": "custom",
  "localAdminEnabled": true,
  "windowsSetting": {
    "locale": "en-US"
  },
  "provisioningType": "dedicated"
}