SCLabelPolicy¶

Parameters¶

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The Name parameter specifies the unique name for the sensitivity label. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks.
Ensure	Write	String	Specify if this label policy should exist or not.	`Present`, `Absent`
Comment	Write	String	The Comment parameter specifies an optional comment.
AdvancedSettings	Write	MSFT_SCLabelSetting[]	The AdvancedSettings parameter enables client-specific features and capabilities on the sensitivity label. The settings that you configure with this parameter only affect apps that are designed for the setting.
ExchangeLocation	Write	String[]	The ExchangeLocation parameter specifies the mailboxes to include in the policy.
ExchangeLocationException	Write	String[]	The ExchangeLocationException parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter.
ModernGroupLocation	Write	String[]	The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy.
ModernGroupLocationException	Write	String[]	The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude when you're using the value All for the ModernGroupLocation parameter.
Labels	Write	String[]	The Labels parameter specifies the sensitivity labels that are associated with the policy. You can use any value that uniquely identifies the label.
AddExchangeLocation	Write	String[]	The AddExchangeLocation parameter specifies the mailboxes to add in the existing policy.
AddExchangeLocationException	Write	String[]	The AddExchangeLocationException parameter specifies the mailboxes to add to exclusions when you use the value All for the ExchangeLocation parameter.
AddModernGroupLocation	Write	String[]	The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to include the policy.
AddModernGroupLocationException	Write	String[]	The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to exclusions when you're using the value All for the ModernGroupLocation parameter.
AddLabels	Write	String[]	The AddLabels parameter specifies the sensitivity labels to add to the policy. You can use any value that uniquely identifies the label.
RemoveExchangeLocation	Write	String[]	The RemoveExchangeLocation parameter specifies the mailboxes to remove from the policy.
RemoveExchangeLocationException	Write	String[]	The RemoveExchangeLocationException parameter specifies the mailboxes to remove when you use the value All for the ExchangeLocation parameter.
RemoveModernGroupLocation	Write	String[]	The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the policy.
RemoveModernGroupLocationException	Write	String[]	The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from excluded values when you're using the value All for the ModernGroupLocation parameter.
RemoveLabels	Write	String[]	The RemoveLabels parameter specifies the sensitivity labels that are removed from the policy. You can use any value that uniquely identifies the label.
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.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	String[]	Access token used for authentication.

Embedded Instances¶

MSFT_SCLabelSetting¶

Parameters¶

Parameter	Attribute	DataType	Description	Allowed Values
Key	Required	String	Advanced settings key.
Value	Write	String[]	Advanced settings value.

Description¶

This resource configures a Sensitivity label policy 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
    {
        SCLabelPolicy 'SCLabelPolicy-Example'
        {
            Name                         = "Contoso Label Policy"
            Comment                      = "Publishes the Personal and General labels to all users"
            Labels                       = @("Personal", "General")
            ExchangeLocation             = @("All")
            ExchangeLocationException    = @("shared.reception@contoso.com")
            ModernGroupLocation          = @("All")
            ModernGroupLocationException = @("boardroom@contoso.com")
            AdvancedSettings             = @(
                MSFT_SCLabelSetting{
                    Key   = "RequireDowngradeJustification"
                    Value = "True"
                }
                MSFT_SCLabelSetting{
                    Key   = "AttachmentAction"
                    Value = "Automatic"
                }
            )
            Ensure                       = "Present"
            ApplicationId                = $ApplicationId
            TenantId                     = $TenantId
            CertificateThumbprint        = $CertificateThumbprint
        }
    }
}