Share via

Get-MgBetaDeviceManagementVirtualEndpointCloudPcFrontlineCloudPcAccessState

  • Reference
Module:
Microsoft.Graph.Beta.DeviceManagement.Functions

Get the frontlineCloudPcAccessState of a frontline Cloud PC. This API only supports shared-use licenses. For more information, see cloudPcProvisioningPolicy. Shared-use licenses allow three users per license, with one user signed in at a time. Callers can get the latest frontline Cloud PC accessState and determine whether the frontline Cloud PC is accessible to a user. If a web client needs to connect to a frontline Cloud PC, the sharedCloudPcAccessState validates the bookmark scenario. If sharedCloudPcAccessState isn't active/activating/standbyMode, the web client shows a bad bookmark.

Syntax

Get-MgBetaDeviceManagementVirtualEndpointCloudPcFrontlineCloudPcAccessState
   -CloudPcId <String>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgBetaDeviceManagementVirtualEndpointCloudPcFrontlineCloudPcAccessState
   -InputObject <IDeviceManagementFunctionsIdentity>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get the frontlineCloudPcAccessState of a frontline Cloud PC. This API only supports shared-use licenses. For more information, see cloudPcProvisioningPolicy. Shared-use licenses allow three users per license, with one user signed in at a time. Callers can get the latest frontline Cloud PC accessState and determine whether the frontline Cloud PC is accessible to a user. If a web client needs to connect to a frontline Cloud PC, the sharedCloudPcAccessState validates the bookmark scenario. If sharedCloudPcAccessState isn't active/activating/standbyMode, the web client shows a bad bookmark.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application CloudPC.ReadWrite.All Not available.

Examples

Example 1: Get the frontline Cloud PC access state for the administrator

Import-Module Microsoft.Graph.Beta.DeviceManagement.Functions

Get-MgBetaDeviceManagementVirtualEndpointCloudPcFrontlineCloudPcAccessState -CloudPCId $cloudPCId

This example will get the frontline cloud pc access state for the administrator

Parameters

-CloudPcId

The unique identifier of cloudPC

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IDeviceManagementFunctionsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IDeviceManagementFunctionsIdentity

System.Collections.IDictionary

Outputs

System.String

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IDeviceManagementFunctionsIdentity>: Identity Parameter

  • [Category <String>]: Usage: category='{category}'
  • [CloudPcId <String>]: The unique identifier of cloudPC
  • [DepOnboardingSettingId <String>]: The unique identifier of depOnboardingSetting
  • [DeviceAndAppManagementAssignmentFilterId <String>]: The unique identifier of deviceAndAppManagementAssignmentFilter
  • [DeviceConfigurationId <String>]: The unique identifier of deviceConfiguration
  • [DeviceHealthScriptId <String>]: The unique identifier of deviceHealthScript
  • [DeviceManagementConfigurationPolicyId <String>]: The unique identifier of deviceManagementConfigurationPolicy
  • [DeviceManagementIntentId <String>]: The unique identifier of deviceManagementIntent
  • [DeviceManagementReusablePolicySettingId <String>]: The unique identifier of deviceManagementReusablePolicySetting
  • [DeviceManagementTemplateId <String>]: The unique identifier of deviceManagementTemplate
  • [DeviceManagementTemplateId1 <String>]: The unique identifier of deviceManagementTemplate
  • [DomainName <String>]: Usage: domainName='{domainName}'
  • [EnrollmentProfileId <String>]: The unique identifier of enrollmentProfile
  • [EnrollmentType <String>]: Usage: enrollmentType='{enrollmentType}'
  • [ExpiringBeforeDateTime <String>]: Usage: expiringBeforeDateTime='{expiringBeforeDateTime}'
  • [GroupId <String>]: Usage: groupId='{groupId}'
  • [Id <String>]: Usage: id='{id}'
  • [Ids <String- []>]: Usage: ids={ids}
  • [ManagedDeviceId <String>]: The unique identifier of managedDevice
  • [ManagedDeviceWindowsOperatingSystemImageId <String>]: The unique identifier of managedDeviceWindowsOperatingSystemImage
  • [Platform <DevicePlatformType?>]: Usage: platform='{platform}'
  • [PolicyId <String>]: Usage: policyId='{policyId}'
  • [Resource <String>]: Usage: resource='{resource}'
  • [ResourceOperationId <String>]: The unique identifier of resourceOperation
  • [Scope <String>]: Usage: scope='{scope}'
  • [SecretReferenceValueId <String>]: Usage: secretReferenceValueId='{secretReferenceValueId}'
  • [ServicePlanId <String>]: Usage: servicePlanId='{servicePlanId}'
  • [SubscriptionId <String>]: Usage: subscriptionId='{subscriptionId}'
  • [SummarizeBy <UserExperienceAnalyticsSummarizedBy?>]: Usage: summarizeBy='{summarizeBy}'
  • [TemplateId <String>]: Usage: templateId='{templateId}'
  • [Upn <String>]: Usage: upn='{upn}'
  • [Userid <String>]: Usage: userid='{userid}'