forked from microsoft/Microsoft365DSC
-
Notifications
You must be signed in to change notification settings - Fork 0
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
6dc3f4d
commit 7dce455
Showing
1 changed file
with
119 additions
and
0 deletions.
There are no files selected for viewing
119 changes: 119 additions & 0 deletions
119
docs/docs/resources/intune/IntuneDeviceConfigurationEmailProfilePolicyWindows10.md
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,119 @@ | ||
| # IntuneDeviceConfigurationEmailProfilePolicyWindows10 | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Attribute | DataType | Description | Allowed Values | | ||
| | --- | --- | --- | --- | --- | | ||
| | **AccountName** | Write | String | Account name. | | | ||
| | **DurationOfEmailToSync** | Write | String | Duration of email to sync. Possible values are: userDefined, oneDay, threeDays, oneWeek, twoWeeks, oneMonth, unlimited. | `userDefined`, `oneDay`, `threeDays`, `oneWeek`, `twoWeeks`, `oneMonth`, `unlimited` | | ||
| | **EmailAddressSource** | Write | String | Email attribute that is picked from AAD and injected into this profile before installing on the device. Possible values are: userPrincipalName, primarySmtpAddress. | `userPrincipalName`, `primarySmtpAddress` | | ||
| | **EmailSyncSchedule** | Write | String | Email sync schedule. Possible values are: userDefined, asMessagesArrive, manual, fifteenMinutes, thirtyMinutes, sixtyMinutes, basedOnMyUsage. | `userDefined`, `asMessagesArrive`, `manual`, `fifteenMinutes`, `thirtyMinutes`, `sixtyMinutes`, `basedOnMyUsage` | | ||
| | **HostName** | Write | String | Exchange location that (URL) that the native mail app connects to. | | | ||
| | **RequireSsl** | Write | Boolean | Indicates whether or not to use SSL. | | | ||
| | **SyncCalendar** | Write | Boolean | Whether or not to sync the calendar. | | | ||
| | **SyncContacts** | Write | Boolean | Whether or not to sync contacts. | | | ||
| | **SyncTasks** | Write | Boolean | Whether or not to sync tasks. | | | ||
| | **CustomDomainName** | Write | String | Custom domain name value used while generating an email profile before installing on the device. | | | ||
| | **UserDomainNameSource** | Write | String | UserDomainname attribute that is picked from AAD and injected into this profile before installing on the device. Possible values are: fullDomainName, netBiosDomainName. | `fullDomainName`, `netBiosDomainName` | | ||
| | **UsernameAADSource** | Write | String | Name of the AAD field, that will be used to retrieve UserName for email profile. Possible values are: userPrincipalName, primarySmtpAddress, samAccountName. | `userPrincipalName`, `primarySmtpAddress`, `samAccountName` | | ||
| | **UsernameSource** | Write | String | Username attribute that is picked from AAD and injected into this profile before installing on the device. Possible values are: userPrincipalName, primarySmtpAddress. | `userPrincipalName`, `primarySmtpAddress` | | ||
| | **Description** | Write | String | Admin provided description of the Device Configuration. | | | ||
| | **DisplayName** | Required | String | Admin provided name of the device configuration. | | | ||
| | **Id** | Key | String | The unique identifier for an entity. Read-only. | | | ||
| | **Assignments** | Write | MSFT_DeviceManagementConfigurationPolicyAssignments[] | Represents the assignment to the Intune policy. | | | ||
| | **Ensure** | Write | String | Present ensures the policy exists, absent ensures it is removed. | `Present`, `Absent` | | ||
| | **Credential** | Write | PSCredential | Credentials of the 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. | | | ||
|
|
||
| ### MSFT_DeviceManagementConfigurationPolicyAssignments | ||
|
|
||
| #### Parameters | ||
|
|
||
| | Parameter | Attribute | DataType | Description | Allowed Values | | ||
| | --- | --- | --- | --- | --- | | ||
| | **dataType** | Write | String | The type of the target assignment. | `#microsoft.graph.groupAssignmentTarget`, `#microsoft.graph.allLicensedUsersAssignmentTarget`, `#microsoft.graph.allDevicesAssignmentTarget`, `#microsoft.graph.exclusionGroupAssignmentTarget`, `#microsoft.graph.configurationManagerCollectionAssignmentTarget` | | ||
| | **deviceAndAppManagementAssignmentFilterType** | Write | String | The type of filter of the target assignment i.e. Exclude or Include. Possible values are:none, include, exclude. | `none`, `include`, `exclude` | | ||
| | **deviceAndAppManagementAssignmentFilterId** | Write | String | The Id of the filter for the target assignment. | | | ||
| | **groupId** | Write | String | The group Id that is the target of the assignment. | | | ||
| | **collectionId** | Write | String | The collection Id that is the target of the assignment.(ConfigMgr) | | | ||
|
|
||
|
|
||
| ## Description | ||
|
|
||
| Intune Device Configuration Email Profile Policy for Windows10 | ||
|
|
||
| ## Permissions | ||
|
|
||
| ### Microsoft Graph | ||
|
|
||
| To authenticate with the Microsoft Graph API, this resource required the following permissions: | ||
|
|
||
| #### Delegated permissions | ||
|
|
||
| - **Read** | ||
|
|
||
| - DeviceManagementConfiguration.Read.All | ||
|
|
||
| - **Update** | ||
|
|
||
| - DeviceManagementConfiguration.ReadWrite.All | ||
|
|
||
| #### Application permissions | ||
|
|
||
| - **Read** | ||
|
|
||
| - DeviceManagementConfiguration.Read.All | ||
|
|
||
| - **Update** | ||
|
|
||
| - DeviceManagementConfiguration.ReadWrite.All | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| This example is used to test new resources and showcase the usage of new resources being worked on. | ||
| It is not meant to use as a production baseline. | ||
|
|
||
| ```powershell | ||
| Configuration Example | ||
| { | ||
| param( | ||
| [Parameter(Mandatory = $true)] | ||
| [PSCredential] | ||
| $Credscredential | ||
| ) | ||
| Import-DscResource -ModuleName Microsoft365DSC | ||
| node localhost | ||
| { | ||
| IntuneDeviceConfigurationEmailProfilePolicyWindows10 'Example' | ||
| { | ||
| AccountName = "Corp email2"; | ||
| Assignments = @( | ||
| MSFT_DeviceManagementConfigurationPolicyAssignments{ | ||
| deviceAndAppManagementAssignmentFilterType = 'none' | ||
| dataType = '#microsoft.graph.allLicensedUsersAssignmentTarget' | ||
| } | ||
| ); | ||
| Credential = $Credscredential; | ||
| DisplayName = "email"; | ||
| DurationOfEmailToSync = "unlimited"; | ||
| EmailAddressSource = "primarySmtpAddress"; | ||
| EmailSyncSchedule = "fifteenMinutes"; | ||
| Ensure = "Present"; | ||
| HostName = "outlook.office365.com"; | ||
| Id = "776bcf45-35f7-4436-93fb-7a74828c6477"; | ||
| RequireSsl = $True; | ||
| SyncCalendar = $True; | ||
| SyncContacts = $True; | ||
| SyncTasks = $True; | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|