Skip to content

SCDLPSensitiveInformationType

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key String The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters.
Identity Write String Unique identifier of the Sensitive Information Type.
Description Write String The Description parameter specifies a description for the sensitive information type rule.
FileData Write String The fingerprint file data for the Sensitive Information Type.
Locale Write String The Locale parameter specifies the language that's associated with the sensitive information type rule.
Ensure Write String Present ensures the instance exists, absent ensures it is removed. Absent, Present
Credential Write PSCredential Credentials of the workload's 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.
ManagedIdentity Write Boolean Managed ID being used for authentication.
AccessTokens Write String[] Access token used for authentication.

Description

Manages sensitive information types in Purview.

Permissions

Office 365 Exchange Online

To authenticate with the Office 365 Exchange Online API, this resource requires the following permissions:

Delegated permissions

  • Read
  • None

  • Update

  • None

Application permissions

  • Read
  • Exchange.ManageAsApp

  • Update

  • Exchange.ManageAsApp

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()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        SCDLPSensitiveInformationType "SCDLPSensitiveInformationType-Example"
        {
            Description           = "Detects internal employee identification numbers";
            Ensure                = "Present";
            FileData              = "Employee identification numbers at Contoso consist of the letters EMP followed by five digits, such as EMP12345. They are issued by Human Resources when an employee joins the company and are printed on every badge, payslip and internal directory entry. Contractor numbers follow the same pattern but begin with the letters CON.";
            Locale                = "en-US";
            Name                  = "Contoso Employee ID";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}

Example 2

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()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        SCDLPSensitiveInformationType "SCDLPSensitiveInformationType-Example"
        {
            Description           = "Detects internal employee and contractor identification numbers"; # Updated Property
            Ensure                = "Present";
            FileData              = "Employee identification numbers at Contoso consist of the letters EMP followed by five digits, such as EMP12345. They are issued by Human Resources when an employee joins the company and are printed on every badge, payslip and internal directory entry. Contractor numbers follow the same pattern but begin with the letters CON.";
            Locale                = "en-US";
            Name                  = "Contoso Employee ID";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}

Example 3

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()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        SCDLPSensitiveInformationType "SCDLPSensitiveInformationType-Example"
        {
            Ensure                = "Absent";
            Name                  = "Contoso Employee ID";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}