Update-MgBetaDevice
Update the properties of a device. Only certain properties of a device can be updated through approved Mobile Device Management (MDM) apps.
Note
To view the v1.0 release of this cmdlet, view Update-MgDevice
Syntax
Update-MgBetaDevice
-DeviceId <String>
[-ResponseHeadersVariable <String>]
[-AccountEnabled]
[-AdditionalProperties <Hashtable>]
[-AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId[]>]
[-ApproximateLastSignInDateTime <DateTime>]
[-Commands <IMicrosoftGraphCommand[]>]
[-ComplianceExpirationDateTime <DateTime>]
[-DeletedDateTime <DateTime>]
[-DeviceCategory <String>]
[-DeviceId1 <String>]
[-DeviceMetadata <String>]
[-DeviceOwnership <String>]
[-DeviceVersion <Int32>]
[-DisplayName <String>]
[-DomainName <String>]
[-EnrollmentProfileName <String>]
[-EnrollmentType <String>]
[-ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-Hostnames <String[]>]
[-Id <String>]
[-IsCompliant]
[-IsManaged]
[-IsManagementRestricted]
[-IsRooted]
[-Kind <String>]
[-ManagementType <String>]
[-Manufacturer <String>]
[-MdmAppId <String>]
[-MemberOf <IMicrosoftGraphDirectoryObject[]>]
[-Model <String>]
[-Name <String>]
[-OnPremisesLastSyncDateTime <DateTime>]
[-OnPremisesSecurityIdentifier <String>]
[-OnPremisesSyncEnabled]
[-OperatingSystem <String>]
[-OperatingSystemVersion <String>]
[-PhysicalIds <String[]>]
[-Platform <String>]
[-ProfileType <String>]
[-RegisteredOwners <IMicrosoftGraphDirectoryObject[]>]
[-RegisteredUsers <IMicrosoftGraphDirectoryObject[]>]
[-RegistrationDateTime <DateTime>]
[-Status <String>]
[-SystemLabels <String[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-TrustType <String>]
[-UsageRights <IMicrosoftGraphUsageRight[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaDevice
[-DeviceId <String>]
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <String>]
[-AccountEnabled]
[-AdditionalProperties <Hashtable>]
[-AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId[]>]
[-ApproximateLastSignInDateTime <DateTime>]
[-Commands <IMicrosoftGraphCommand[]>]
[-ComplianceExpirationDateTime <DateTime>]
[-DeletedDateTime <DateTime>]
[-DeviceCategory <String>]
[-DeviceMetadata <String>]
[-DeviceOwnership <String>]
[-DeviceVersion <Int32>]
[-DisplayName <String>]
[-DomainName <String>]
[-EnrollmentProfileName <String>]
[-EnrollmentType <String>]
[-ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-Hostnames <String[]>]
[-Id <String>]
[-IsCompliant]
[-IsManaged]
[-IsManagementRestricted]
[-IsRooted]
[-Kind <String>]
[-ManagementType <String>]
[-Manufacturer <String>]
[-MdmAppId <String>]
[-MemberOf <IMicrosoftGraphDirectoryObject[]>]
[-Model <String>]
[-Name <String>]
[-OnPremisesLastSyncDateTime <DateTime>]
[-OnPremisesSecurityIdentifier <String>]
[-OnPremisesSyncEnabled]
[-OperatingSystem <String>]
[-OperatingSystemVersion <String>]
[-PhysicalIds <String[]>]
[-Platform <String>]
[-ProfileType <String>]
[-RegisteredOwners <IMicrosoftGraphDirectoryObject[]>]
[-RegisteredUsers <IMicrosoftGraphDirectoryObject[]>]
[-RegistrationDateTime <DateTime>]
[-Status <String>]
[-SystemLabels <String[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-TrustType <String>]
[-UsageRights <IMicrosoftGraphUsageRight[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaDevice
-DeviceId <String>
-BodyParameter <IMicrosoftGraphDevice>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaDevice
-InputObject <IIdentityDirectoryManagementIdentity>
-BodyParameter <IMicrosoftGraphDevice>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the properties of a device. Only certain properties of a device can be updated through approved Mobile Device Management (MDM) apps.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Directory.AccessAsUser.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Device.ReadWrite.All | Directory.ReadWrite.All |
Examples
Example 1: Update the accountEnabled property of a device
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
accountEnabled = $false
}
Update-MgBetaDevice -DeviceId $deviceId -BodyParameter $params
This example will update the accountenabled property of a device
Example 2: Write extensionAttributes on a device
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
extensionAttributes = @{
extensionAttribute1 = "BYOD-Device"
}
}
Update-MgBetaDevice -DeviceId $deviceId -BodyParameter $params
This example will write extensionattributes on a device
Parameters
-AccountEnabled
true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AlternativeSecurityIds
For internal use only. Not nullable. Supports $filter (eq, not, ge, le). To construct, see NOTES section for ALTERNATIVESECURITYIDS properties and create a hash table.
Type: | IMicrosoftGraphAlternativeSecurityId[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ApproximateLastSignInDateTime
The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
device To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphDevice |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Commands
Set of commands sent to this device. To construct, see NOTES section for COMMANDS properties and create a hash table.
Type: | IMicrosoftGraphCommand[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComplianceExpirationDateTime
The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeletedDateTime
Date and time when this object was deleted. Always null when the object hasn't been deleted.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceCategory
User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceId
The unique identifier of device
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceId1
Unique Identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Also Supports $filter (eq, ne, not, startsWith).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceMetadata
For internal use only. Set to null.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceOwnership
Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceVersion
For internal use only.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayName
The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DomainName
The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnrollmentProfileName
Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnrollmentType
Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExtensionAttributes
onPremisesExtensionAttributes To construct, see NOTES section for EXTENSIONATTRIBUTES properties and create a hash table.
Type: | IMicrosoftGraphOnPremisesExtensionAttributes |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Extensions
The collection of open extensions defined for the device. Read-only. Nullable. To construct, see NOTES section for EXTENSIONS properties and create a hash table.
Type: | IMicrosoftGraphExtension[] |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-Hostnames
List of host names for the device.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IIdentityDirectoryManagementIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IsCompliant
true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsManaged
true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsManagementRestricted
Indicates whether the device is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsRooted
true if the device is rooted or jail-broken. This property can only be updated by Intune.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Kind
Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagementType
Management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Manufacturer
Manufacturer of the device. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MdmAppId
Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MemberOf
Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand. To construct, see NOTES section for MEMBEROF properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Model
Model of the device. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesLastSyncDateTime
The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesSecurityIdentifier
The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesSyncEnabled
true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OperatingSystem
The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OperatingSystemVersion
Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PhysicalIds
For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Platform
Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProfileType
The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-RegisteredOwners
The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand. To construct, see NOTES section for REGISTEREDOWNERS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RegisteredUsers
Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand. To construct, see NOTES section for REGISTEREDUSERS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RegistrationDateTime
Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
Type: | DateTime |
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 |
-Status
Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SystemLabels
List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TransitiveMemberOf
Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand. To construct, see NOTES section for TRANSITIVEMEMBEROF properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrustType
Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UsageRights
Represents the usage rights a device has been granted. To construct, see NOTES section for USAGERIGHTS properties and create a hash table.
Type: | IMicrosoftGraphUsageRight[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDevice
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDevice
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.
ALTERNATIVESECURITYIDS <IMicrosoftGraphAlternativeSecurityId- []
>: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
[IdentityProvider <String>]
: For internal use only.[Key <Byte-
[]>]
: For internal use only.[Type <Int32?>]
: For internal use only.
BODYPARAMETER <IMicrosoftGraphDevice>
: device
[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.[AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le).[IdentityProvider <String>]
: For internal use only.[Key <Byte-
[]>]
: For internal use only.[Type <Int32?>]
: For internal use only.
[ApproximateLastSignInDateTime <DateTime?>]
: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.[Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.[Id <String>]
: The unique identifier for an entity. Read-only.[AppServiceName <String>]
:[Error <String>]
:[PackageFamilyName <String>]
:[Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest[(Any) <Object>]
: This indicates any property can be added to this object.
[PermissionTicket <String>]
:[PostBackUri <String>]
:[Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Status <String>]
:[Type <String>]
:
[ComplianceExpirationDateTime <DateTime?>]
: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.[DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.[DeviceId <String>]
: Unique Identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Also Supports $filter (eq, ne, not, startsWith).[DeviceMetadata <String>]
: For internal use only. Set to null.[DeviceOwnership <String>]
: Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.[DeviceVersion <Int32?>]
: For internal use only.[DisplayName <String>]
: The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune.[EnrollmentProfileName <String>]
: Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.[EnrollmentType <String>]
: Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.[ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes[(Any) <Object>]
: This indicates any property can be added to this object.[ExtensionAttribute1 <String>]
: First customizable extension attribute.[ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.[ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.[ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.[ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.[ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.[ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.[ExtensionAttribute2 <String>]
: Second customizable extension attribute.[ExtensionAttribute3 <String>]
: Third customizable extension attribute.[ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.[ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.[ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.[ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.[ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.[ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[Hostnames <String-
[]>]
: List of host names for the device.[IsCompliant <Boolean?>]
: true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).[IsManaged <Boolean?>]
: true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).[IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.[IsRooted <Boolean?>]
: true if the device is rooted or jail-broken. This property can only be updated by Intune.[Kind <String>]
: Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ManagementType <String>]
: Management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.[Manufacturer <String>]
: Manufacturer of the device. Read-only.[MdmAppId <String>]
: Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[Model <String>]
: Model of the device. Read-only.[Name <String>]
: Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome.[OnPremisesLastSyncDateTime <DateTime?>]
: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).[OnPremisesSecurityIdentifier <String>]
: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq).[OnPremisesSyncEnabled <Boolean?>]
: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).[OperatingSystem <String>]
: The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[OperatingSystemVersion <String>]
: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[PhysicalIds <String-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.[Platform <String>]
: Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ProfileType <String>]
: The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.[RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.[RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.[RegistrationDateTime <DateTime?>]
: Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.[Status <String>]
: Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome.[SystemLabels <String-
[]>]
: List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand.[TrustType <String>]
: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID.[UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.[Id <String>]
: The unique identifier for an entity. Read-only.[CatalogId <String>]
: Product id corresponding to the usage right.[ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.[State <String>]
: usageRightState
COMMANDS <IMicrosoftGraphCommand- []
>: Set of commands sent to this device.
[Id <String>]
: The unique identifier for an entity. Read-only.[AppServiceName <String>]
:[Error <String>]
:[PackageFamilyName <String>]
:[Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest[(Any) <Object>]
: This indicates any property can be added to this object.
[PermissionTicket <String>]
:[PostBackUri <String>]
:[Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Status <String>]
:[Type <String>]
:
EXTENSIONATTRIBUTES <IMicrosoftGraphOnPremisesExtensionAttributes>
: onPremisesExtensionAttributes
[(Any) <Object>]
: This indicates any property can be added to this object.[ExtensionAttribute1 <String>]
: First customizable extension attribute.[ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.[ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.[ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.[ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.[ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.[ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.[ExtensionAttribute2 <String>]
: Second customizable extension attribute.[ExtensionAttribute3 <String>]
: Third customizable extension attribute.[ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.[ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.[ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.[ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.[ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.[ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
EXTENSIONS <IMicrosoftGraphExtension- []
>: The collection of open extensions defined for the device.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>
: Identity Parameter
[AdministrativeUnitId <String>]
: The unique identifier of administrativeUnit[AllowedValueId <String>]
: The unique identifier of allowedValue[AttributeSetId <String>]
: The unique identifier of attributeSet[CertificateAuthorityAsEntityId <String>]
: The unique identifier of certificateAuthorityAsEntity[CertificateBasedApplicationConfigurationId <String>]
: The unique identifier of certificateBasedApplicationConfiguration[CommandId <String>]
: The unique identifier of command[CommerceSubscriptionId <String>]
: Alternate key of companySubscription[CompanySubscriptionId <String>]
: The unique identifier of companySubscription[ContractId <String>]
: The unique identifier of contract[CustomSecurityAttributeDefinitionId <String>]
: The unique identifier of customSecurityAttributeDefinition[DeviceId <String>]
: The unique identifier of device[DeviceLocalCredentialInfoId <String>]
: The unique identifier of deviceLocalCredentialInfo[DirectoryObjectId <String>]
: The unique identifier of directoryObject[DirectoryRoleId <String>]
: The unique identifier of directoryRole[DirectoryRoleTemplateId <String>]
: The unique identifier of directoryRoleTemplate[DirectorySettingId <String>]
: The unique identifier of directorySetting[DirectorySettingTemplateId <String>]
: The unique identifier of directorySettingTemplate[DomainDnsRecordId <String>]
: The unique identifier of domainDnsRecord[DomainId <String>]
: The unique identifier of domain[ExtensionId <String>]
: The unique identifier of extension[ExternalUserProfileId <String>]
: The unique identifier of externalUserProfile[FeatureRolloutPolicyId <String>]
: The unique identifier of featureRolloutPolicy[IdentityProviderBaseId <String>]
: The unique identifier of identityProviderBase[ImpactedResourceId <String>]
: The unique identifier of impactedResource[InboundSharedUserProfileUserId <String>]
: The unique identifier of inboundSharedUserProfile[InternalDomainFederationId <String>]
: The unique identifier of internalDomainFederation[ManagedTenantAlertId <String>]
: The unique identifier of managedTenantAlert[ManagementActionId <String>]
: The unique identifier of managementAction[OcpSubscriptionId <String>]
: Alternate key of companySubscription[OnPremisesDirectorySynchronizationId <String>]
: The unique identifier of onPremisesDirectorySynchronization[OrgContactId <String>]
: The unique identifier of orgContact[OrganizationId <String>]
: The unique identifier of organization[OrganizationalBrandingLocalizationId <String>]
: The unique identifier of organizationalBrandingLocalization[OutboundSharedUserProfileUserId <String>]
: The unique identifier of outboundSharedUserProfile[PendingExternalUserProfileId <String>]
: The unique identifier of pendingExternalUserProfile[ProfileCardPropertyId <String>]
: The unique identifier of profileCardProperty[RecommendationId <String>]
: The unique identifier of recommendation[RoleTemplateId <String>]
: Alternate key of directoryRole[ScopedRoleMembershipId <String>]
: The unique identifier of scopedRoleMembership[SharedEmailDomainId <String>]
: The unique identifier of sharedEmailDomain[SharedEmailDomainInvitationId <String>]
: The unique identifier of sharedEmailDomainInvitation[SubscribedSkuId <String>]
: The unique identifier of subscribedSku[TenantId <String>]
: The unique identifier of tenant[TenantReferenceTenantId <String>]
: The unique identifier of tenantReference[TenantTagId <String>]
: The unique identifier of tenantTag[UsageRightId <String>]
: The unique identifier of usageRight[UserId <String>]
: The unique identifier of user
MEMBEROF <IMicrosoftGraphDirectoryObject- []
>: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
REGISTEREDOWNERS <IMicrosoftGraphDirectoryObject- []
>: The user that cloud joined the device or registered their personal device.
The registered owner is set at the time of registration.
Read-only.
Nullable.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
REGISTEREDUSERS <IMicrosoftGraphDirectoryObject- []
>: Collection of registered users of the device.
For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration.
Read-only.
Nullable.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
TRANSITIVEMEMBEROF <IMicrosoftGraphDirectoryObject- []
>: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
USAGERIGHTS <IMicrosoftGraphUsageRight- []
>: Represents the usage rights a device has been granted.
[Id <String>]
: The unique identifier for an entity. Read-only.[CatalogId <String>]
: Product id corresponding to the usage right.[ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.[State <String>]
: usageRightState
RELATED LINKS
https://learn.microsoft.com/graph/api/device-update?view=graph-rest-beta