Listar cloudPCs

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Liste os dispositivos cloudPC em um locatário.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) CloudPC.Read.All CloudPC.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application CloudPC.Read.All CloudPC.ReadWrite.All

Solicitação HTTP

GET /deviceManagement/virtualEndpoint/cloudPCs

Parâmetros de consulta opcionais

Esse método dá suporte a $selectparâmetros de consulta , $filter, $counte $top OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos cloudPC no corpo da resposta.

Exemplos

Exemplo 1: Listar todos os dispositivos cloudPC em um locatário

O exemplo a seguir mostra como obter uma lista de todos os dispositivos cloudPC em um locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.cloudPC",
      "aadDeviceId": "f5ff445f-7488-40f8-8ab9-ee784a9c1f33",
      "id": "662009bc-7732-4f6f-8726-25883518ffff",
      "displayName": "Demo-1",
      "imageDisplayName": "Windows-10 19h1-evd",
      "managedDeviceId": "bdc8e6dd-0455-4412-83d9-c818664fffff",
      "managedDeviceName": "A00002GI001",
      "provisioningPolicyId": "7ed725ad-0a00-4117-b557-d965c373ffff",
      "provisioningPolicyName": "HR provisioning policy",
      "onPremisesConnectionName": "Azure network connection for HR",
      "servicePlanId": "dbb9148c-ff83-4a4c-8d7f-28752e93ffff",
      "servicePlanName": "lite",
      "servicePlanType": "enterprise",
      "status": "provisioned",
      "userPrincipalName": "dujanjic@contoso.com",
      "lastModifiedDateTime": "2020-11-03T10:29:57Z",
      "statusDetails": null,
      "gracePeriodEndDateTime": "2020-11-010T20:00:34Z",
      "provisioningType": "dedicated",
      "deviceRegionName": "eastus2",
      "diskEncryptionState": "encryptedUsingPlatformManagedKey"
    }
  ]
}

Exemplo 2: obter os dois principais dispositivos cloudPC em um locatário

O exemplo a seguir mostra como usar o $top parâmetro de consulta para obter os dois principais dispositivos cloudPC em um locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs?$top=2

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
    "@odata.context": "https://graph.microsoft.com/testprodbeta_cpc_int/$metadata#deviceManagement/virtualEndpoint/cloudPCs",
    "@odata.count": 200,
    "@odata.nextLink": "https://graph.microsoft.com/testprodbeta_cpc_int/deviceManagement/virtualEndpoint/cloudPCs?$top=2&$skiptoken=7d4e1527-fe5a-4d86-81eb-2c532ac567ce",
    "value": [
        {
            "id": "fd0230cd-4e05-4ecd-ad05-72f8a30042f1",
            "displayName": "RMS-Resize-policy - RMS-Resize-user-05",
            "imageDisplayName": "Windows 11 Enterprise + Microsoft 365 Apps 22H2",
            "provisioningPolicyId": "7f247338-3d25-4bcf-11a0-fe6fba68f41c",
            "provisioningPolicyName": "RMS-Resize-policy",
            "onPremisesConnectionName": "",
            "servicePlanId": "23a25099-1b2f-4e07-84bd-b81606109438",
            "servicePlanName": "Cloud PC Enterprise 2vCPU/4GB/64GB",
            "status": "failed",
            "userPrincipalName": "RMS-Resize-user-05@contoso.com",
            "lastModifiedDateTime": "2023-04-25T06:24:02Z",
            "managedDeviceId": null,
            "managedDeviceName": null,
            "aadDeviceId": null,
            "gracePeriodEndDateTime": null,
            "servicePlanType": "enterprise",
            "diskEncryptionState": "notAvailable",
            "provisioningType": "dedicated",
            "deviceRegionName": "eastus2",
            "statusDetails": {
                "code": "intuneEnrollFailed",
                "message": "We can’t complete MEM enrollment of this Cloud PC. Check MEM policy settings and retry. If that doesn’t work, contact Customer support.",
                "additionalInformation": [
                    {
                        "name": "retriable",
                        "value": "true"
                    },
                    {
                        "name": "failedAction",
                        "value": "Provision"
                    },
                    {
                        "name": "rawError",
                        "value": "Run Intune enrollment extension failed."
                    }
                ]
            },
            "partnerAgentInstallResults": []
        },
        {
            "id": "69621742-aad4-4976-990c-d10ff6d73fc1",
            "displayName": "TestSweden - Akhilesh Khare",
            "imageDisplayName": "TestSweden",
            "provisioningPolicyId": "5865dd09-797d-4885-85ab-bb96594b5f1b",
            "provisioningPolicyName": "TestSweden",
            "onPremisesConnectionName": "TestSweden",
            "servicePlanId": "0e837228-8250-4047-8a80-d4a34ba11618",
            "servicePlanName": "Cloud PC Enterprise 8vCPU/32GB/512GB",
            "status": "failed",
            "userPrincipalName": "akhkhare_contoso.com#EXT#@contoso.com",
            "lastModifiedDateTime": "2023-04-25T06:12:10Z",
            "managedDeviceId": null,
            "managedDeviceName": null,
            "aadDeviceId": null,
            "gracePeriodEndDateTime": null,
            "servicePlanType": "enterprise",
            "diskEncryptionState": "notAvailable",
            "provisioningType": "dedicated",
            "deviceRegionName": "eastus2",
            "statusDetails": {
                "code": "intuneEnrollFailed",
                "message": "We can’t complete MEM enrollment of this Cloud PC. Check MEM policy settings and retry. If that doesn’t work, contact Customer support.",
                "additionalInformation": [
                    {
                        "name": "retriable",
                        "value": "true"
                    },
                    {
                        "name": "failedAction",
                        "value": "Provision"
                    },
                    {
                        "name": "rawError",
                        "value": "Run Intune enrollment extension failed."
                    }
                ]
            },
            "partnerAgentInstallResults": []
        }
    ]
}

Exemplo 3: Listar PCs na Nuvem filtrados por tipo de funcionalidade de recuperação de desastre

O exemplo a seguir mostra como listar PCs na nuvem filtrados por tipo de funcionalidade de recuperação de desastre e selecionar parâmetros específicos.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs?$select=id,displayName,disasterRecoveryCapability&$filter=disasterRecoveryCapability/capabilityType eq 'failover'

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/cloudPCs(id,displayName,disasterRecoveryCapability)",
  "value": [
    {
      "id": "662009bc-7732-4f6f-8726-25883518b33e",
      "displayName": "Demo-0",
      "disasterRecoveryCapability": {
        "primaryRegion": "eastus",
        "secondaryRegion": "westus",
        "capabilityType": "failover"
      }
    },
    {
      "id": "ac74ae8b-85f7-4272-88cc-5419267403ed",
      "displayName": "Demo-1",
      "disasterRecoveryCapability": {
        "primaryRegion": "eastus",
        "secondaryRegion": "westus",
        "capabilityType": "failover"
      }
    }
  ]
}

Exemplo 4: Lista de PCs na Nuvem filtrados por tipo de produto

O exemplo a seguir mostra como listar PCs na nuvem filtrados por tipo de produto e selecionar parâmetros específicos.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs?$select=id,displayName,productType&$filter=productType eq 'enterprise'

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/cloudPCs(id,displayName,productType)",
  "value": [
    {
      "id": "662009bc-7732-4f6f-8726-25883518b33e",
      "displayName": "Demo-0",
      "productType": "enterprise"
    },
    {
      "id": "ac74ae8b-85f7-4272-88cc-5419267403ed",
      "displayName": "Demo-1",
      "productType": "enterprise"
    }
  ]
}