Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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.
Representa uma área de trabalho virtual gerenciada na nuvem. Este PC na nuvem também é registrado no Intune e gerenciado por meio do portal do Microsoft Endpoint Manager, portanto, o PC na nuvem também tem uma ID de dispositivo gerenciada pelo Intune correspondente.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Listar cloudPCs | coleção cloudPC | Listar as propriedades e as relações dos objetos do PC na nuvem. |
| Obter cloudPC | em nuvem | Leia as propriedades e as relações de um objeto do PC na nuvem. |
| Obter PCs na nuvem provisionados | coleção cloudPC | Obtenha todos os PCs na nuvem provisionados de um plano de serviço específico para usuários em um grupo de usuários do Microsoft Entra. |
| Alterar o tipo de conta de usuário | Nenhum | Altere o tipo de conta do usuário em um PC na nuvem específico. |
| Fim do período de carência | Nenhum | Encerrar o período de cortesia para um objeto do PC na nuvem. |
| Ligar | Nenhum | Ligue um objeto específico do PC na Nuvem da Linha de Frente do Windows. Esta ação dá suporte a cenários de administração de MEM. |
| Desligar | Nenhum | Desligue um objeto específico do PC na Nuvem do Windows Frontline. Esta ação dá suporte a cenários de administração de MEM. |
| Reiniciar | Nenhum | Reinicie um objeto específico do PC na nuvem. |
| Rename | Nenhum | Renomeie um objeto específico do PC na nuvem. Use essa API para atualizar o displayName da entidade do Cloud PC. |
| Reprovisionar | Nenhum | Reprovisionar um objeto de PC na nuvem. |
| Resize | Nenhum | Atualize ou faça downgrade de um PC na nuvem existente para uma configuração com uma nova CPU virtual (vCPU) e tamanho de armazenamento. |
| Start | Nenhum | Inicie um PC na nuvem específico. Atualmente, há suporte apenas para PCs na nuvem da linha de frente do Windows 365. |
| Stop | Nenhum | Pare uma nuvem específica. Atualmente, há suporte apenas para PCs na nuvem da linha de frente do Windows 365. |
| Solução de problemas | Nenhum | Solucionar problemas de um objeto específico do PC na nuvem. Use essa API para marcar o status de integridade do PC na nuvem e do host da sessão. |
| Restaurar | Nenhum | Restaurar um objeto do PC na nuvem para um estado anterior a partir de um snapshot. |
| Definir o status da revisão | Nenhum | Defina o status de revisão de um dispositivo Cloud PC específico usando a ID do Cloud PC. |
| Recuperar o status da revisão | cloudPcReviewStatus | Obtenha o status de revisão de um PC na nuvem. |
| Recuperar a contagem de PCs na nuvem por status | Coleção cloudPcStatusSummary | Recupere a contagem de PCs na nuvem agrupada por status. |
| Lista para usuário | coleção cloudPC | Liste os dispositivos Cloud PC atribuídos ao usuário conectado. |
| Recuperar detalhes de inicialização | cloudPcLaunchDetail | Obter o cloudPcLaunchDetail para um PC na nuvem específico que pertence ao usuário conectado atual. |
| Obter histórico de conectividade | Coleção cloudPcConnectivityEvent | Obtenha o histórico de conectividade do PC na nuvem. |
| Obter ações remotas com suporte | cloudPcRemoteActionCapability | Obtenha uma lista de ações remotas do Cloud PC com suporte para um dispositivo Cloud PC específico, incluindo os nomes das ações e os recursos. |
| Recuperar resultados de ação remota | Coleção cloudPcRemoteActionResult | Recupere os resultados da ação remota e marcar o status de uma ação remota específica executada no dispositivo Cloud PC associado. |
| Tente novamente a instalação do agente parceiro | Nenhum | Tente novamente a instalação para os agentes parceiros que falharam ao instalar no PC na nuvem. |
| Validar redimensionamento em massa | Coleção cloudPcResizeValidateResult | Valide se um conjunto de dispositivos PC na nuvem atende aos requisitos para ser redimensionado em massa. |
| Criar snapshot | Nenhum | Crie um snapshot para um dispositivo Cloud PC específico. |
| Recuperar instantâneos | Coleção cloudPcSnapshot | Obtenha uma lista de recursos cloudPcSnapshot para um PC na nuvem. |
| Compartilhar snapshot | Nenhum | Compartilhe um snapshot de um dispositivo Cloud PC específico. |
| Obter estado de acesso de linha de frente | frontlineCloudPcAccessState | Obtenha o estado de acesso do PC na nuvem da linha de frente. Os valores possíveis são unassigned, noLicensesAvailable, activationFailed, active, activating, standbyMode, unknownFutureValue. O noLicensesAvailable membro foi preterido e parou de retornar em 30 de setembro de 2024. |
| Obter informações de inicialização (preterido) | cloudPcLaunchInfo | Obter o cloudPCLaunchInfo para um PC na nuvem específico que pertence ao usuário conectado atual. Essa API foi preterida e deixará de retornar dados em 30 de outubro de 2026. No futuro, use a API Recuperar detalhes de inicialização . |
| Recuperar detalhes do PC na nuvem da linha de frente | frontlineCloudPcDetail | Obter o frontlineCloudPcDetail de um PC na nuvem da linha de frente. |
| Disparar uma ação de organização do PC na nuvem | cloudPcOrganizationActionDetail | Dispare uma ação de organização do PC na nuvem. |
| Recuperar um detalhe da ação da organização do PC na nuvem | cloudPcOrganizationActionDetail | Recupere os detalhes de um cloudPcOrganizationActionDetail. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| aadDeviceId | Cadeia de caracteres | A ID do dispositivo Microsoft Entra do PC na nuvem. |
| Nome de Exibição de Lote | Cadeia de caracteres | O nome da alocação divide as licenças de locatário em lotes ou grupos menores que ajudam a restringir o número de licenças disponíveis para uso em uma atribuição específica. Quando o provisioningType é dedicated, o nome da alocação é null. Somente leitura. |
| resultado de conectividade | cloudPcConnectivityResult | A integridade da conectividade marcar resultado de um PC na nuvem, incluindo o carimbo de data/hora atualizado e se o PC na nuvem pode ser conectado. |
| deviceRegionName | Cadeia de caracteres | O nome da região geográfica na qual o PC na nuvem está provisionado no momento. Por exemplo, westus3, eastus2, e southeastasia. Somente leitura. |
| disasterRecoveryCapability | cloudPcDisasterRecoveryCapability | O status de recuperação de desastre do PC na nuvem, incluindo a região primária, a região secundária e o tipo de funcionalidade. O valor padrão é null que indica que a configuração de recuperação de desastre está desabilitada. Para receber uma resposta com a propriedade $selectdisasterRecoveryCapability e $filter por disasterRecoveryCapability/{subProperty} na URL de solicitação. Para obter mais informações, consulte Exemplo 3: Listar PCs na nuvem filtrados por tipo de funcionalidade de recuperação de desastre. Somente leitura. |
| diskEncryptionState | cloudPcDiskEncryptionState | A criptografia de disco aplicada ao PC na nuvem. Valores possíveis: notAvailable, notEncrypted, encryptedUsingPlatformManagedKey, encryptedUsingCustomerManagedKey e unknownFutureValue. |
| displayName | Cadeia de caracteres | O nome de exibição do PC na nuvem. |
| gracePeriodEndDateTime | DateTimeOffset | A data e a hora em que o período de cortesia termina e o reprovisionamento ou desprovisionamento ocorre. Obrigatório somente se o status for inGracePeriod. O carimbo de data/hora é mostrado no formato ISO 8601 e UTC (Tempo Universal Coordenado). Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. |
| groupDetail | cloudPcEntraGroupDetail | Os detalhes do grupo do Microsoft Entra (por exemplo, ID e nome de exibição) do grupo do Entra ID associado à atribuição do Reserve Cloud PC do usuário. Somente leitura. |
| id | Cadeia de caracteres | O identificador exclusivo do PC na nuvem. Somente leitura. |
| imageDisplayName | Cadeia de caracteres | Nome da imagem do sistema operacional que está no PC na nuvem. |
| lastLoginResult | cloudPcLoginResult | O último resultado de logon do PC na nuvem. Por exemplo, { "time": "2014-01-01T00:00:00Z"}. |
| lastLogoffDateTime | DateTimeOffset | A data e a hora em que o usuário fez logoff pela última vez na sessão do PC na nuvem. Retorna null se o usuário nunca estabeleceu uma sessão ou se uma sessão está ativa no momento. O carimbo de data/hora é mostrado no formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Somente leitura. Retornado somente quando selecionado explicitamente com $select. |
| lastModifiedDateTime | DateTimeOffset | A data e hora da última modificação do PC na nuvem. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. |
| lastRemoteActionResult | cloudPcRemoteActionResult | O resultado da última ação remota dos PCs na nuvem corporativos. As ações remotas com suporte são: Reboot, Rename, Reprovision, Restore, Troubleshoot. |
| managedDeviceId | Cadeia de caracteres | A ID do dispositivo do Intune do PC na nuvem. |
| managedDeviceName | Cadeia de caracteres | O nome do dispositivo do Intune do PC na nuvem. |
| onPremisesConnectionName | Cadeia de caracteres | A conexão de rede do Azure aplicada durante o provisionamento de PCs na nuvem. |
| osVersion | cloudPcOperatingSystem | A versão do sistema operacional (SO) a ser provisionado em PCs na nuvem. Os valores possíveis são: windows10, windows11, unknownFutureValue. |
| partnerAgentInstallResults | cloudPcPartnerAgentInstallResult collection | Os resultados do status de instalação de cada agente parceiro no Cloud PC. |
| powerState | cloudPcPowerState | O estado de energia de um PC na nuvem. Os valores possíveis são: running, poweredOff, unknown. Esta propriedade só dá suporte a PCs na nuvem de trabalho por turnos. |
| productType | cloudPcProductType | O tipo de produto do PC na nuvem. Os valores possíveis são: enterprise, frontline, devBox, powerAutomate, business, unknownFutureValue. Para obter os planos de serviço e preços disponíveis para enterprise, frontlinee business, consulte Windows 365 para empresas. Para obter informações sobre preços para devBox, consulte Preços do Microsoft Dev Box. Para obter os planos e preços disponíveis para powerAutomate, consulte Preços do Power Automate. O valor padrão é enterprise. Oferece suporte para $filter e $select. Para obter mais informações, consulte Exemplo 4: Lista de PCs na nuvem filtrados por tipo de produto. Somente leitura. |
| provisionedDateTime | DateTimeOffset | A data e hora provisionadas mais recentes, geradas e atribuídas automaticamente durante o provisionamento inicial ou qualquer reprovisionamento subsequente do PC na nuvem. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. |
| provisioningPolicyId | Cadeia de caracteres | A ID da política de provisionamento do PC na nuvem. |
| provisioningPolicyName | Cadeia de caracteres | A política de provisionamento aplicada durante o provisionamento de PCs na nuvem. |
| provisioningType | cloudPcProvisioningType | O tipo de licenças a serem usadas ao provisionar PCs na nuvem usando essa política. Os valores possíveis são: dedicated, shared, unknownFutureValue, sharedByUser, sharedByEntraGroup, reserve. Use o Prefer: include-unknown-enum-members cabeçalho da solicitação para obter os seguintes valores dessa enumeração evolutiva: sharedByUser, sharedByEntraGroup, reserve. O valor padrão é dedicated. O shared membro foi preterido e deixará de retornar em 30 de abril de 2027. No futuro, use o sharedByUser membro. |
| scopeIds | String collection | As IDs de escopo da permissão correspondente. Atualmente, é a ID da marca de escopo do Intune. Somente leitura. |
| servicePlanId | Cadeia de caracteres | A ID do plano de serviço do PC na nuvem. |
| servicePlanName | Cadeia de caracteres | O nome do plano de serviço do PC na nuvem. |
| servicePlanType | cloudPcServicePlanType | O tipo de plano de serviço do PC na nuvem. |
| sharedDeviceDetail | cloudPcFrontlineSharedDeviceDetail | Indica os detalhes do dispositivo do PC na nuvem associado ao plano de serviço compartilhado da linha de frente, incluindo o UPN do usuário e a data e hora de início da sessão. |
| status | cloudPcStatus | O status do PC na nuvem. Os valores possíveis são: notProvisioned, provisioning, provisioned, inGracePerioddeprovisioningfailedprovisionedWithWarningsresizingrestoringpendingProvisionunknownFutureValuemovingRegionresizePendingLicensemodifyingSingleSignOnrefreshPolicyConfigurationpreparing Use o Prefer: include-unknown-enum-members cabeçalho da solicitação para obter os seguintes valores dessa enumeração evolutiva: movingRegion, resizePendingLicense, modifyingSingleSignOn, refreshPolicyConfiguration, e preparing. |
| statusDetail | cloudPcStatusDetail | Indica o status detalhado associado ao PC na nuvem, incluindo código de erro/aviso, mensagem de erro/aviso, additionalInformation. Por exemplo, { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. |
| connectionSetting | cloudPcConnectionSetting | A configuração de conexão do PC na nuvem. Valores possíveis: enableSingleSignOn. Somente leitura. |
| userAccountType | cloudPcUserAccountType | O tipo de conta do usuário em PCs na nuvem provisionados. Os valores possíveis são: standardUser, administrator, unknownFutureValue. |
| userExperienceType | cloudPcUserExperienceType | Especifica o tipo de objeto de nuvem que o usuário final pode acessar. Os valores possíveis são: cloudPc, cloudApp, unknownFutureValue. Quando definido como cloudPc, indica que o usuário final pode acessar toda a área de trabalho. Quando definido como cloudApp, indica que o usuário final só pode acessar aplicativos na nuvem publicados na política de provisionamento associada. Como a experiência do aplicativo na nuvem também cria dispositivos do PC na nuvem que aparecem na lista de dispositivos do PC na nuvem, essa propriedade ajuda a diferenciá-los. O valor padrão é cloudPc. Essa propriedade é definida na política de provisionamento. |
| userDetail | cloudPcEntraUserDetail | Os detalhes do usuário (por exemplo, ID e nome de exibição) do usuário associado a uma atribuição do Reserve Cloud PC. Somente leitura. |
| userPrincipalName | Cadeia de caracteres | O nome UPN do usuário atribuído ao PC na nuvem. |
| connectionSettings (preterido) | cloudPcConnectionSettings | As configurações de conexão do PC na nuvem. Valores possíveis: enableSingleSignOn. Somente leitura. Esta propriedade foi preterida e parou de reajustar os dados em 31 de agosto de 2024. No futuro, use a propriedade connectionSetting . |
| frontlineCloudPcAvailability (preterido) | frontlineCloudPcAvailability | A disponibilidade atual de um PC na nuvem atribuído à linha de frente. Valores possíveis: notApplicable, available, notAvailablee unknownFutureValue. O valor padrão é notApplicable. Somente leitura. Esta propriedade foi preterida e deixará de retornar dados em 30 de outubro de 2025. No futuro, use a API retrieveFrontlineCloudPcDetail . |
| statusDetails (preterido) | cloudPcStatusDetails | Os detalhes do status do PC na nuvem. Por exemplo, { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. Esta propriedade foi preterida e não terá mais suporte a partir de 31 de agosto de 2024. Em vez disso, use statusDetail. |
valores de cloudPcDiskEncryptionState
| Member | Descrição |
|---|---|
| notAvailable | O PC na nuvem não está provisionado ou está em um estado em que a criptografia não está disponível. |
| notEncrypted | O PC na nuvem deve ser criptografado, mas a criptografia ainda não foi feita (reservado, não deve acontecer). |
| encryptedUsingPlatformManagedKey | O PC na nuvem é criptografado usando uma chave gerenciada pela plataforma. Esse membro será o valor padrão se a chave gerenciada pelo cliente não estiver habilitada. |
| encryptedUsingCustomerManagedKey | O PC na nuvem é criptografado usando a chave gerenciada pelo cliente. |
| unknownFutureValue | Valor sentinela de enumeração evolutiva. Não usar. |
Valores de cloudPcPowerState
| Member | Descrição |
|---|---|
| em execução | O status do PC na nuvem está em execução. |
| desligado | O status do PC na nuvem é desligado. |
| desconhecido | O status do PC na nuvem é desconhecido. |
valores de cloudPcStatus
A tabela a seguir lista os membros de uma enumeração evolutiva. Você deve usar o cabeçalho da Prefer: include-unknown-enum-members solicitação para obter os seguintes valores nesta enumeração evolutiva: movingRegion, resizePendingLicense, modifyingSingleSignOn, preparing.
| Member | Descrição |
|---|---|
| notProvisioned | O PC na nuvem ainda não foi provisionado. |
| de provisionamento | O provisionamento do PC na nuvem está em andamento. |
| provisionado | O PC na nuvem é provisionado e os usuários podem acessá-lo. |
| inGracePeriod | O PC na nuvem está no período de carência de uma semana antes da desprovisionamento. |
| Desprovisionamento | O PC na nuvem está sendo desprovisionado. |
| com falha | A operação no PC na nuvem falhou. |
| provisionedWithWarnings | O PC na nuvem é provisionado e os usuários finais podem acessá-lo com alguns avisos. O usuário pode continuar a usar este PC na nuvem. |
| Redimensionar | O PC na nuvem está sendo redimensionado. |
| pendingProvision | O provisionamento está pendente no PC na nuvem. Nesse caso, o número de PCs na nuvem no período de cortesia é maior do que o número total de licenças disponíveis. |
| restaurando | O PC na nuvem está sendo restaurado. |
| unknownFutureValue | Valor sentinela de enumeração evolutiva. Não usar. |
| movingRegion | Indica que o PC na nuvem está sendo movido de uma região para outra. |
| resizePendingLicense | Indica que o processo de redimensionamento do PC na nuvem foi iniciado, mas não pode ser concluído porque a licença de destino não foi identificada. No momento, ele está aguardando uma ação do cliente para resolver o problema de licenciamento. |
| modifyingSingleSignOn | Indica que o PC na nuvem está atualizando a configuração de logon único. |
| refreshPolicyConfiguration | Indica que o PC na nuvem está atualizando as novas configurações de política. |
| Em preparação | Indica que o PC na nuvem está se preparando com a configuração definida pelo administrador de TI (Aplicativos, Configuração e Segurança), aparece após o status de provisionamento. Aplica-se apenas a dispositivos compartilhados da linha de frente. |
valores frontlineCloudPcAccessState
| Member | Descrição |
|---|---|
| não atribuído | Defina como não atribuído se o PC na nuvem não consumir licenças de uso compartilhado. O valor padrão é unassigned. |
| noLicensesAvailable (preterido) | Indica que todas as licenças de uso compartilhado estão em uso. O noLicensesAvailable membro foi preterido e deixará de retornar em 30 de setembro de 2024. |
| activationFailed | Indica que a ativação do PC na nuvem de linha de frente falhou depois que o usuário solicitou um PC na nuvem de linha de frente. |
| Ativo | Indica que o PC na nuvem de linha de frente está em um estado ativo com uma licença de uso compartilhado atribuída e o usuário pode se conectar ao PC na nuvem. |
| ativando | Indica que um usuário solicitou a conexão ao PC na nuvem e o serviço está sendo iniciado. |
| modo de espera | Indica que o PC na nuvem de linha de frente está em um estado de espera antes de ser desligado e desalocado. Um PC na nuvem de linha de frente em estado de espera ainda pode ser acessado pelo usuário. |
| unknownFutureValue | Valor sentinela de enumeração evolutiva. Não usar. |
valores de cloudPcProductType
| Member | Descrição |
|---|---|
| Enterprise | Padrão. Indica o tipo de produto PC na nuvem para empresas maiores que desejam implantar PCs na nuvem em sua organização para um número ilimitado de usuários. |
| linha de frente | Indica o tipo de produto PC na nuvem para funcionários da linha de frente e meio período compartilharem dispositivos, permitindo que eles usem PCs na nuvem durante seus turnos. |
| devBox | Indica o tipo de produto PC na nuvem pré-configurado com ferramentas, serviços e recursos para desenvolvedores, equipes de desenvolvimento e profissionais de TI. |
| powerAutomate | Indica o tipo de produto PC na nuvem para os clientes do Power Automate executarem RPAs (automação de processos robóticos) assistidos e não assistidos em seus PCs na nuvem. |
| a agilidade | Indica o tipo de produto PC na nuvem para clientes de pequenas empresas com até 300 usuários. |
| unknownFutureValue | Valor sentinela de enumeração evolutiva. Não usar. |
Relações
Nenhum
Representação JSON
A representação JSON a seguir mostra o tipo de recurso.
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "String",
"allotmentDisplayName": "String",
"connectivityResult": {"@odata.type": "microsoft.graph.cloudPcConnectivityResult"},
"connectionSetting": {"@odata.type": "microsoft.graph.cloudPcConnectionSetting"},
"connectionSettings": {"@odata.type": "microsoft.graph.cloudPcConnectionSettings"},
"deviceRegionName": "String",
"disasterRecoveryCapability": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryCapability"},
"diskEncryptionState": "String",
"displayName": "String",
"gracePeriodEndDateTime": "String (timestamp)",
"groupDetail": {"@odata.type": "microsoft.graph.cloudPcEntraGroupDetail"},
"id": "String (identifier)",
"imageDisplayName": "String",
"lastLoginResult": {"@odata.type": "microsoft.graph.cloudPcLoginResult"},
"lastLogoffDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"lastRemoteActionResult": {"@odata.type": "microsoft.graph.cloudPcRemoteActionResult"},
"managedDeviceId": "String",
"managedDeviceName": "String",
"onPremisesConnectionName": "String",
"osVersion": "String",
"partnerAgentInstallResults": [{"@odata.type": "microsoft.graph.cloudPcPartnerAgentInstallResult"}],
"powerState": "String",
"productType": "String",
"provisionedDateTime": "String (timestamp)",
"provisioningPolicyId": "String",
"provisioningPolicyName": "String",
"provisioningType": "String",
"servicePlanId": "String",
"servicePlanName": "String",
"servicePlanType": "String",
"scopeIds": ["String"],
"sharedDeviceDetail": {"@odata.type": "microsoft.graph.cloudPcFrontlineSharedDeviceDetail"},
"status": "String",
"statusDetail": {"@odata.type": "microsoft.graph.cloudPcStatusDetail"},
"userAccountType": "String",
"userExperienceType": "String",
"userDetail": {"@odata.type": "microsoft.graph.cloudPcEntraUserDetail"},
"userPrincipalName": "String"
}