-
Notifications
You must be signed in to change notification settings - Fork 518
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated Resources and Cmdlet documentation pages
- Loading branch information
1 parent
434ae98
commit 8ef59b2
Showing
1 changed file
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# IntuneDeviceCleanupRule | ||
|
||
## Parameters | ||
|
||
| Parameter | Attribute | DataType | Description | Allowed Values | | ||
| --- | --- | --- | --- | --- | | ||
| **IsSingleInstance** | Key | String | Only valid value is 'Yes'. | `Yes` | | ||
| **Enabled** | Key | Boolean | Indicates whether the cleanup rule is enabled. | | | ||
| **DeviceInactivityBeforeRetirementInDays** | Write | UInt32 | Number of days until Intune devices are deleted. Minimum: 30, Maximum: 270. | | | ||
| **Ensure** | Write | String | Present ensures the category exists, absent ensures it is removed. | `Present`, `Absent` | | ||
| **Credential** | Write | PSCredential | Credentials of the Intune Admin | | | ||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. | | | ||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. | | | ||
| **ApplicationSecret** | Write | PSCredential | Secret of the Azure Active Directory tenant used for authentication. | | | ||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. | | | ||
| **ManagedIdentity** | Write | Boolean | Managed ID being used for authentication. | | | ||
|
||
|
||
## Description | ||
|
||
This resource configures the Intune device cleanup rule. | ||
|
||
## Permissions | ||
|
||
### Microsoft Graph | ||
|
||
To authenticate with the Microsoft Graph API, this resource required the following permissions: | ||
|
||
#### Delegated permissions | ||
|
||
- **Read** | ||
|
||
- DeviceManagementManagedDevices.Read.All | ||
|
||
- **Update** | ||
|
||
- DeviceManagementManagedDevices.ReadWrite.All | ||
|
||
#### Application permissions | ||
|
||
- **Read** | ||
|
||
- DeviceManagementManagedDevices.Read.All | ||
|
||
- **Update** | ||
|
||
- DeviceManagementManagedDevices.ReadWrite.All | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
This example sets the device cleanup rule. | ||
|
||
```powershell | ||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$credsGlobalAdmin | ||
) | ||
Import-DscResource -ModuleName Microsoft365DSC | ||
node localhost | ||
{ | ||
IntuneDeviceCleanupRule 'Example' | ||
{ | ||
Enabled = $true | ||
IsSingleInstance = 'Yes' | ||
DeviceInactivityBeforeRetirementInDays = 30 | ||
Ensure = 'Present' | ||
Credential = $credsGlobalAdmin | ||
} | ||
} | ||
} | ||
``` | ||
|