New-AutoSensitivityLabelPolicy

Syntax

Default (Default)

New-AutoSensitivityLabelPolicy
    [-Name] <String>
    -ApplySensitivityLabel <String>
    [-Comment <String>]
    [-Confirm]
    [-ExceptIfOneDriveSharedBy <RecipientIdParameter[]>]
    [-ExceptIfOneDriveSharedByMemberOf <RecipientIdParameter[]>]
    [-ExchangeAdaptiveScopes <MultiValuedProperty>]
    [-ExchangeAdaptiveScopesException <MultiValuedProperty>]
    [-ExchangeLocation <MultiValuedProperty>]
    [-ExchangeSender <SmtpAddress[]>]
    [-ExchangeSenderException <SmtpAddress[]>]
    [-ExchangeSenderMemberOf <SmtpAddress[]>]
    [-ExchangeSenderMemberOfException <SmtpAddress[]>]
    [-ExternalMailRightsManagementOwner <SmtpAddress>]
    [-Force]
    [-Locations <String>]
    [-Mode <PolicyMode>]
    [-OneDriveAdaptiveScopes <MultiValuedProperty>]
    [-OneDriveAdaptiveScopesException <MultiValuedProperty>]
    [-OneDriveLocation <MultiValuedProperty>]
    [-OneDriveLocationException <MultiValuedProperty>]
    [-OneDriveSharedBy <RecipientIdParameter[]>]
    [-OneDriveSharedByMemberOf <RecipientIdParameter[]>]
    [-OverwriteLabel <Boolean>]
    [-PolicyRBACScopes <MultiValuedProperty>]
    [-PolicyTemplateInfo <PswsHashtable>]
    [-Priority <System.Int32>]
    [-SharePointAdaptiveScopes <MultiValuedProperty>]
    [-SharePointAdaptiveScopesException <MultiValuedProperty>]
    [-SharePointLocation <MultiValuedProperty>]
    [-SharePointLocationException <MultiValuedProperty>]
    [-UnifiedAuditLogEnabled <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

Description

Examples

Example 1

New-AutoSensitivityLabelPolicy -Name "GlobalPolicy" -Comment "Primary policy" -SharePointLocation "https://my.url","https://my.url2" -OneDriveLocation "https://my.url3","https://my.url4" -Mode TestWithoutNotifications -ApplySensitivityLabel "Test"

Parameters

-ApplySensitivityLabel

Applicable: Security & Compliance

The ApplySensitivityLabel parameter specifies the label to use for the auto-labeling policy.

Parameter properties

Parameter sets

-Comment

Applicable: Security & Compliance

The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".

Parameter properties

Parameter sets

-Confirm

Applicable: Security & Compliance

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

• Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
• Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Parameter properties

Parameter sets

-ExceptIfOneDriveSharedBy

Applicable: Security & Compliance

The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com).

To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value).

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

You can't use this parameter with the OneDriveSharedBy parameter.

Parameter properties

Parameter sets

-ExceptIfOneDriveSharedByMemberOf

Applicable: Security & Compliance

{{ Fill ExceptIfOneDriveSharedByMemberOf Description }}

Parameter properties

Parameter sets

-ExchangeAdaptiveScopes

Applicable: Security & Compliance

{{ Fill ExchangeAdaptiveScopes Description }}

Parameter properties

Parameter sets

-ExchangeAdaptiveScopesException

Applicable: Security & Compliance

{{ Fill ExchangeAdaptiveScopesException Description }}

Parameter properties

Parameter sets

-ExchangeLocation

Applicable: Security & Compliance

The ExchangeLocation parameter specifies whether to include email messages in the policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null).

You can use this parameter in the following procedures:

• If you use -ExchangeLocation All by itself, the policy applies to email for all internal users.

• To include email of specific internal or external users in the policy, use -ExchangeLocation All with the ExchangeSender parameter in the same command. Only email of the specified users is included in the policy.

• To include only email of specific group members in the policy, use -ExchangeLocation All with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy.

• To exclude email of specific internal users from the policy, use -ExchangeLocation All with the ExchangeSenderException parameter in the same command. Only email of the specified users is excluded from the policy.

• To exclude only email of specific group members from the policy, use -ExchangeLocation All with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy.

You can't specify inclusions and exclusions in the same policy.

Parameter properties

Parameter sets

-ExchangeSender

Applicable: Security & Compliance

