SCRetentionEventType¶
Parameters¶
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name | Key | String | The Name parameter specifies the unique name of the retention event type. | |
Ensure | Write | String | Specify if this rule should exist or not. | Present , Absent |
Comment | Write | String | The Comment parameter specifies an optional comment. | |
Credential | Write | PSCredential | Credentials of the Exchange Global 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. | |
CertificateThumbprint | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. | |
CertificatePassword | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword | |
CertificatePath | Write | String | Path to certificate used in service principal usually a PFX file. | |
AccessTokens | Write | StringArray[] | Access token used for authentication. |
Description¶
This resource configures a Retention Event Type in Purview.
Permissions¶
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.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$Credscredential
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
SCRetentionEventType 'RetentionEventType'
{
Name = "DemoEventType"
Comment = "Demo event comment"
Ensure = "Present"
Credential = $Credscredential
}
}
}