The ExchangeSender parameter specifies the users whose email is included in the policy. You identify the users by email address. You can specify internal or external email addresses.

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

You must use this parameter with the ExchangeLocation parameter.

You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters.

Parameter properties

Parameter sets

-ExchangeSenderException

Applicable: Security & Compliance

The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address.

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

You must use this parameter with the ExchangeLocation parameter.

You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters.

Parameter properties

Parameter sets

-ExchangeSenderMemberOf

Applicable: Security & Compliance

The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address.

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

You must use this parameter with the ExchangeLocation parameter.

You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters.

You can't use this parameter to specify Microsoft 365 Groups.

Parameter properties

Parameter sets

-ExchangeSenderMemberOfException

Applicable: Security & Compliance

The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address.

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

You must use this parameter with the ExchangeLocation parameter.

You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters.

You can't use this parameter to specify Microsoft 365 Groups.

Parameter properties

Parameter sets

-ExternalMailRightsManagementOwner

Applicable: Security & Compliance

The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS.

This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action.

Parameter properties

Parameter sets

-Force

Applicable: Security & Compliance

The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.

You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate.

Parameter properties

Parameter sets

-Locations

Applicable: Security & Compliance

{{ Fill Locations Description }}

Parameter properties

Parameter sets

-Mode

Applicable: Security & Compliance

The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are:

• Enable: The policy is enabled for actions and notifications. This value is the default.
• Disable: The policy is disabled.
• TestWithNotifications: No actions are taken, but notifications are sent.
• TestWithoutNotifications: An audit mode where no actions are taken, and no notifications are sent.

Parameter properties

Parameter sets

-Name

Applicable: Security & Compliance

The Name parameter specifies a unique name for the auto-labeling policy. If the value contains spaces, enclose the value with quotation marks (").

Parameter properties

Parameter sets

-OneDriveAdaptiveScopes

Applicable: Security & Compliance

{{ Fill OneDriveAdaptiveScopes Description }}

Parameter properties

Parameter sets

-OneDriveAdaptiveScopesException

Applicable: Security & Compliance

{{ Fill OneDriveAdaptiveScopesException Description }}

Parameter properties

Parameter sets

-OneDriveLocation

Applicable: Security & Compliance

The OneDriveLocation parameter specifies the OneDrive sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-OneDriveLocationException

Applicable: Security & Compliance

This parameter specifies the OneDrive sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-OneDriveSharedBy

Applicable: Security & Compliance

The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com).

To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value).

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

You can't use this parameter with the ExceptIfOneDriveSharedBy parameter.

Parameter properties

Parameter sets

-OneDriveSharedByMemberOf

Applicable: Security & Compliance

{{ Fill OneDriveSharedByMemberOf Description }}

Parameter properties

Parameter sets

-OverwriteLabel

Applicable: Security & Compliance

The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are:

• $true: Overwrite the manual label.
• $false: Don't overwrite the manual label. This value is the default.

This parameter works only on Exchange locations.

Parameter properties

Parameter sets

-PolicyRBACScopes

Applicable: Security & Compliance

The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas.

Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell.

Parameter properties

Parameter sets

-PolicyTemplateInfo

Applicable: Security & Compliance

This parameter is reserved for internal Microsoft use.

Parameter properties

Parameter sets

-Priority

Applicable: Security & Compliance

The Priority parameter specifies the priority of the policy. The highest priority policy takes precedence over lower priority policies if two policies are applicable for a file.

Parameter properties

Parameter sets

-SharePointAdaptiveScopes

Applicable: Security & Compliance

{{ Fill SharePointAdaptiveScopes Description }}

Parameter properties

Parameter sets

-SharePointAdaptiveScopesException

Applicable: Security & Compliance

{{ Fill SharePointAdaptiveScopesException Description }}

Parameter properties

Parameter sets

-SharePointLocation

Applicable: Security & Compliance

The SharePointLocation parameter specifies the SharePoint sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN". SharePoint sites can't be added to a policy until they have been indexed.

Parameter properties

Parameter sets

-SharePointLocationException

Applicable: Security & Compliance

This parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-UnifiedAuditLogEnabled

Applicable: Security & Compliance

{{ Fill UnifiedAuditLogEnabled Description }}

Parameter properties

Parameter sets

-WhatIf

Applicable: Security & Compliance

The WhatIf switch doesn't work in Security & Compliance PowerShell.

Parameter properties

Parameter sets

CommonParameters