en/AipService.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AipServiceRoleBasedAdministrator</command:name> <command:verb>Add</command:verb> <command:noun>AipServiceRoleBasedAdministrator</command:noun> <maml:description> <maml:para>Grants administrative rights to Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-AipServiceRoleBasedAdministrator cmdlet grants administrative rights to the protection service from Azure Information Protection, so that administrators you delegate to configure this service can do so by using PowerShell commands. </maml:para> <maml:para>You must use PowerShell to configure delegated administrative control for the protection service; you cannot do this configuration by using a management portal.</maml:para> <maml:para>When you run this cmdlet, you can specify a user or a group in Azure AD, and you can run the cmdlet multiple times to add new users and new groups. To see the full list, use Get-AipServiceRoleBasedAdministrator.</maml:para> <maml:para>If you specify a group, it can be any group in Azure AD and does not need to be mail-enabled. To specify a group that is not mail-enabled, use either the SecurityGroupDisplayName parameter, or the ObjectId parameter. You can also use these parameters or the EmailAddress parameter for a mail-enabled group.</maml:para> <maml:para>For more information about the user and group requirements, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare). This information includes how to identify the different group types and how to find the values to specify them when you run this cmdlet. </maml:para> <maml:para>After delegating control to other administrators, they might find it useful to reference a list of the cmdlets they can run, grouped by administrative task. For this information, see Administering the protection service by using PowerShell (https://docs.microsoft.com/information-protection/deploy-use/administer-powershell).</maml:para> <maml:para>Note that these administrative roles are separate from the Azure Active Directory admin roles or Office 365 admin roles.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to have administrative rights for the protection service. If the user has no email address, specify the user's Universal Principal Name.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to have administrative rights for the protection service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group to have administrative rights for the protection service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to have administrative rights for the protection service. If the user has no email address, specify the user's Universal Principal Name.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to have administrative rights for the protection service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group to have administrative rights for the protection service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Grant administrative rights by using a display name</maml:title> <dev:code>PS C:\>Add-AipServiceRoleBasedAdministrator -SecurityGroupDisplayName "Finance Employees"</dev:code> <dev:remarks> <maml:para>This command grants administrative rights to the protection service for the group that has a display name of "Finance Employees".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 2: Grant administrative rights by using a GUID ----</maml:title> <dev:code>PS C:\>Add-AipServiceRoleBasedAdministrator -ObjectId 2c8afe23-bf58-4289-bea1-05131aeb50ab</dev:code> <dev:remarks> <maml:para>This command grants administrative rights to the protection service for the group that has the specified GUID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044795</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AipServiceSuperUser</command:name> <command:verb>Add</command:verb> <command:noun>AipServiceSuperUser</command:noun> <maml:description> <maml:para>Adds a super user to Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-AipServiceSuperUser cmdlet adds an individual account to the super user list for your organization. This operation makes the account an owner for all content that is protected by your organization. This means that these super users can decrypt this rights-protected content and remove rights-protection from it, even if an expiration date has been set and expired. Typically, this level of access is required for legal eDiscovery and by auditing teams.</maml:para> <maml:para>However, before a super user can do these operations, the super user feature for Azure Information Protection must be enabled by using the Enable-AipServiceSuperUserFeature cmdlet. By default, the super user feature is not enabled.</maml:para> <maml:para>Specify the account by email address or service principal ID. To specify a user who does not have an email address, specify their User Principal Name instead. For more information, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare). </maml:para> <maml:para>To specify a group rather than individual users, use the Set-AipServiceSuperUserGroup cmdlet instead of this Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AipServiceSuperUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user in your organization to grant this user super user privileges.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AipServiceSuperUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:Description> <maml:para>Specifies the AppPrincipalId of the service principal in your organization to grant this account super user privileges. Use the Get-MsolServicePrincipal cmdlet to get an existing service principal, or the New-MsolServicePrincipalCredential (https://docs.microsoft.com/en-us/powershell/module/msonline/new-msolserviceprincipalcredential?view=azureadps-1.0)cmdlet to create a new service principal.</maml:para> <maml:para>The service principal ID is converted to a pseudo-email address and added to the super user list for the organization. For example, `Add-AipServiceSuperUser -ServicePrincipalId "3C367900-44D1-4865-9379-9A3227042C25"` adds 3C367900-44D1-4865-9379-9A3227042C25@<AIPService tenant ID>.aipservice.na.aadrm.com to the super user list.</maml:para> <maml:para>You can remove the service principal from the super user list by using the Remove-AipServiceSuperUser cmdlet and this pseudo-email address. You can use the Get-AipServiceSuperUser cmdlet to verify the email address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user in your organization to grant this user super user privileges.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:Description> <maml:para>Specifies the AppPrincipalId of the service principal in your organization to grant this account super user privileges. Use the Get-MsolServicePrincipal cmdlet to get an existing service principal, or the New-MsolServicePrincipalCredential (https://docs.microsoft.com/en-us/powershell/module/msonline/new-msolserviceprincipalcredential?view=azureadps-1.0)cmdlet to create a new service principal.</maml:para> <maml:para>The service principal ID is converted to a pseudo-email address and added to the super user list for the organization. For example, `Add-AipServiceSuperUser -ServicePrincipalId "3C367900-44D1-4865-9379-9A3227042C25"` adds 3C367900-44D1-4865-9379-9A3227042C25@<AIPService tenant ID>.aipservice.na.aadrm.com to the super user list.</maml:para> <maml:para>You can remove the service principal from the super user list by using the Remove-AipServiceSuperUser cmdlet and this pseudo-email address. You can use the Get-AipServiceSuperUser cmdlet to verify the email address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Add a user as a super user ------------</maml:title> <dev:code>PS C:\>Add-AipServiceSuperUser -EmailAddress "EvanNarvaez@Contoso.com"</dev:code> <dev:remarks> <maml:para>This command adds an individual user to your organization's super user list for Azure Information Protection, by specifying the user's email address.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Add a service principal as a super user ------</maml:title> <dev:code>PS C:\>Add-AipServiceSuperUser -ServicePrincipalId "3C367900-44D1-4865-9379-9A3227042C25"</dev:code> <dev:remarks> <maml:para>This command adds a service principal to your organization's super user list for Azure Information Protection, by specifying the service principal's AppPrincipalId.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044912</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-MsolServicePrincipalCredential</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/msonline/new-msolserviceprincipalcredential?view=azureadps-1.0</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AipServiceTemplate</command:name> <command:verb>Add</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Creates a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-AipServiceTemplate cmdlet creates a protection template for Azure Information Protection with the specified name, description, and policy, and sets the status of the template to archived or published.</maml:para> <maml:para>The same configuration actions can also be done in the Azure portal. </maml:para> <maml:para>Important: Before you use this cmdlet, you must first create a rights definition object that specifies the rights that you want to grant and to whom, by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>You can store a maximum of 500 custom templates (published or archived) in Azure. If you can't add new templates because you have reached this limit as a result of keeping many archived templates, consider exporting them to save the information locally and then removing these templates in Azure.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AipServiceTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template. </maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AfterDays</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organización"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>Note: This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box if you configured APPLICATION COMPATIBILITY in the Azure classic portal. The classic portal is now retired and there is no equivalent setting in the Azure portal.</maml:para> <maml:para>The Azure Information Protection client supports departmental templates whereas Outlook on the web and Exchange ActiveSync are examples of applications that do not currently support departmental templates. For these Exchange applications (and all other applications that cannot support departmental templates), you must decide whether all users can select a departmental template from the list of available templates, or no users can select a departmental template from the list.</maml:para> <maml:para>This setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to select the template itself.</maml:para> <maml:para>If you have applications that do not yet natively support departmental templates, you can use a template download scriptor other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template.</maml:para> <maml:para>The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1. To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair.The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para></maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> <maml:para>Rights definition objects contain the email address for the identity and the rights to assign to it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template.</maml:para> <maml:para>Allowed values are Archived and Published .</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not visible to users. </maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Archived</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Published</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentFormats</maml:name> <maml:Description> <maml:para>Specifies a list of content formats that are supported by this template.</maml:para> <maml:para>The content format describes the type of object that is protected by applying the template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template. </maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organización"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>Note: This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box if you configured APPLICATION COMPATIBILITY in the Azure classic portal. The classic portal is now retired and there is no equivalent setting in the Azure portal.</maml:para> <maml:para>The Azure Information Protection client supports departmental templates whereas Outlook on the web and Exchange ActiveSync are examples of applications that do not currently support departmental templates. For these Exchange applications (and all other applications that cannot support departmental templates), you must decide whether all users can select a departmental template from the list of available templates, or no users can select a departmental template from the list.</maml:para> <maml:para>This setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to select the template itself.</maml:para> <maml:para>If you have applications that do not yet natively support departmental templates, you can use a template download scriptor other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template.</maml:para> <maml:para>The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1. To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair.The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para></maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> <maml:para>Rights definition objects contain the email address for the identity and the rights to assign to it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template.</maml:para> <maml:para>Allowed values are Archived and Published .</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not visible to users. </maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[],System.String[],System.String[],System.string,System.DateTime,System.int,System.int</maml:name> </dev:type> <maml:description> <maml:para>-Names $Names ; One or more names for the template, in various languages to present to users depending on their system locale.</maml:para> <maml:para>[-Descriptions $Descriptions] ; One or more descriptions for the template, in various languages to present to users depending on their system locale.</maml:para> <maml:para>[-RightsDefinitions {$r1,$r2,...}] ; A list of rights definitions in the form of Rights Definition objects.</maml:para> <maml:para>[-ContentExpirationOption ContentExpirationType.Never|OnDate|AfterDays] ; The type of content expiration for content protected with the template.</maml:para> <maml:para>[-ContentExpirationDate DateTime ] ; The date or time when the content expires, if ContentExpirationOption is set to OnDate.</maml:para> <maml:para>[-ContentValidityDuration int] ; The number of days for which content is available after it is protected if ContentExpirationOption is set to AfterDays.</maml:para> <maml:para>[-LicenseValidityDuration int] ; The number of days for which content is available online until it expires (0-9999). To specify unlimited access, use -1. To specify that a license must be obtained for each use and that content is available only online, use 0.</maml:para> <maml:para>[-Status TemplateStatus.Archived|Published] ; The status of the template. Archived templates are available to consume previously protected content but are not presented to users. Published templates are distributed to users and made available for protecting content.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para></maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organización"</maml:para> <maml:para>The rights are specified as a list of rights definition objects that contain the email address for the identity and the rights to assign to it.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Create a departmental template for confidential content</maml:title> <dev:code>PS C:\> $names = @{} PS C:\> $names[1033] = "New Launch - Confidential content" PS C:\> $names[1034] = " Nuevo Lanzamiento - Contenido confidencial" PS C:\> $descriptions = @{} PS C:\> $descriptions[1033] = "This content is confidential for people working on the New Launch project and should not be shared externally" PS C:\> $descriptions[1034] = "Este contenido es confidencial para empleados trabajando en el proyecto Nuevo Lanzamiento y no debe ser compartido fuera de la organización" PS C:\> $r1 = New-AipServiceRightsDefinition -EmailAddress marketing@contoso.com -Rights "VIEW","EXPORT" PS C:\> $r2 = New-AipServiceRightsDefinition -EmailAddress engineering@contoso.com -Rights "VIEW","DOCEDIT" PS C:\> Add-AipServiceTemplate -Names $names -Descriptions $Descriptions -LicenseValidityDuration 5 -RightsDefinitions $r1, $r2 -ScopedIdentities engineering@contoso.com -Status Published</dev:code> <dev:remarks> <maml:para>This example creates a departmental template for engineers when they are working on the New Launch project. The template is named New Launch - Confidential Content and has names and descriptions in English and in Spanish. It grants View and Export rights to the marketing department (lets them view and save to a non-protected file) by using the marketing@contoso.com group, and View and DocEdit rights (lets them view and edit the contents but not save the changes) to the engineering department by using the engineering@contoso.com group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044916</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AipServiceRightsDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-AipServiceDoNotTrackUserGroup</command:name> <command:verb>Clear</command:verb> <command:noun>AipServiceDoNotTrackUserGroup</command:noun> <maml:description> <maml:para>Clears the group for the users who must not be tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clear-AipServiceDoNotTrackUserGroup cmdlet removes the currently configured group for the users who must not be tracked by the Azure Information Protection document tracking feature. This configuration might be needed for privacy requirements. For more information, see Privacy controls for your document tracking site (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#privacy-controls-for-your-document-tracking-site).</maml:para> <maml:para>This cmdlet does not delete the specified group from Azure Active Directory. Instead, a group will no longer be used to exempt users from tracking. As a result, all users in your organization will now be tracked when you use the document tracking feature. </maml:para> <maml:para>You must use PowerShell to remove this group from the Azure Information Protection service; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-AipServiceDoNotTrackUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Clear-AipServiceDoNotTrackUserGroup</dev:code> <dev:remarks> <maml:para>This command removes the currently configured group (if set) that exempts users from being tracked by the document tracking feature. As a result, all users in your organization can be tracked when you use the document tracking feature.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045007</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-AipServiceSuperUserGroup</command:name> <command:verb>Clear</command:verb> <command:noun>AipServiceSuperUserGroup</command:noun> <maml:description> <maml:para>Removes the super user group for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clear-AipServiceSuperUserGroup cmdlet removes the super user group for Azure Information Protection.</maml:para> <maml:para>This cmdlet does not affect users that are individually assigned the super user privilege with the Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-AipServiceSuperUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Remove the super user group ------------</maml:title> <dev:code>PS C:\>Clear-AipServiceSuperUserGroup</dev:code> <dev:remarks> <maml:para>This command removes the super user group, if one exists, for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045013</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-AipService</command:name> <command:verb>Connect</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Connects to Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-AipService cmdlet connects you to Azure Information Protection so that you can then run administrative commands for the protection service for your tenant. This cmdlet can also be used by a partner company that manages your tenant.</maml:para> <maml:para>You must run this cmdlet before you can run the other cmdlets in this module.</maml:para> <maml:para>To connect to Azure Information Protection, use an account that is one of the following: - A global admin for your Office 365 tenant.</maml:para> <maml:para>- A global administrator for your Azure AD tenant. However, this account cannot be a Microsoft account (MSA) or from another Azure tenant.</maml:para> <maml:para>- A user account from your tenant that has been granted administrative rights to Azure Information Protection by using the Add-AipServiceRoleBasedAdministrator cmdlet.</maml:para> <maml:para></maml:para> <maml:para>Tip: If you are not prompted for your credentials, and you see an error message such as Cannot use this feature without credentials , verify that Internet Explorer is configured to use Windows integrated authentication. If this setting is not enabled, enable it, restart Internet Explorer, and then retry authentication to the Information Protection service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-AipService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:Description> <maml:para>Use this parameter to connect to Azure Information Protection by using a token that you acquire from Azure Active Directory, using the client ID '90f610bf-206d-4950-b61d-37fa6fd1b224' and the resource ID 'https://api.aadrm.com/'. This connection method lets you sign in to Azure Information Protection non-interactively.</maml:para> <maml:para>To get the access token, make sure that the account that you use from your tenant is not using multi-factor authentication (MFA). See Example 3 for how you might do this.</maml:para> <maml:para>You cannot use this parameter with the Credential parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>Specifies the tenant GUID. The cmdlet connects to Azure Information Protection for the tenant that you specify by GUID.</maml:para> <maml:para>If you do not specify this parameter, the cmdlet connects to the tenant that your account belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-AipService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential (https://go.microsoft.com/fwlink/?LinkID=293936)cmdlet. For more information, type `Get-Help Get-Cmdlet`.</maml:para> <maml:para>The cmdlet prompts you for a password.</maml:para> <maml:para>You cannot use this parameter with the AccessToken parameter and do not use it if your account is configured to use multi-factor authentication (MFA).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>Specifies the tenant GUID. The cmdlet connects to Azure Information Protection for the tenant that you specify by GUID.</maml:para> <maml:para>If you do not specify this parameter, the cmdlet connects to the tenant that your account belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-AipService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure instance for sovereign clouds. Valid values are:</maml:para> <maml:para>- AzureCloud: Commercial offering of Azure</maml:para> <maml:para>- AzureChinaCloud: Azure Operated by 21Vianet</maml:para> <maml:para>- AzureUSGovernment: Azure Government</maml:para> <maml:para>- AzureUSGovernment2: Azure Government 2</maml:para> <maml:para>- AzureUSGovernment3: Azure Government 3</maml:para> <maml:para></maml:para> <maml:para>For more information about using Azure Information Protection with Azure Government, see Azure Information Protection Premium Government Service Description (https://docs.microsoft.com/enterprise-mobility-security/solutions/ems-aip-premium-govt-service-description).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureCloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureChinaCloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureUSGovernment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureUSGovernment2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureUSGovernment3</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureRmEnvironment</command:parameterValue> <dev:type> <maml:name>AzureRmEnvironment</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:Description> <maml:para>Use this parameter to connect to Azure Information Protection by using a token that you acquire from Azure Active Directory, using the client ID '90f610bf-206d-4950-b61d-37fa6fd1b224' and the resource ID 'https://api.aadrm.com/'. This connection method lets you sign in to Azure Information Protection non-interactively.</maml:para> <maml:para>To get the access token, make sure that the account that you use from your tenant is not using multi-factor authentication (MFA). See Example 3 for how you might do this.</maml:para> <maml:para>You cannot use this parameter with the Credential parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential (https://go.microsoft.com/fwlink/?LinkID=293936)cmdlet. For more information, type `Get-Help Get-Cmdlet`.</maml:para> <maml:para>The cmdlet prompts you for a password.</maml:para> <maml:para>You cannot use this parameter with the AccessToken parameter and do not use it if your account is configured to use multi-factor authentication (MFA).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure instance for sovereign clouds. Valid values are:</maml:para> <maml:para>- AzureCloud: Commercial offering of Azure</maml:para> <maml:para>- AzureChinaCloud: Azure Operated by 21Vianet</maml:para> <maml:para>- AzureUSGovernment: Azure Government</maml:para> <maml:para>- AzureUSGovernment2: Azure Government 2</maml:para> <maml:para>- AzureUSGovernment3: Azure Government 3</maml:para> <maml:para></maml:para> <maml:para>For more information about using Azure Information Protection with Azure Government, see Azure Information Protection Premium Government Service Description (https://docs.microsoft.com/enterprise-mobility-security/solutions/ems-aip-premium-govt-service-description).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRmEnvironment</command:parameterValue> <dev:type> <maml:name>AzureRmEnvironment</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>Specifies the tenant GUID. The cmdlet connects to Azure Information Protection for the tenant that you specify by GUID.</maml:para> <maml:para>If you do not specify this parameter, the cmdlet connects to the tenant that your account belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Connect to Azure Information Protection and be prompted for your user name and other credentials</maml:title> <dev:code>PS C:\> Connect-AipService</dev:code> <dev:remarks> <maml:para>This command connects to the protection service from Azure Information Protection. This is the simplest way to connect to the service, by running the cmdlet with no parameters.</maml:para> <maml:para>You are prompted for your user name and password. If your account is configured to use multi-factor authentication, you are then prompted for your alternative method of authentication, and then connected to the service.</maml:para> <maml:para>If your account is configured to use multi-factor authentication, you must use this method to connect to Azure Information Protection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Connect to Azure Information Protection with stored credentials</maml:title> <dev:code>PS C:\>$AdminCredentials = Get-Credential "Admin@aadrm.contoso.com" PS C:\> Connect-AipService -Credential $AdminCredentials</dev:code> <dev:remarks> <maml:para>The first command creates a PSCredential object and stores your specified user name and password in the $AdminCredentials variable. When you run this command, you are prompted for the password for the user name that you specified.</maml:para> <maml:para>The second command connects to Azure Information Protection by using the credentials stored in $AdminCredentials . If you disconnect from the service and reconnect while the variable is still in use, simply rerun the second command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Connect to Azure Information Protection with a token</maml:title> <dev:code>PS C:\>[Reflection.Assembly]::LoadFile("C:\Windows\system32\WindowsPowerShell\v1.0\Modules\AADRM\Microsoft.IdentityModel.Clients.ActiveDirectory.dll") PS C:\> $clientId='90f610bf-206d-4950-b61d-37fa6fd1b224'; PS C:\> $resourceId = 'https://api.aadrm.com/'; PS C:\> $clientId='90f610bf-206d-4950-b61d-37fa6fd1b224'; PS C:\> $userName='admin@contoso.com'; <!--[SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Help file provides an example of password.")]--> PS C:\> $password='Passw0rd!'; PS C:\> $redirectUri = new-object System.Uri("https://aadrm.com/AADRMAdminPowershell"); PS C:\> $authority = "https://login.microsoftonline.com/common"; PS C:\> $authContext = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext($authority); PS C:\> $userCreds = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential($userName, $password); PS C:\> $authenticationResult = $authContext.AcquireToken($resourceId,$clientId,$userCreds); PS C:\> Import-module aadrm PS C:\> Connect-AipServiceservice -AccessToken $authenticationResult.AccessToken</dev:code> <dev:remarks> <maml:para>This example shows how you could connect to Azure Information Protection by using the AccessToken parameter, which lets you authenticate without a prompt. This connection method requires you to specify the client ID '90f610bf-206d-4950-b61d-37fa6fd1b224' and the resource ID 'https://api.aadrm.com/'. After the connection is open, you can then run the administrative commands from this module that you need.</maml:para> <maml:para>After you confirm that these commands result in successfully connecting to Azure Information Protection, you could run them non-interactively, for example, from a script.</maml:para> <maml:para>Note that for illustration purposes, this example uses the user name of "admin@contoso.com" with the password of "Passw0rd!". In a production environment when you use this connection method non-interactively, use additional methods to secure the password so that it is not stored in clear text. For example, use the ConvertTo-SecureString command or use Key Vault to store the password as a secret.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045019</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Credential</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=293936</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Convert-AipServiceKeyToKeyVault</command:name> <command:verb>Convert</command:verb> <command:noun>AipServiceKeyToKeyVault</command:noun> <maml:description> <maml:para>Changes the location of a legacy customer-managed key in Azure Information Protection with the location of a customer-managed key in Azure Key Vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Convert-AipServiceKeyToKeyVault cmdlet is only for customers who have previously created a customer-managed key for Azure Rights Management and have received an invitation from Microsoft to migrate their Azure Information Protection tenant key to Azure Key Vault.</maml:para> <maml:para>Important: Do not run this cmdlet if you have not received this invitation from Microsoft and do not run this cmdlet without assistance from Microsoft.</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>Azure Information Protection now uses Azure Key Vault to manage and monitor a customer-managed tenant key. To create a customer-managed tenant key for the first time, run Use-AipServiceKeyVaultKey instead of this cmdlet.</maml:para> <maml:para>For more information about how to manage your Azure Information Protection tenant key, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> <maml:para>Before you run this cmdlet, you will need to identify your original customer-managed tenant key. To do that, use the Get-AipServiceKeys cmdlet. From the output and identified key, you will need the KeyIdentifier value for the KeyIdentifier parameter when you run this cmdlet.</maml:para> <maml:para>Also, your organization's administrator for Azure Key Vault must create a new key for Azure Information Protection and supply you with a URL for this key. You will need to specify the URL for the KeyVaultKeyUrl parameter when you run this cmdlet. This Azure Key Vault administrator must also grant the Azure Rights Management service from Azure Information Protection access to the key vault that contains the key.</maml:para> <maml:para>For security reasons, this cmdlet does not let you change the access control for the key; this must be done from Key Vault.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-AipServiceKeyToKeyVault</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier value of the original customer-managed tenant key that you now want to manage from Azure Key Vault.</maml:para> <maml:para>To get the key identifier value, use the Get-AipServiceKeys cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier value of the original customer-managed tenant key that you now want to manage from Azure Key Vault.</maml:para> <maml:para>To get the key identifier value, use the Get-AipServiceKeys cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Change the location of a legacy tenant key with a key in Azure Key Vault</maml:title> <dev:code>PS C:\>Convert-AipServiceKeyToKeyVault -KeyIdentifier aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"</dev:code> <dev:remarks> <maml:para>Changes the location of the original customer-managed key that has the key identifier of aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb with the location of a customer-managed key in Azure Key Vault, which is named contoso-aipservice-key and has the version number aaaabbbbcccc111122223333 in the Contoso key vault.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045022</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Use-AipServiceKeyVaultKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Planning and implementing your Azure Information Protection tenant key</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AipService</command:name> <command:verb>Disable</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Deactivates the protection service from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipService cmdlet deactivates the protection service from Azure Information Protection for your tenant.</maml:para> <maml:para>You can also do this action in a management portal. For more information, see Decommissioning and deactivating Azure Information Protection service (https://docs.microsoft.com/rights-management/deploy-use/decommission-deactivate)on the Microsoft documentation site. </maml:para> <maml:para>Deactivate the protection service only if you no longer want to protect documents and emails by using Azure Information Protection and you no longer need access to content that was previously protected by using Azure Information Protection.</maml:para> <maml:para>If you accidentally deactivate the protection service or change your mind, you can simply activate it again by using the Enable-AipService cmdlet to resume using the service. However, if you are deactivating the service because you no longer want to use protection from Azure Information Protection, you might need to take additional steps. For more information, see Decommissioning and deactivating Azure Rights Management (https://docs.microsoft.com/rights-management/deploy-use/decommission-deactivate).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Disable the protection service ----------</maml:title> <dev:code>PS C:\>Disable-AipService</dev:code> <dev:remarks> <maml:para>This command deactivates the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044839</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AipServiceDevicePlatform</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceDevicePlatform</command:noun> <maml:description> <maml:para>Disables protection support from Azure Information Protection for device platforms.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceDevicePlatform cmdlet disables protection support from Azure Information Protection for device platforms. For information about supported device platforms, see the Enable-AipServiceDevicePlatform cmdlet.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceDevicePlatform</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet disables protection support for all device platforms.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Disable-AipServiceDevicePlatform</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet disables protection support for all device platforms.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Disable protection support for device platforms --</maml:title> <dev:code>PS C:\>Disable-AipServiceDevicePlatform -WindowsPhone -WindowStore</dev:code> <dev:remarks> <maml:para>This command disables protection support for Windows Phone and Windows Store device platforms.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Disable protection support for all device platforms</maml:title> <dev:code>PS C:\>Disable-AipServiceDevicePlatform -All</dev:code> <dev:remarks> <maml:para>This command disables protection support for all device platforms.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045122</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AipServiceDocumentTrackingFeature</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceDocumentTrackingFeature</command:noun> <maml:description> <maml:para>Disables document tracking for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceDocumentTrackingFeature cmdlet disables the document tracking feature for Azure Information Protection. This cmdlet disables access to the document tracking site so that all users in your organization cannot track or revoke access to documents that they have protected. In addition, activity related to shared documents (who opened them, when, from which location) is not logged to the document tracking site. For example, if you later enable the document tracking site, users will see the documents that they protected while the site was disabled but cannot see who opened them.</maml:para> <maml:para>You must use PowerShell to disable document tracking; you cannot do this configuration by using a management portal.</maml:para> <maml:para>Document tracking is enabled by default for an organization using the protection service from Azure Information Protection, but you might need to disable this feature for privacy requirements that are specific to your organization or region. This setting is organization-wide; you cannot disable document tracking for some users in your organization and not for others.</maml:para> <maml:para>When document tracking is disabled, users still see options that refer to tracking and revocation in applications such as Word and File Explorer, and the Azure Information Protection client. However, when users access the document tracking site, they see the following message: Your administrator has disabled document tracking for your organization. Contact your administrator for details. You can disable document tracking either before you activate the protection service for Azure Information Protection, or after. After you have disabled document tracking, you can re-enable it at any time.</maml:para> <maml:para>For additional information about the document tracking site, see Configuring and using document tracking for Azure Information Protection (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking)from the Azure Information Protection client administrator guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceDocumentTrackingFeature</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Disable document tracking -------------</maml:title> <dev:code>PS C:\>Disable-AipServiceDocumentTrackingFeature</dev:code> <dev:remarks> <maml:para>This command disables document tracking for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045125</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AipServiceIPCv3</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceIPCv3</command:noun> <maml:description> <maml:para>Disables the MSIPC v3 platform for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceIPCv3 cmdlets disables the MSIPC v3 platform on mobile devices such as iOS and Android. This platform must be enabled to support the protection service from Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceIPCv3</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example1: Disable the MSIPC v3 platform for iOS and Android devices</maml:title> <dev:code>PS C:\>Disable-AipServiceIPCv3</dev:code> <dev:remarks> <maml:para>This command disables the MSIPC v3 platform so that iOS and Android mobile devices cannot use the protection service.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044846</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AipServiceSuperUserFeature</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceSuperUserFeature</command:noun> <maml:description> <maml:para>Disables the super user feature for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceSuperUserFeature cmdlet disables the super user feature for Azure Information Protection. This action does not automatically remove the previously added users or group from the super user list, and they continue to be displayed when you run the Get-AipServiceSuperUser or Get-AipServiceSuperUserGroup cmdlets. Therefore, if you enable the super user feature again, these users are automatically super users again, until you manually remove them.</maml:para> <maml:para>If there are users in the current super list who must not be a super user if this feature is enabled again, remove them from the super user list before you disable the super user feature. If these users are individually specified, remove them with the Remove-AipServiceSuperUser cmdlet. If they are a member of a group that you have specified to be a super user group, either remove those users from the specified super user group, or remove the super user group by using the Clear-AipServiceSuperUserGroup cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For information about the super user feature for Azure Information Protection, see Enable-AipServiceSuperUserFeature.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceSuperUserFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Disable the super user feature ----------</maml:title> <dev:code>PS C:\>Disable-AipServiceSuperUserFeature</dev:code> <dev:remarks> <maml:para>This command disables the super user feature for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=400599</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-AipService</command:name> <command:verb>Disconnect</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Disconnects from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-AipService cmdlet disconnects you from the protection service from Azure Information Protection. Use this cmdlet to end a connection that you previously established by using the Connect-AipService cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Disconnect from Azure Information Protection ---</maml:title> <dev:code>PS C:\>Disconnect-AipService</dev:code> <dev:remarks> <maml:para>This command disconnects you from the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044860</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AipService</command:name> <command:verb>Enable</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Activates the protection service for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipService cmdlet activates the protection service from Azure Information Protection so that all users in your tenant can protect documents and emails. </maml:para> <maml:para>You can also do this action in a management portal. For more information, see Activating the protection service from Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/activate-service). </maml:para> <maml:para>When you activate the protection service, you turn on this service for all rights-enabled applications and services for your tenant, but some applications and services and might need further configuration before they can use the protection capabilities from Azure Information Protection.</maml:para> <maml:para>For information about other deployment steps that might be needed, see the deployment roadmap (https://docs.microsoft.com/information-protection/plan-design/deployment-roadmap).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Enable the protection service -----------</maml:title> <dev:code>PS C:\>Enable-AipService</dev:code> <dev:remarks> <maml:para>This command activates the protection service for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044863</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Activating the protection service from Azure Information Protection</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/activate-service</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AipServiceDevicePlatform</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceDevicePlatform</command:noun> <maml:description> <maml:para>Enables protection support from Azure Information Protection for device platforms.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceDevicePlatform cmdlet enables protection support from Azure Information Protection for device platforms. Your tenant can support any combination of the following device platforms: - Android</maml:para> <maml:para>- iOS</maml:para> <maml:para>- Macintosh operating system</maml:para> <maml:para>- Web</maml:para> <maml:para>- Windows operating system</maml:para> <maml:para>- Windows Phone</maml:para> <maml:para>- Windows Store</maml:para> <maml:para></maml:para> <maml:para>To support all platforms, specify the All parameter.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceDevicePlatform</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet enables protection support for all device platforms.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-AipServiceDevicePlatform</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet enables protection support for all device platforms.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Enable protection support for device platforms --</maml:title> <dev:code>PS C:\>Enable-AipServiceDevicePlatform -WindowsPhone -WindowStore</dev:code> <dev:remarks> <maml:para>This command enables protection support for device platforms for Windows Phone and Windows Store device platforms.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 2: Enable protection support for all device platforms </maml:title> <dev:code>PS C:\>Enable-AipServiceDevicePlatform -All</dev:code> <dev:remarks> <maml:para>This command enables protection support for all device platforms.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044865</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AipServiceDocumentTrackingFeature</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceDocumentTrackingFeature</command:noun> <maml:description> <maml:para>Enables document tracking for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceDocumentTrackingFeature cmdlet enables the document tracking feature for Azure Information Protection. This cmdlet enables access to the document tracking site so that users can track or revoke access to documents that they have protected. This setting is organization-wide; you cannot enable document tracking for some users in your organization and not for others.</maml:para> <maml:para>You must use PowerShell to enable document tracking; you cannot do this configuration by using a management portal.</maml:para> <maml:para>By default, document tracking is enabled, so you would run this cmdlet only if somebody had previously disabled document tracking for your tenant. When document tracking is enabled, users can access the document tracking site to see the protected documents that they have shared to date. Activity related to shared documents (who opened them, when, from which location) is shown for only when the document tracking site is enabled. For example, a user could revoke a document that they shared when document tracking was disabled but they cannot not see who opened this document when document tracking was disabled.</maml:para> <maml:para>For additional information about the document tracking site, see Configuring and using document tracking for Azure Information Protection (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking)from the Azure Information Protection client administrator guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceDocumentTrackingFeature</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Enable document tracking -------------</maml:title> <dev:code>PS C:\>EnableAipServiceDocumentTrackingFeature</dev:code> <dev:remarks> <maml:para>This command enables document tracking for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044867</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AipServiceIPCv3</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceIPCv3</command:noun> <maml:description> <maml:para>Enables the MSIPC v3 platform for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceIPCv3 cmdlets enables the MSIPC v3 platform on mobile devices such as iOS and Android. This platform must be enabled to support the protection service from Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceIPCv3</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example1: Enable the MSIPC v3 platform for iOS and Android devices</maml:title> <dev:code>PS C:\>Enable-AipServiceIPCv3</dev:code> <dev:remarks> <maml:para>This command enables the MSIPC v3 platform so that iOS and Android mobile devices can use the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045030</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AipServiceSuperUserFeature</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceSuperUserFeature</command:noun> <maml:description> <maml:para>Enables the super user feature for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceSuperUserFeature cmdlet enables the super user feature for your tenant's protection service from Azure Information Protection. When this feature is enabled, any users that are defined as super users for your organization (individually or by the super user group) can decrypt content that your tenant protected, and can remove protection from this content, even if an expiration date has been set and expired. Typically, this level of access is required for legal eDiscovery and by auditing teams. </maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>By default, the super user feature is not enabled, and no users are assigned to this feature. To assign users, you must use Add-AipServiceSuperUser or Set-AipServiceSuperUserGroup.</maml:para> <maml:para>Caution: We recommend that you enable the super user feature on an as-needed basis. During standard operations, we recommend that you disable the super user feature, unless you use it to provide a trusted application with the ability to decrypt rights-protected content. For example, this exception might be needed for an application to scan the contents of a file for malware.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceSuperUserFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Enable the super user feature -----------</maml:title> <dev:code>PS C:\>Enable-AipServiceSuperUserFeature</dev:code> <dev:remarks> <maml:para>This command enables the super user feature for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044936</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-AipServiceTemplate</command:name> <command:verb>Export</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Exports the properties of a protection template from Azure Information Protection to a file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Export-AipServiceTemplate cmdlet exports all the properties of a protection template from Azure Information Protection to a file. You can then import the template to another tenant using Azure Information Protection, or you can edit the exported template and import it back to the original tenant. You can use this technique to perform bulk edits of complex properties in templates, such as multilingual names and descriptions.</maml:para> <maml:para>Although you can configure protection templates in the Azure portal, you must use PowerShell to export and import these templates.</maml:para> <maml:para>Tip: Consider using this cmdlet as a way to back up your protection templates, so that you can revert to a known-good version if required.</maml:para> <maml:para>The export process does not automatically append a file name extension, so you can specify a file name extension to match the application that you will use to view and edit the resulting data.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to get the GUIDs of all templates.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-AipServiceTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites an existing template file that has the same path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the location where you want to save the file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites an existing template file that has the same path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the location where you want to save the file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Export a template -----------------</maml:title> <dev:code>PS C:\>Export-AipServiceTemplate -Path "C:\MyTemplates\MyTemplateFile.xml" -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428</dev:code> <dev:remarks> <maml:para>This command exports the specified template to the file named MyTemplateFile.xml.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045037</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipService</command:name> <command:verb>Get</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Gets the activation status of the protection service from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipService cmdlet gets the activation status of the protection service from Azure Information Protection for your tenant. The status of the protection service is enabled (activated) or disabled (deactivated).</maml:para> <maml:para>You can also view this information in a management portal. For more information, see Activating the protection service from Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/activate-service).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Get the status of the protection service -----</maml:title> <dev:code>PS C:\>Get-AipService</dev:code> <dev:remarks> <maml:para>This command gets your tenant's activation status of the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044945</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceAdminLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceAdminLog</command:noun> <maml:description> <maml:para>Generates logs for all protection commands for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceAdminLog cmdlet generates logs for all administrative protection commands for Azure Information Protection. You can specify a start time and stop time of entries to include.</maml:para> <maml:para>You must use PowerShell to get these admin logs; you cannot do this action by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceAdminLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites, without prompting for confirmation, an existing log file that has the same path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path and a file name for the log.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites, without prompting for confirmation, an existing log file that has the same path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path and a file name for the log.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Generate a log of all commands ----------</maml:title> <dev:code>PS C:\>Get-AipServiceAdminLog -Path "C:\Temp\AdminLog.log"</dev:code> <dev:remarks> <maml:para>This command generates a log that contains all the administrative protection commands that have been run for your tenant.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Generate a log of commands for a specified time period</maml:title> <dev:code>PS C:\>Get-AipServiceAdminLog -Path "C:\Temp\AdminLog.log" -FromTime "05/01/2015 00:00:00" -ToTime "05/31/2015 23:59:59"</dev:code> <dev:remarks> <maml:para>This command generates a log of administrative protection commands that have been run for your tenant, limited to items that fall within the specific time period by using the FromTime and ToTime parameters. In this example, the time period is all days in May 2015, using the US date format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 3: Generate a log of commands for the last 45 days --</maml:title> <dev:code>PS C:\>$days = (Get-Date).AddDays(-45) PS C:\>Get-AipServiceAdminLog -Path "C:\Temp\AdminLog.log" -FromTime $days</dev:code> <dev:remarks> <maml:para>This command generates a log of administrative protection commands for your tenant, limited to items within the last 45 days (inclusive). The first command sets the variable for the FromTime parameter to be today's date minus 45 days. Then the second command gets the entries from the log for this time period, by using this variable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045046</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Date</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=293966</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceConfiguration</command:noun> <maml:description> <maml:para>Gets the Azure Information Protection configuration of your tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceConfiguration cmdlet gets the current Azure Information Protection configuration of your tenant for the protection service.</maml:para> <maml:para>You must use PowerShell to see a full list of protection configuration values for your tenant; you cannot get this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Display Azure Information Protection configuration for the protection service</maml:title> <dev:code>PS C:\>Get-AipServiceConfiguration BPOSId : 9c11c87a-ac8b-46a3-8d5c-f4d0b72ee29a AzureInformationProtectionServiceId : 5c6bb73b-1038-4eec-863d-49bded473437 LicensingIntranetDistributionPointUrl : https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/licensing LicensingExtranetDistributionPointUrl : https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/licensing CertificationIntranetDistributionPointUrl : https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/certification CertificationExtranetDistributionPointUrl: https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/certification AdminConnectionUrl : https://admin.na.aadrm.com/admin/admin.svc/Tenants/5c6bb73b-1038-4eec-863d-49bded473437 AdminV2ConnectionUrl : https://admin.na.aadrm.com/adminV2/admin.svc/Tenants/5c6bb73b-1038-4eec-863d-49bded473437 OnPremiseDomainName : Keys : {c46b5d49-1c4c-4a79-83d1-ec12a25f3134} CurrentLicensorCertificateGuid : c46b5d49-1c4c-4a79-83d1-ec12a25f3134 Templates : { c46b5d49-1c4c-4a79-83d1-ec12a25f3134, 5c6d36g9-c24e-4222-7786e-b1a8a1ecab60} FunctionalState : Enabled SuperUsersEnabled : Disabled SuperUsers : {admin3@contoso.com, admin4@contoso.com} AdminRoleMembers : {Global Administrator -> 5834f4d6-35d2-455b-a134-75d4cdc82172, ConnectorAdministrator -> 5834f4d6-35d2-455b-a134-75d4cdc82172} KeyRolloverCount : 0 ProvisioningDate : 1/30/2014 9:01:31 PM IPCv3FunctionalState : Enabled DevicePlatformState : {Windows -> True, WindowsStore -> True, WindowsPhone -> True, Mac -> FciEnabledForConnectorAuthorization : True DocumentTrackingFeatureState : Enabled</dev:code> <dev:remarks> <maml:para>This command displays the current protection configuration for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044949</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceDevicePlatform</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDevicePlatform</command:noun> <maml:description> <maml:para>Gets the device platforms in your organization that support the protection service from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDevicePlatform cmdlet gets the device platforms in your organization that support the protection service from Azure Information Protection. For information about supported device platforms, see the Enable-AipServiceDevicePlatform cmdlet.</maml:para> <maml:para>You must use PowerShell to view this configuration; you cannot view this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDevicePlatform</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet gets the protection support status of all device platforms.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AipServiceDevicePlatform</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet gets the protection support status of all device platforms.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get specific device platforms that support the protection service</maml:title> <dev:code>PS C:\>Get-AipServiceDevicePlatform -WindowsPhone -WindowStore Key Value ----- ------ WindowsStore True WindowsPhone True</dev:code> <dev:remarks> <maml:para>This command determines whether Windows Phone and Windows Store device platforms in your organization support the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get all device platforms that support the protection service</maml:title> <dev:code>PS C:\>Get-AipServiceDevicePlatform -All</dev:code> <dev:remarks> <maml:para>This command determines which of all device platforms in your tenant support the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045055</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceDocumentLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDocumentLog</command:noun> <maml:description> <maml:para>Gets protection information about documents that are tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDocumentLog cmdlet returns protection information about the tracked documents for a specified user if that user protected documents (the Rights Management issuer) or was the Rights Management owner for documents, or protected documents were configured to grant access directly to the user. This cmdlet helps to answer the question "How are documents protected for a specified user?" The information returned includes:</maml:para> <maml:para>- The document content ID, with the document name if available.</maml:para> <maml:para>- The Rights Management owner and Rights Management issuer.</maml:para> <maml:para>- The users and groups that were granted access.</maml:para> <maml:para>- The protection template ID or specific usage rights that protects the document.</maml:para> <maml:para>- Any expiry, offline access, or revocation setting.</maml:para> <maml:para></maml:para> <maml:para>For more information about the Rights Management owner and IRights Management issuer (https://docs.microsoft.com/information-protection/deploy-use/configure-usage-rights#rights-management-issuer-and-rights-management-owner).</maml:para> <maml:para>You can specify a start time and stop time of entries to include. The output is returned as a list of PowerShell objects in the PowerShell console.</maml:para> <maml:para>You can alternatively use the document tracking site to get the protection information about the tracked documents. For more information, see the Tracking and revoking documents for users (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#tracking-and-revoking-documents-for-users)section in the Azure Information Protection client admin guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDocumentLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the protection information for documents if that user protected documents (the Rights Management issuer) or was the Rights Management owner for documents, or protected documents were configured to grant access directly to the user. Group addresses are not supported with this cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the protection information for documents if that user protected documents (the Rights Management issuer) or was the Rights Management owner for documents, or protected documents were configured to grant access directly to the user. Group addresses are not supported with this cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get protection information about all tracked documents for a user</maml:title> <dev:code>PS C:\>Get-AipServiceDocumentLog -UserEmail "test@contoso.com"</dev:code> <dev:remarks> <maml:para>This command gets protection information about the tracked documents for a user who has the email address of "test@contoso.com" and that user is the Rights Management issuer or Rights Management owner for the document, or the document was configured to grant access to that user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get protection information about tracked documents for a user, for a specific time period</maml:title> <dev:code>PS C:\>Get-AipServiceDocumentLog -UserEmail "test@contoso.com" -FromTime "01/01/2018 00:00:00" -ToTime "01/31/2018 23:59:59"</dev:code> <dev:remarks> <maml:para>This command is the same as the previous example except that results are limited to documents that were protected within a specific time period by using the FromTime and ToTime parameters. In this example, the time period is all days in January 2018, using the US date format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get protection information about all tracked documents for a user and save the results to a .csv file</maml:title> <dev:code>PS C:\>$documentLogs = Get-AipServiceDocumentLog -UserEmail "test@microsoft.com" PS C:\>$documentLogs | Export-Csv 'C:\Temp\DocumentLog.csv' -NoTypeInformation</dev:code> <dev:remarks> <maml:para>The first command gets the protection information about the tracked documents for a user who has the email address of "test@contoso.com" and that user is the Rights Management issuer or Rights Management owner for the document, or the document was configured to grant access to that user. The information is saved in a variable.</maml:para> <maml:para>The second command then uses the Export-Csv (https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/export-csv?view=powershell-4.0)cmdlet to convert the protection information into .csv format, and saves it to the C:\Temp\DocumentLog.csv file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044954</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTrackingLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceDocumentTrackingFeature</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDocumentTrackingFeature</command:noun> <maml:description> <maml:para>Indicates whether document tracking is enabled or disabled for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDocumentTrackingFeature cmdlet indicates whether the Azure Information Protection document tracking feature is enabled or disabled.</maml:para> <maml:para>You must use PowerShell to get this information about document tracking; you cannot get this information by using a management portal.</maml:para> <maml:para>For additional information about the document tracking site, see Configuring and using document tracking for Azure Information Protection (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking)from the Azure Information Protection client administrator guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDocumentTrackingFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example: Determine whether the document tracking site is enabled</maml:title> <dev:code>PS C:\>Get-AipServiceDocumentTrackingFeature</dev:code> <dev:remarks> <maml:para>This command determines whether the Azure Information Protection document tracking feature is enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045059</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceDoNotTrackUserGroup</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDoNotTrackUserGroup</command:noun> <maml:description> <maml:para>Gets the group for the users who must not be tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDoNotTrackUserGroup cmdlet gets the email address of the currently configured group for the users who must not be tracked by the Azure Information Protection document tracking feature. </maml:para> <maml:para>This configuration might be needed for privacy requirements. For more information, see Privacy controls for your document tracking site (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#privacy-controls-for-your-document-tracking-site).</maml:para> <maml:para>You must use PowerShell to retrieve this information; you cannot see it by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDoNotTrackUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>This operation returns the group email address as a String . If a group has not been configured, an empty String is returned.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Get-AipServiceDoNotTrackUserGroup</dev:code> <dev:remarks> <maml:para>This command gets the email address of the currently configured group for the users who will not be tracked with the document tracking feature.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044894</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceIPCv3</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceIPCv3</command:noun> <maml:description> <maml:para>Displays whether the MSIPC v3 service is enabled or disabled for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceIPCv3 cmdlets displays the status of the MSIPC v3 platform on mobile devices such as iOS and Android. This platform must be enabled to support protection from Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to view this configuration; you cannot view this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceIPCv3</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example1: Display whether the MSIPC v3 platform for iOS and Android devices is enabled</maml:title> <dev:code>PS C:\>Get-AipServiceIPCv3</dev:code> <dev:remarks> <maml:para>This command displays whether the MSIPC v3 platform is enabled or disabled. This platform must be enabled on iOS and Android mobile devices to support protection from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045170</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceKeys</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceKeys</command:noun> <maml:description> <maml:para>Lists all Azure Information Protection tenant keys associated with your tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceKeys cmdlet lists all Azure Information Protection tenant keys associated with your tenant. The tenant keys include the initial tenant key that Microsoft generates for you, and any tenant keys that are stored in Azure Key Vault. For more information, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For security reasons, the cmdlet does not display the value of the tenant keys.</maml:para> <maml:para>When you run this cmdlet, you will see Status and KeyType :</maml:para> <maml:para>- The Status value shows Archived or Active . Archived identifies a tenant key that can be used to open previously protected content. Active identities the tenant key is currently in use to protect content.</maml:para> <maml:para>- The KeyType value shows Microsoft-managed or Customer-managed (BYOK) . Microsoft-managed identifies the tenant key as managed by Microsoft (the default). Customer-managed identifies the tenant key as managed by your organization in Azure Key Vault. For a customer-managed key, you also see Publickey , which shows the base-64 encoded public key that is associated with the KeyIdentifier and that corresponds to the same information that Azure Key Vault provides for your key.</maml:para> <maml:para>For security reasons, the cmdlet does not display the value of the Microsoft-managed key and displays only the public key information of customer-managed (BYOK) keys.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceKeys</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------- Example 1: Get keys ---------------------</maml:title> <dev:code>PS C:\>Get-AipServiceKeys</dev:code> <dev:remarks> <maml:para>This command lists all Azure Information Protection tenant keys associated with your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044896</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTpd</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Planning and implementing your Azure Information Protection tenant key</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceMaxUseLicenseValidityTime</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceMaxUseLicenseValidityTime</command:noun> <maml:description> <maml:para>Gets the maximum validity time for Rights Management use licenses from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceMaxUseLicenseValidityTime cmdlet gets the maximum validity time for your tenant, in days, for Azure Rights Management use licenses from Azure Information Protection. The default value is 30 days.</maml:para> <maml:para>You must use PowerShell to view this configuration at the organization level; you cannot view this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceMaxUseLicenseValidityTime</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Get the maximum validity time -----------</maml:title> <dev:code>PS C:\>Get-AipServiceMaxUseLicenseValidityTime 30</dev:code> <dev:remarks> <maml:para>This command gets the maximum validity time for use licenses for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=529558https://go.microsoft.com/fwlink/?linkid=2045179</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceMaxUseLicenseValidityTime</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceMigrationUrl</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceMigrationUrl</command:noun> <maml:description> <maml:para>Gets the migration URL for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceMigrationUrl cmdlet gets the migration URL for Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to get this information; you cannot get the migration URL by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceMigrationUrl</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Get the migration URL ---------------</maml:title> <dev:code>PS C:\>Get-AipServiceMigrationUrl</dev:code> <dev:remarks> <maml:para>This command gets the migration URL for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=2092222</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceMigrationUrl</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceOnboardingControlPolicy</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceOnboardingControlPolicy</command:noun> <maml:description> <maml:para>Gets the user on-boarding control policy for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceOnboardingControlPolicy cmdlet obtains your Azure Information Protection user on-boarding control policy to support a gradual deployment by controlling which users in your organization can protect content by using Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to view this configuration; you cannot view this configuration by using a management portal.</maml:para> <maml:para>This control can be based on assigned user licenses for the Azure Rights Management service or membership in a designated security group. You can also define whether the policy applies to just mobile devices, just Windows clients, or mobile devices and Windows clients. For more information, see Set-AipServiceOnboardingControlPolicy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceOnboardingControlPolicy</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Get the user on-boarding control policy ------</maml:title> <dev:code>PS C:\> Get-AipServiceOnboardingControlPolicy</dev:code> <dev:remarks> <maml:para>This command displays the user on-boarding control policy for Azure Information Protection for your organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045203</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceOnboardingControlPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceRoleBasedAdministrator</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceRoleBasedAdministrator</command:noun> <maml:description> <maml:para>Gets the role-based administrators for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceRoleBasedAdministrator cmdlet gets the role-based administrators for the protection service from Azure Information Protection. You can get the administrators for a specified role.</maml:para> <maml:para>You must use PowerShell to configure delegated administrative control for the protection service; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet gets the administrators that belong to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet gets the administrators that belong to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: List administrators ----------------</maml:title> <dev:code>PS C:\>Get-AipServiceRoleBasedAdministrator</dev:code> <dev:remarks> <maml:para>This command lists the role-based administrators for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045180</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceSuperUser</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceSuperUser</command:noun> <maml:description> <maml:para>Gets the super users for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceSuperUser cmdlet gets the super users for Azure Information Protection, who can unprotect or protect files for your organization when the super user feature is enabled by using the Enable-AipServiceSuperUserFeature cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceSuperUser</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: List super users -----------------</maml:title> <dev:code>PS C:\>Get-AipServiceSuperUser</dev:code> <dev:remarks> <maml:para>This command lists the super users for Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045209</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configuring super users for Azure Information Protection and discovery services or data recovery</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/configure-super-users</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceSuperUserFeature</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceSuperUserFeature</command:noun> <maml:description> <maml:para>Gets the status of the super user feature for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceSuperUserFeature cmdlet gets the status of the super user feature for Azure Information Protection for your organization. The super user feature can be enabled or disabled. By default, it is disabled.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users)on the Microsoft documentation site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceSuperUserFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Get the status of the super user feature -----</maml:title> <dev:code>PS C:\>Get-AipServiceSuperUserFeature Enabled</dev:code> <dev:remarks> <maml:para>This command gets the status (Enabled or Disabled) of the super user feature in your organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045212</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure Information Protection and discovery services or data recovery</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/configure-super-users</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceSuperUserGroup</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceSuperUserGroup</command:noun> <maml:description> <maml:para>Gets the super user group for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceSuperUserGroup cmdlet gets the email address of the Azure Information Protection super user group for your organization. This cmdlet does not get users that are individually assigned as super users with the Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceSuperUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>This operation returns the super user group email address as a String . If no super user group exists, an empty String is returned.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Get the super user group -------------</maml:title> <dev:code>PS C:\>Get-AipServiceSuperUserGroup</dev:code> <dev:remarks> <maml:para>This command gets the email address of the super user group for an organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045194</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configuring super users for Azure Information Protection and discovery services or data recovery</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/configure-super-users</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceTemplate</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Gets a list of protection templates for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceTemplate cmdlet gets all existing or selected protection templates from Azure Information Protection. Use the TemplateID parameter to get a specific template. If you do not specify the TemplateId , all templates are retrieved.</maml:para> <maml:para>Similar configuration information can also be viewed in the Azure portal, but this cmdlet also returns the template GUID that isn't available in the portal.</maml:para> <maml:para>The cmdlet output is a list of template objects that contain all the template properties that you can use for further processing. The output of this command displays the template GUID, name, and description in the current locale. For additional template properties, such as usage rights and whether the template is published or archived, use the Get-AipServiceTemplateProperty cmdlets.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TemplateID</maml:name> </dev:type> <maml:description> <maml:para>Specifies the GUID of the protection template to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para>This cmdlet outputs a list comprising all protection templates for the tenant, or for a selected template.</maml:para> <maml:para>If no name is defined for a template in the current locale, "No name defined in language-code" is returned as the name for that template.</maml:para> <maml:para>If no description is defined for a template in the current locale, "No description defined in language-code" is returned as the description for that template.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Get all templates -----------------</maml:title> <dev:code>PS C:\> Get-AipServiceTemplate</dev:code> <dev:remarks> <maml:para>This command gets all templates for your tenant, so you can get the template ID that you want to use, by identifying the template by its name and description.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 2: Get a specific template --------------</maml:title> <dev:code>PS C:\> Get-AipServiceTemplate -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428</dev:code> <dev:remarks> <maml:para>This command gets a specific template, specified by its template ID (GUID), so that you can confirm from its name and description that it is the template that you want to use.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045197</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceTemplateProperty</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceTemplateProperty</command:noun> <maml:description> <maml:para>Gets the properties of a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceTemplateProperty cmdlet gets specified properties of a protection template for Azure Information Protection, by using the TemplateId parameter.</maml:para> <maml:para>Similar configuration information can also be viewed in the Azure portal, but this cmdlet also includes the template GUID.</maml:para> <maml:para>You can query properties of a default template, or a custom template. For more information about custom templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceTemplateProperty</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Lists the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Gets the content expiration configuration setting for content that is protected with the template.</maml:para> <maml:para>One of the following values is returned:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days from the day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to AfterDays.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Lists the descriptions for the template in all locales.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Indicates the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box when you configure APPLICATION COMPATIBILITY in the Azure classic portal (now retired). There is no equivalent setting in the Azure portal.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days content is accessible offline after a license to consume it is acquired.</maml:para> <maml:para>-1 indicates unlimited access.</maml:para> <maml:para>0 indicates that a license must be obtained for each use and that content is only available online.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Lists the names for the template in all locales.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:Description> <maml:para>Indicates whether the template is a default template (True) and therefore cannot be edited or deleted, or a custom template (False) and therefore can be edited or deleted by an administrator.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Lists the rights granted to users or groups for the content that is protected with the template.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The status of the template:</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not displayed to users.</maml:para> <maml:para>-- Published templates are available to users to protect content.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to obtain the template ID of all templates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Lists the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Gets the content expiration configuration setting for content that is protected with the template.</maml:para> <maml:para>One of the following values is returned:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days from the day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to AfterDays.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Lists the descriptions for the template in all locales.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Indicates the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box when you configure APPLICATION COMPATIBILITY in the Azure classic portal (now retired). There is no equivalent setting in the Azure portal.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days content is accessible offline after a license to consume it is acquired.</maml:para> <maml:para>-1 indicates unlimited access.</maml:para> <maml:para>0 indicates that a license must be obtained for each use and that content is only available online.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Lists the names for the template in all locales.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:Description> <maml:para>Indicates whether the template is a default template (True) and therefore cannot be edited or deleted, or a custom template (False) and therefore can be edited or deleted by an administrator.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Lists the rights granted to users or groups for the content that is protected with the template.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The status of the template:</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not displayed to users.</maml:para> <maml:para>-- Published templates are available to users to protect content.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to obtain the template ID of all templates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get the description and the usage rights for a template</maml:title> <dev:code>PS C:\>Get-AipServiceTemplateProperty -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428 -Descriptions -RightsDefinitions</dev:code> <dev:remarks> <maml:para>This command gets the description and the usage rights for all users or groups that are configured for the specified protection template.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: For all templates, get the name, the usage rights, whether a default template, and whether published or archived</maml:title> <dev:code>PS C:\>$templates = Get-AipServiceTemplate PS C:\>foreach ($template in $templates) {Get-AipServiceTemplateProperty -TemplateId $template.TemplateId -Name -RightsDefinitions -ReadOnly -Status}</dev:code> <dev:remarks> <maml:para>The first command gets all the template IDs and stores them in a variable. The second command then uses this variable to get the template name, the usage rights, whether it is read-only (True for a default template, False for a custom template), and the status (Published or Archived) for each template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045221</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceTemplateProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceTrackingLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceTrackingLog</command:noun> <maml:description> <maml:para>Gets tracking information for documents protected by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceTrackingLog cmdlet returns tracking information about protected documents for a specified user who protected documents (the Rights Management issuer) or who accessed protected documents. This cmdlet helps to answer the question "Which protected documents did a specified user track or access?" Information returned includes:</maml:para> <maml:para>- The document content ID, with the document name if available.</maml:para> <maml:para>- The Rights Management issuer.</maml:para> <maml:para>- The users who accessed the document, when, and from what location.</maml:para> <maml:para>- What protection template ID or specific usage rights were used to protect the document and whether access was granted or denied.</maml:para> <maml:para></maml:para> <maml:para>You can specify a start time and stop time of entries to include. The output is returned as a list of PowerShell objects in the PowerShell console.</maml:para> <maml:para>You can alternatively use the document tracking site to get the protection information about the tracked documents. For more information, see the Tracking and revoking documents for users (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#tracking-and-revoking-documents-for-users)section in the admin guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceTrackingLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the tracking information for documents that were protected by, or accessed by the user who has this email address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the tracking information for documents that were protected by, or accessed by the user who has this email address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Get all tracking information for a user ------</maml:title> <dev:code>PS C:\>Get-AipServiceTrackingLog -UserEmail "test@contoso.com"</dev:code> <dev:remarks> <maml:para>This command generates a log of all the tracking information for documents that were protected by or accessed by the user with the email address "test@contoso.com".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get tracking information for a user, for a specific time period</maml:title> <dev:code>PS C:\>Get-AipServiceTrackingLog -UserEmail "test@contoso.com" -FromTime "01/01/2018 00:00:00" -ToTime "01/31/2018 23:59:59"</dev:code> <dev:remarks> <maml:para>This command is the same as the previous example except that the results are limited to documents that were tracked within a specific time period by using the FromTime and ToTime parameters. In this example, the time period is all days in January 2018, using the US date format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get all tracking information for a user and save the results to a .csv file</maml:title> <dev:code>PS C:\>$trackingLogs = Get-AipServiceTrackingLog -UserEmail "test@contoso.com" PS C:\>$trackingLogs | Export-Csv 'C:\Temp\TrackingLog.csv' -NoTypeInformation</dev:code> <dev:remarks> <maml:para>The first command generates a log of all the tracking information for documents that were protected by or accessed by the user with the email address "test@contoso.com", and saves the result in a variable.</maml:para> <maml:para>The second command then uses the Export-Csv (https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/export-csv?view=powershell-4.0)cmdlet to convert the tracking information into .csv format, and saves it to the C:\Temp\TrackingLog.csv file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045300</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDocumentLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AipServiceUserLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceUserLog</command:noun> <maml:description> <maml:para>Downloads protection user logs from Azure Information Protection to local storage.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceUserLog cmdlet downloads protection user logs to local storage. You must specify either a specific date or a date range to download the log entries.</maml:para> <maml:para>You must use PowerShell to get these user logs; you cannot do this action by using a management portal.</maml:para> <maml:para>When you run this command and specify a date only for the DateTime objects, the time is assumed to be 00:00:00 in your local time, and then converted to UTC. </maml:para> <maml:para>When you specify a time with a date (for example, -ForDate "2/1/2016 15:00:00"), that date and time is converted to UTC. The Get-AipServiceUserLog command then gets the logs for that UTC time period. </maml:para> <maml:para>See the examples for how you might need to change your DateTime values, to accommodate the conversion needed for your local time.</maml:para> <maml:para>For more information about protection usage logging and a step-by-step example, see Logging and analyzing protection usage from Azure In formation Protection (https://docs.microsoft.com/information-protection/deploy-use/log-analyze-usage).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceUserLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForDate</maml:name> <maml:Description> <maml:para>Specifies a date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the FromDate parameter. </maml:para> <maml:para>To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet overwrites, without prompting for confirmation, an existing log file for the same date or date range.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromDate</maml:name> <maml:Description> <maml:para>Specifies the start date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the ForDate parameter.</maml:para> <maml:para>If you specify this parameter but not the ToDate , the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NumberOfThreads</maml:name> <maml:Description> <maml:para>Specifies the number of threads to use to download logs.</maml:para> <maml:para>The acceptable values for this parameter are: 1-32. </maml:para> <maml:para>The default value is 3.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path of the folder in which to save the logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:Description> <maml:para>Specifies the stop date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Optionally, specify this parameter when you use the FromDate parameter, to specify a specific date range. If you do not specify this parameter when you use the FromDate parameter, the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForDate</maml:name> <maml:Description> <maml:para>Specifies a date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the FromDate parameter. </maml:para> <maml:para>To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet overwrites, without prompting for confirmation, an existing log file for the same date or date range.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FromDate</maml:name> <maml:Description> <maml:para>Specifies the start date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the ForDate parameter.</maml:para> <maml:para>If you specify this parameter but not the ToDate , the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NumberOfThreads</maml:name> <maml:Description> <maml:para>Specifies the number of threads to use to download logs.</maml:para> <maml:para>The acceptable values for this parameter are: 1-32. </maml:para> <maml:para>The default value is 3.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path of the folder in which to save the logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:Description> <maml:para>Specifies the stop date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Optionally, specify this parameter when you use the FromDate parameter, to specify a specific date range. If you do not specify this parameter when you use the FromDate parameter, the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Get user logs for a date range ----------</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -FromDate 12/12/2015 -ToDate 12/15/2015 -NumberOfThreads 10</dev:code> <dev:remarks> <maml:para>This command downloads user logs created between 12/12/2015 and 12/15/2015 (in UTC time) to the folder C:\Logs. </maml:para> <maml:para>The command uses 10 threads to download the logs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------- Example 2: Get user logs for a date -------------</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -ForDate 12/5/2015</dev:code> <dev:remarks> <maml:para>This command downloads the user logs for 12/5/2015 (in UTC time) to the folder C:\Logs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get user logs for a date, taking into account a UTC +offset time conversion</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -ForDate 2/2/2016 12:00:00</dev:code> <dev:remarks> <maml:para>This command shows how you might need to take into account a UTC +offset time conversion from your local time, before downloading user logs to the folder C:\Logs.</maml:para> <maml:para>You are in New Zealand, which means your computer's local time is UTC+12 and you want to download logs for 2/2/2016 for your local time rather than UTC. If you didn't specify the time of 12:00:00 with the date, your logs would contain data for only the first 12 hours of 2/2/2016 (and the last 12 hours of the previous day).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Get user logs for a date range, taking into account a UTC -offset time conversion</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -FromDate 2/1/2016 18:00:00 -ToDate 2/9/15/2016 18:00:00</dev:code> <dev:remarks> <maml:para>This command shows how you might need to take into account a UTC -offset time conversion from your local time before downloading user logs to the folder C:\Logs.</maml:para> <maml:para>You are in Houston, USA, which means your computer's local time is UTC-6 and you want to download logs from 2/2/2016 through 2/9/2016 for your local time rather than UTC. </maml:para> <maml:para>If you didn't specify the previous date and time of 18:00:00, your logs would be missing data for the first 6 hours of 2/2/2016 your local time (and an additional 6 hours for the ending date).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045502</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Date</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=293966</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Logging and analyzing protection usage by Azure Information Protection</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/log-analyze-usage</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-AipServiceTemplate</command:name> <command:verb>Import</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Creates a custom protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Import-AipServiceTemplate cmdlet creates a custom protection template for Azure Information Protection and sets its properties according to data contained in a template file.</maml:para> <maml:para>Although you can configure protection templates in the Azure portal, you must use PowerShell to export and import these templates.</maml:para> <maml:para>The file you import must be a valid protection template file that has been exported from Azure Information Protection or AD RMS. The file can have any file name extension.</maml:para> <maml:para>If you import a template file identified by a GUID that matches the GUID of an existing template for the tenant, the original template is overwritten without warning. During the import operation, the GUID for the new template is set to the GUID in the input file, so the new template is valid to consume content protected with the imported template as long as Azure Information Protection has the necessary decryption keys.</maml:para> <maml:para>If the name of the template in the import file matches the name of an existing template for the tenant in any language, you will have two templates with the same name.</maml:para> <maml:para>You can store a maximum of 500 custom templates (published or archived) in Azure. If you can't import templates because you have reached this limit as a result of keeping many archived templates, consider exporting them to save the information locally and then removing these templates from Azure Information Protection.</maml:para> <maml:para>For more information about protection templates, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-AipServiceTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the template file to import.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the template file to import.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Import a template file --------------</maml:title> <dev:code>PS C:\>Import-AipServiceTemplate -Path "C:\MyTemplates\MyFile.xml"</dev:code> <dev:remarks> <maml:para>This command imports a template file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045508</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-AipServiceTpd</command:name> <command:verb>Import</command:verb> <command:noun>AipServiceTpd</command:noun> <maml:description> <maml:para>Imports a TPD from AD RMS for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Import-AipServiceTpd cmdlet imports an Active Directory Rights Management Services (AD RMS) trusted publishing domain (TPD) over the Internet into your tenant for Azure Information Protection, so that you can migrate your protection service from on-premises to the cloud. The TPD contains your private key and protection templates from AD RMS.</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>This cmdlet always sets the key from the imported TPD to an archived state. After you run this command, the key in the imported TPD becomes available to Azure Information Protection to consume content that AD RMS protected by using this key. Use the Set-AipServiceKeyProperties cmdlet to change the state of the imported TPD to Active.</maml:para> <maml:para>Warning: Do not run this cmdlet unless you have read and understood the requirements, restrictions, instructions, and implications of migrating from AD RMS. For more information, see Migrating from AD RMS to Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/migrate-from-ad-rms-to-azure-rms).</maml:para> <maml:para>If you migrate templates from AD RMS as active, you can edit these templates in the Azure portal, or by using PowerShell. You can publish these templates so that users can select them from applications. If the migrated templates are not activated, they can only be used to open documents that they previously protected.</maml:para> <maml:para>You must use the AD RMS management console to export the TPD. If you use a hardware security module (HSM) for your keys, you must first repackage the TPD keys by using the Azure Key Vault BYOK tools. You can download these tools from the Microsoft Download Site (https://www.microsoft.com/download/details.aspx?id=45345). For more information, see [How to generate and transfer HSM-protected keys for Azure Key Vault](https://docs.microsoft.com/azure/key-vault/key-vault-hsm-protected-keys).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-AipServiceTpd</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab.</maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ProtectionPassword</maml:name> <maml:Description> <maml:para>Specifies the password that was used to encrypt the exported TPD file.</maml:para> <maml:para>You can use either ConvertTo-SecureString -AsPlaintext or Read-Host to specify the SecureString.</maml:para> <!--[SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Help file provides example of acceptable password in the proper format.")]--> <maml:para>When you use ConvertTo-SecureString and the password has special characters, enter the password between single quotes or escape the special characters. If you do not, the password will not parse correctly and in verbose mode, you will see the following error messages: VERBOSE: Trusted Publishing Domain data is corrupted. VERBOSE: The remote server returned an unexpected response: (400) Bad Request. For example, if your password is Pa$$word , enter 'Pa$$word' or Pa`$`$word so that Windows PowerShell can correctly parse the special characters. As a full example, you might type $pwd = ConvertTo-SecureString 'Pa$$w0rd' -AsPlainText -Force and then to check that the stored value is correct, type $pwd to confirm that Pa$$word is displayed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TpdFile</maml:name> <maml:Description> <maml:para>Specifies the TPD file exported from your AD RMS cluster to import to your tenant to use for Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab.</maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ProtectionPassword</maml:name> <maml:Description> <maml:para>Specifies the password that was used to encrypt the exported TPD file.</maml:para> <maml:para>You can use either ConvertTo-SecureString -AsPlaintext or Read-Host to specify the SecureString.</maml:para> <!--[SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Help file provides example of acceptable password in the proper format.")]--> <maml:para>When you use ConvertTo-SecureString and the password has special characters, enter the password between single quotes or escape the special characters. If you do not, the password will not parse correctly and in verbose mode, you will see the following error messages: VERBOSE: Trusted Publishing Domain data is corrupted. VERBOSE: The remote server returned an unexpected response: (400) Bad Request. For example, if your password is Pa$$word , enter 'Pa$$word' or Pa`$`$word so that Windows PowerShell can correctly parse the special characters. As a full example, you might type $pwd = ConvertTo-SecureString 'Pa$$w0rd' -AsPlainText -Force and then to check that the stored value is correct, type $pwd to confirm that Pa$$word is displayed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TpdFile</maml:name> <maml:Description> <maml:para>Specifies the TPD file exported from your AD RMS cluster to import to your tenant to use for Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Import TPD with a software key ----------</maml:title> <dev:code>PS C:\>$Password = Read-Host -AsSecureString -Prompt "Password: " PS C:\> Import-AipServiceTpd -TpdFile "C:\aipservice_tpd.xml" -ProtectionPassword $Password -Verbose</dev:code> <dev:remarks> <maml:para>The first command creates a password as a secure string by using the Read-Host cmdlet, and then stores the secure string in the $Password variable. For more information, type `Get-Help Read-Host`.</maml:para> <maml:para>The second command imports a TPD with a software key.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 2: Import TPD with an HSM key ------------</maml:title> <dev:code>PS C:\>$Password = Read-Host -AsSecureString -Prompt "Password: " PS C:\> Import-AipServiceTpd -TpdFile "C:\no_key_tpd.xml" -ProtectionPassword $Password -KeyVaultKeyUrl "https://contoso-byok-kv.vault.azure.net/keys/contosoaipservice-byok/aaaabbbbcccc111122223333" -FriendlyName "Contoso BYOK key" -Verbose</dev:code> <dev:remarks> <maml:para>The first command creates a password as a secure string, and then stores the secure string in the $Password variable.</maml:para> <maml:para>The second command imports a TPD to be used with a key that is stored in Azure Key Vault. Additionally, the command changes the friendly name of the key to "Contoso BYOK key".</maml:para> <maml:para>Our example uses the key vault name of contoso-byok-kv, the key name of contosoaipservice-byok, and the version number of aaaabbbbcccc111122223333.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045514</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceKeyProperties</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Migrating from AD RMS to Azure Information Protection</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/plan-design/migrate-from-ad-rms-to-azure-rms</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>How to generate and transfer HSM-protected keys for Azure Key Vault</maml:linkText> <maml:uri>https://docs.microsoft.com/azure/key-vault/key-vault-hsm-protected-keys</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AipServiceRightsDefinition</command:name> <command:verb>New</command:verb> <command:noun>AipServiceRightsDefinition</command:noun> <maml:description> <maml:para>Creates a rights definition object for a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-AipServiceRightsDefinition cmdlet creates a rights definition object that you store as a variable and then use to create or update a protection template for Azure Information Protection when you use the Add-AipServiceTemplate or Set-AipServiceTemplateProperty cmdlet.</maml:para> <maml:para>A rights definition object expresses the usage rights that users have to content that Azure Information Protection protects. You can specify a user, a group, or all users in an organization. </maml:para> <maml:para>Similar configuration can also be done when you create or configure a protection template in the Azure portal, but this cmdlet offers more fine-grained control. However, this cmdlet does not support the any authenticated users option (https://docs.microsoft.com/azure/information-protection/deploy-use/configure-policy-protection#more-information-about-add-any-authenticated-users)that you can select in the Azure portal.</maml:para> <maml:para>Tip: You can this cmdlet to enable secure collaboration with other organizations when they have user accounts in Azure Active Directory and Office 365. For example, provide an external group VIEW and DOCEDIT rights to collaborate on a joint project. Or, provide VIEW rights to all users in a partner organization.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AipServiceRightsDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Specifies a domain name for your organization or another organization, to be used for granting rights when you create or update a protection template. When an organization has more than one domain, it does not matter which domain name you specify; users from all verified domains for that organization are automatically included. </maml:para> <maml:para>Specify one domain name only for all users in an organization; to grant rights to more than one organization, create another rights definition object.</maml:para> <maml:para>Note that for authentication to be successful for Azure AD, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory. </maml:para> <maml:para>You can specify domain names from social providers (such as gmail.com) but authentication for accounts that are not in Azure AD are supported for email only, and when Exchange Online is configured for the new capabilities for Office 365 Message Encryption.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. The user or group can be internal to your organization, or external. For Azure AD authentication to be successful, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory.</maml:para> <maml:para>Other authentication methods include email address from a social provider (for example, a Gmail account) when Exchange Online is configured for the new capabilities for Office 365 Message Encryption. Some applications also support personal email addresses with a Microsoft account. For more information about using Microsoft accounts for authentication, see the supported scenarios table (https://docs.microsoft.com/azure/information-protection/get-started/secure-collaboration-documents#supported-scenarios-for-opening-protected-documents). </maml:para> <maml:para>The cmdlet associates the rights that the Rights parameter specifies to the user or group that the address specifies.</maml:para> <maml:para>Tip: If you want to specify all users in your organization or all users in another organization, use the DomainName parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Rights</maml:name> <maml:Description> <maml:para>Specifies a list of rights. The list contains one or more of the following:</maml:para> <maml:para>- VIEW : Interpreted by most applications as allowed to present the data on the screen.</maml:para> <maml:para>- EDIT : Interpreted by most applications as allowed to modify content in the document and save it.</maml:para> <maml:para>- DOCEDIT : Interpreted by most applications as allowed to modify the content of the document.</maml:para> <maml:para>- EXTRACT : Interpreted by most applications as allowed to copy the content to the clipboard or otherwise extract the content in unencrypted form.</maml:para> <maml:para>- OBJMODEL : Interpreted by most applications as allowed to access the document programmatically; for example, by using macros.</maml:para> <maml:para>- EXPORT : Interpreted by most applications as allowed to save the file in unencrypted form. For example, this right allows you to save in a different file format that does not support protection.</maml:para> <maml:para>- PRINT : Interpreted by most applications as allowed to print the document.</maml:para> <maml:para>- OWNER : User has all rights on the document, including the ability to remove protection.</maml:para> <maml:para>- FORWARD : Interpreted by most applications as allowed to forward an email message, and to add recipients to the To and Cc lines.</maml:para> <maml:para>- REPLY : Interpreted by most applications as allowed to select reply to an email message, without allowing changes in the To or Cc lines.</maml:para> <maml:para>- REPLYALL : Interpreted by most applications as allowed to reply to all recipients of an email message, but does not allow the user to add recipients to the To or Cc lines.</maml:para> <maml:para>Note: For clarity, the documentation and display text from the module shows these rights as all upper-case letters. However, the values are not case-sensitive and you can specify them in lower or upper case.</maml:para> <maml:para>For more information about the usage rights, see Configuring usage rights for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-usage-rights).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Specifies a domain name for your organization or another organization, to be used for granting rights when you create or update a protection template. When an organization has more than one domain, it does not matter which domain name you specify; users from all verified domains for that organization are automatically included. </maml:para> <maml:para>Specify one domain name only for all users in an organization; to grant rights to more than one organization, create another rights definition object.</maml:para> <maml:para>Note that for authentication to be successful for Azure AD, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory. </maml:para> <maml:para>You can specify domain names from social providers (such as gmail.com) but authentication for accounts that are not in Azure AD are supported for email only, and when Exchange Online is configured for the new capabilities for Office 365 Message Encryption.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. The user or group can be internal to your organization, or external. For Azure AD authentication to be successful, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory.</maml:para> <maml:para>Other authentication methods include email address from a social provider (for example, a Gmail account) when Exchange Online is configured for the new capabilities for Office 365 Message Encryption. Some applications also support personal email addresses with a Microsoft account. For more information about using Microsoft accounts for authentication, see the supported scenarios table (https://docs.microsoft.com/azure/information-protection/get-started/secure-collaboration-documents#supported-scenarios-for-opening-protected-documents). </maml:para> <maml:para>The cmdlet associates the rights that the Rights parameter specifies to the user or group that the address specifies.</maml:para> <maml:para>Tip: If you want to specify all users in your organization or all users in another organization, use the DomainName parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Rights</maml:name> <maml:Description> <maml:para>Specifies a list of rights. The list contains one or more of the following:</maml:para> <maml:para>- VIEW : Interpreted by most applications as allowed to present the data on the screen.</maml:para> <maml:para>- EDIT : Interpreted by most applications as allowed to modify content in the document and save it.</maml:para> <maml:para>- DOCEDIT : Interpreted by most applications as allowed to modify the content of the document.</maml:para> <maml:para>- EXTRACT : Interpreted by most applications as allowed to copy the content to the clipboard or otherwise extract the content in unencrypted form.</maml:para> <maml:para>- OBJMODEL : Interpreted by most applications as allowed to access the document programmatically; for example, by using macros.</maml:para> <maml:para>- EXPORT : Interpreted by most applications as allowed to save the file in unencrypted form. For example, this right allows you to save in a different file format that does not support protection.</maml:para> <maml:para>- PRINT : Interpreted by most applications as allowed to print the document.</maml:para> <maml:para>- OWNER : User has all rights on the document, including the ability to remove protection.</maml:para> <maml:para>- FORWARD : Interpreted by most applications as allowed to forward an email message, and to add recipients to the To and Cc lines.</maml:para> <maml:para>- REPLY : Interpreted by most applications as allowed to select reply to an email message, without allowing changes in the To or Cc lines.</maml:para> <maml:para>- REPLYALL : Interpreted by most applications as allowed to reply to all recipients of an email message, but does not allow the user to add recipients to the To or Cc lines.</maml:para> <maml:para>Note: For clarity, the documentation and display text from the module shows these rights as all upper-case letters. However, the values are not case-sensitive and you can specify them in lower or upper case.</maml:para> <maml:para>For more information about the usage rights, see Configuring usage rights for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-usage-rights).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Create a rights definition object for a user ---</maml:title> <dev:code>PS C:\>$R1 = New-AipServiceRightsDefinition -EmailAddress "ElisaDaugherty@Contoso.com" -Rights "VIEW","DOCEDIT"</dev:code> <dev:remarks> <maml:para>This command creates a rights definition object for the specified user and stores this policy in a variable named R1, which can then be used to create or update a protection template. </maml:para> <maml:para>The command includes the rights VIEW and DOCEDIT for a user in the Contoso organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 2: Create a rights definition object for all users --</maml:title> <dev:code>PS C:\>$R2 = New-AipServiceRightsDefinition -DomainName "Contoso.com" -Rights "VIEW"</dev:code> <dev:remarks> <maml:para>This command creates a rights definition object for the Contoso organization and stores this policy in a variable named R2, which can then be used to create or update a protection template. The command includes the VIEW right for all users in the Contoso organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045520</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceTemplateProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AipServiceRoleBasedAdministrator</command:name> <command:verb>Remove</command:verb> <command:noun>AipServiceRoleBasedAdministrator</command:noun> <maml:description> <maml:para>Removes administrative rights from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AipServiceRoleBasedAdministrator cmdlet removes administrative rights from Azure Information Protection, so that administrators you have previously delegated to configure the protection service can no longer do so by using PowerShell commands.</maml:para> <maml:para>You must use PowerShell to configure delegated administrative control for the protection service from Azure Information Protection, you cannot do this configuration by using a management portal.</maml:para> <maml:para>To see the full list of delegated administrators for the protection service, use Get-AipServiceRoleBasedAdministrator. Run the Remove-AipServiceRoleBasedAdministrator cmdlet for each user or group that you want to remove from the list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to remove administrative rights from Azure Information Protection. If the user has no email address, specify the user's Universal Principal Name.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to remove administrative rights from Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group that should no longer have administrative rights for Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to remove administrative rights from Azure Information Protection. If the user has no email address, specify the user's Universal Principal Name.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to remove administrative rights from Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group that should no longer have administrative rights for Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove administrative rights by using a display name</maml:title> <dev:code>PS C:\>Remove-AipServiceRoleBasedAdministrator -SecurityGroupDisplayName "Finance Employees"</dev:code> <dev:remarks> <maml:para>This command removes administrative rights from Azure Information Protection for the group that has a display name of "Finance Employees".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Remove administrative rights by using an email address</maml:title> <dev:code>PS C:\>Remove-AipServiceRoleBasedAdministrator -EmailAddress "EvanNarvaez@Contoso.com"</dev:code> <dev:remarks> <maml:para>This command removes administrative rights from Azure Information Protection for the user who has an email address of "EvanNarvaez@Contoso.com".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045318</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AipServiceSuperUser</command:name> <command:verb>Remove</command:verb> <command:noun>AipServiceSuperUser</command:noun> <maml:description> <maml:para>Removes a super user from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AipServiceSuperUser cmdlet removes a user from the list of users who are individually granted super user privileges for your organization.</maml:para> <maml:para>This cmdlet does not remove a group or a user from that a group that is assigned super user privileges by using the Set-AipServiceSuperUserGroup cmdlet.</maml:para> <maml:para>For more information about super users, see the Get-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AipServiceSuperUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. </maml:para> <maml:para>The cmdlet removes the user or group identified by the email address that you specify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. </maml:para> <maml:para>The cmdlet removes the user or group identified by the email address that you specify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Remove a super user ----------------</maml:title> <dev:code>PS C:\>Remove-AipServiceSuperUser -EmailAddress "EvanNarvaez@Contoso.com"</dev:code> <dev:remarks> <maml:para>This command removes an individually specified super user from Azure Information Protection by specifying that user's email address.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045326</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AipServiceTemplate</command:name> <command:verb>Remove</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Deletes a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AipServiceTemplate cmdlet deletes a protection template for Azure Information Protection.</maml:para> <maml:para>You can delete only templates that you have created for your organization. You can set default templates to an archived state but you cannot delete them.</maml:para> <maml:para>Although you can configure protection templates in the Azure portal, you must use PowerShell to remove these templates.</maml:para> <maml:para>After a template is deleted, content protected with that template might become inaccessible. Users who are super users can continue to access content that was previously protected with a template that is now deleted. For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> <maml:para>This cmdlet requires the template ID, which you can get with the Get-AipServiceTemplate cmdlet.</maml:para> <maml:para>This cmdlet performs the following operations:</maml:para> <maml:para>- Displays the template properties.</maml:para> <maml:para>- Warns that all content protected with this template may become inaccessible.</maml:para> <maml:para>- Asks to confirm whether to proceed.</maml:para> <maml:para>- Calls the service to remove the template with the specified GUID.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AipServiceTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of the protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of the protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Delete a template -----------------</maml:title> <dev:code>PS C:\>Remove-AipServiceTemplate -TemplateId 36546649-4944-4462-a409-74373a67b6dd</dev:code> <dev:remarks> <maml:para>This command deletes the specified template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045542</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AipServiceDoNotTrackUserGroup</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceDoNotTrackUserGroup</command:noun> <maml:description> <maml:para>Sets a group for the users who must not be tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceDoNotTrackUserGroup cmdlet sets a group for Azure Information Protection when you use document tracking and you have users who must not be tracked. This configuration might be needed for privacy requirements. For more information, see Privacy controls for your document tracking site (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#privacy-controls-for-your-document-tracking-site).</maml:para> <maml:para>If this cmdlet has been run before, running it again overwrites the group that was set previously. You can set only one group, but it can contain nested groups.</maml:para> <maml:para>You must use PowerShell to set this group so that users are not tracked; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceDoNotTrackUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of the group whose members will be exempt from being tracked with the document tracking feature.</maml:para> <maml:para>You can specify a group that contains individual users, or nested groups. The email address must be a valid group email address that already exists in the organization.</maml:para> <maml:para>Note: Global administrators can always track the activities of these members.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of the group whose members will be exempt from being tracked with the document tracking feature.</maml:para> <maml:para>You can specify a group that contains individual users, or nested groups. The email address must be a valid group email address that already exists in the organization.</maml:para> <maml:para>Note: Global administrators can always track the activities of these members.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Set-AipServiceDoNotTrackUserGroup -GroupEmailAddress "DoNotTrackUserGroup@contoso.com"</dev:code> <dev:remarks> <maml:para>This command sets a group that has the email address of DoNotTrackUserGroup@contoso.com for the Contoso organization so that users in that group will not be tracked with the document tracking feature.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045407</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AipServiceKeyProperties</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceKeyProperties</command:noun> <maml:description> <maml:para>Updates the properties of a tenant key object for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceKeyProperties cmdlet changes an Archived status for a specified key object for the tenant to be Active. Because there can be only one active tenant key at any one time, the previously active tenant key is automatically set to Archived.</maml:para> <maml:para>New users of Azure Information Protection immediately use the identified tenant key to protect content. Existing users of the service gradually transition from the previously active tenant key to the newly active tenant key, and this staggered transition can take a few weeks to complete. You can force the update on clients by re-initializing the user environment (also known as bootstrapping). Documents and files that were protected with the previously active tenant key remain accessible to authorized users by using the tenant key that is now archived.</maml:para> <maml:para>Setting the tenant key object status to Active also resigns all protection templates with the newly active tenant key. Because this can be a time-consuming operation, especially if you have many protection templates, we do not recommend that you run this operation frequently. </maml:para> <maml:para>To run this cmdlet, you must specify the KeyIdentifier for the tenant key object that you want to set to Active. To get this value, use the Get-AipServiceKeys cmdlet. </maml:para> <maml:para>Note that you cannot use this cmdlet to change an Active status to be Archived. To set a tenant key object to have a status of Archived, you must set another tenant key object to Active.</maml:para> <maml:para>For more information about the tenant key, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceKeyProperties</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Active</maml:name> <maml:Description> <maml:para>Sets the status of the tenant key object.</maml:para> <maml:para>This parameter can only be use with the value of $True, which sets the status to be Active. If you want to change the status of a tenant key object to Archived, you must set another tenant key object to Active.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier for the tenant key object. You can get this value by running Get-AipServiceKeys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Active</maml:name> <maml:Description> <maml:para>Sets the status of the tenant key object.</maml:para> <maml:para>This parameter can only be use with the value of $True, which sets the status to be Active. If you want to change the status of a tenant key object to Archived, you must set another tenant key object to Active.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier for the tenant key object. You can get this value by running Get-AipServiceKeys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Change the status of a tenant key object to be active</maml:title> <dev:code>PS C:\> Set-AipServiceKeyProperties -Force -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -Active $True</dev:code> <dev:remarks> <maml:para>This command changes the status of a tenant key object from Archived to Active. The KeyIdentifier parameter identifies the tenant key object to change, and this value can be found by running Get-AipServiceKeys. The tenant key object that previously had a status of Active is automatically set to Archived.</maml:para> <maml:para>Because the command specifies the Force parameter, the command does not prompt you for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=2045233</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AipServiceMaxUseLicenseValidityTime</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceMaxUseLicenseValidityTime</command:noun> <maml:description> <maml:para>Sets the maximum validity time for Rights Management use licenses for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceMaxUseLicenseValidityTime cmdlet sets the maximum validity time for use licenses that Azure Information Protection grants for your organization when it protects files and email messages. The default value is 30 days.</maml:para> <maml:para>You must use PowerShell to set this configuration at the organization level; you cannot do this configuration by using a management portal.</maml:para> <maml:para>A use license is a per-document certificate that is granted to a user who opens a protected file or email message. This certificate contains that user's rights for the file or email message and the encryption key that was used to encrypt the content, as well as additional access restrictions defined in the document's policy.</maml:para> <maml:para>When the validity period of the use license is expired for a file or email message, the user credentials must be submitted to Azure Information Protection again to open that content. If the credentials are cached, the user is not prompted, and this happens in the background but an Internet connection is still required to send the cached credentials. </maml:para> <maml:para>For example, if a user shares a protected file by email and the protected file has the default use license validity period of 30 days:</maml:para> <maml:para>- Anna opens the file immediately, authenticates to Azure Information Protection, and reads the file. The following day, she reads the file again but does not have an Internet connection. Because the use license validity period has not expired, she can read the file. She accesses the file again 30 days later when she has an Internet connection and re-authenticates with Azure Information Protection, so she could now continue to read the file without authenticating again for a further 30 days.</maml:para> <maml:para>- John does not open the file for 31 days. When he does, he has Internet access that lets him authenticates to Azure Information Protection, and he can then open and read the file. John can continue to re-open and read the file even if he does not have an Internet connection again for a further 30 days.</maml:para> <maml:para>- Amelia opens the file a week after it arrives, and then does not open it again for two months. When she tries to open it this second time, she does not have Internet access and so she cannot open the file.</maml:para> <maml:para>This setting at the tenant level can be overridden by a more restrictive setting in a protection template because of the LicenseValidityDuration parameter in the Set-AipServiceTemplateProperty and Add-AipServiceTemplate cmdlets, which administrators can also set in the Azure portal by configuring the offline access option, "Number of days the content is available without an Internet connection".</maml:para> <maml:para>When there are different values for the use license, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</maml:para> <maml:para>Because the use license validity time can be overridden with more restrictive values, when you change the default value by using this cmdlet, choose a maximum value that best suits your organization. </maml:para> <maml:para>Decide on the best compromise between security and offline access for longer periods:</maml:para> <maml:para>- The lower the value, the more often users will be authenticated (which requires an Internet connection) but is a more secure setting because users will more quickly pick up changes such as the document has been revoked or the usage rights have changed for the protected document.</maml:para> <maml:para>- The higher the value, the less frequently users will be authenticated (and can continue to access protected documents even without an Internet connection) and is less secure because it will take longer for users to pick up changes such as the document has been revoked or the usage rights have changed for the protected document.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceMaxUseLicenseValidityTime</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>MaxUseLicenseValidityTime</maml:name> <maml:Description> <maml:para>Specifies the maximum validity time (0 - 65535) for use licenses in days.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet sets the value for the maximum validity time for use licenses without prompting you for confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet sets the value for the maximum validity time for use licenses without prompting you for confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>MaxUseLicenseValidityTime</maml:name> <maml:Description> <maml:para>Specifies the maximum validity time (0 - 65535) for use licenses in days.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Set the maximum validity time -----------</maml:title> <dev:code>PS C:\>Set-AipServiceMaxUseLicenseValidityTime 60</dev:code> <dev:remarks> <maml:para>This command sets the maximum validity time for use licenses to be 60 days.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045417</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceMaxUseLicenseValidityTime</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AipServiceMigrationUrl</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceMigrationUrl</command:noun> <maml:description> <maml:para>Sets a migration URL for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceMigrationUrl cmdlet sets a migration URL for Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to set the migration URL; you cannot do this action by using a management portal.</maml:para> <maml:para>Setting a migration URL for newly protected content can help you to migrate from Azure Information Protection to a supported on-premises server. Do not use this cmdlet in isolation but in conjunction with the instructions from Decommissioning and deactivating protection for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/decommission-deactivate).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceMigrationUrl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies a URL for the domain to migrate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet sets the value of the migration URL even if there is an existing migration URL.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies a URL for the domain to migrate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet sets the value of the migration URL even if there is an existing migration URL.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Set a migration URL ----------------</maml:title> <dev:code>PS C:\>Set-AipServiceMigrationUrl -Domain "aadrm.online.contoso.com"</dev:code> <dev:remarks> <maml:para>This command sets a migration URL for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=2092311</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceMigrationUrl</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AipServiceOnboardingControlPolicy</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceOnboardingControlPolicy</command:noun> <maml:description> <maml:para>Sets the user on-boarding control policy for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceOnboardingControlPolicy cmdlet sets the policy that controls user on-boarding for Azure Information Protection. This cmdlet supports a gradual deployment by controlling which users in your organization can protect content by using Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to set this configuration; you cannot do this configuration by using a management portal.</maml:para> <maml:para>This control can be based on assigned user licenses for the service or membership in a designated security group. You can also define whether the policy applies to just mobile devices, just Windows clients, or mobile devices and Windows clients.</maml:para> <maml:para>If you use the assigned license option, you can assign licenses to users by using the Microsoft 365 admin center or by using Azure PowerShell and the Set-MsolUserLicense (https://docs.microsoft.com/en-us/powershell/module/msonline/set-msoluserlicense?view=azureadps-1.0) cmdlet from the Azure AD PowerShell administration module. You can also use the [Get-MsolAccountSku](https://docs.microsoft.com/en-us/powershell/module/msonline/get-msolaccountsku?view=azureadps-1.0)cmdlet to obtain the different types of licenses that you can assign in your organization.</maml:para> <maml:para>If you use the group membership option, you must specify a security group, which does not have to be mail-enabled and it can contain other groups. To specify the group, use the group GUID. For more information about the user and group requirements and how to find the group GUID, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare).</maml:para> <maml:para>For more information about the Azure AD PowerShell cmdlets, see Azure Active Directory PowerShell (https://docs.microsoft.com/powershell/azure/overview?view=azureadps-2.0).</maml:para> <maml:para>Note: This cmdlet does not stop users from consuming protected content or prevent administrators from configuring services for Azure Information Protection (for example, Exchange Online mail flow rules or SharePoint protected libraries). Instead, it is designed for user applications such as Office, so that users do not see the options or templates to use Azure Information Protection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceOnboardingControlPolicy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet configures the on-boarding control policy even if there is already an on-boarding control policy for the organization.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Specifies the types of applications to which the on-boarding policy applies.</maml:para> <maml:para>Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- WindowsApp</maml:para> <maml:para>- MobileApp</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WindowsApp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MobileApp</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OnboardingControlPolicyScope</command:parameterValue> <dev:type> <maml:name>OnboardingControlPolicyScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupObjectId</maml:name> <maml:Description> <maml:para>Specifies the object ID of a security group in Azure AD. If you try to specify the object ID of a distribution group, you will see an error.</maml:para> <maml:para>The specified group restricts which users can protect content by using Azure Information Protection. If you also enable license enforcement, only users that have an Azure Rights Management license assigned and are members of this specified group can protect content by using Azure Information Protection.</maml:para> <maml:para>You can use this parameter to implement a phased deployment of Azure Information Protection even if all users have an Azure Rights Management license assigned to them.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UseRmsUserLicense</maml:name> <maml:Description> <maml:para>Specifies whether users without an Azure Rights Management license assigned to them can use Azure Information Protection to protect content. Users can always use Azure Information Protection to consume protected content regardless of this setting and their license assignment.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs.</maml:para> <maml:para>The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet configures the on-boarding control policy even if there is already an on-boarding control policy for the organization.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Specifies the types of applications to which the on-boarding policy applies.</maml:para> <maml:para>Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- WindowsApp</maml:para> <maml:para>- MobileApp</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OnboardingControlPolicyScope</command:parameterValue> <dev:type> <maml:name>OnboardingControlPolicyScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupObjectId</maml:name> <maml:Description> <maml:para>Specifies the object ID of a security group in Azure AD. If you try to specify the object ID of a distribution group, you will see an error.</maml:para> <maml:para>The specified group restricts which users can protect content by using Azure Information Protection. If you also enable license enforcement, only users that have an Azure Rights Management license assigned and are members of this specified group can protect content by using Azure Information Protection.</maml:para> <maml:para>You can use this parameter to implement a phased deployment of Azure Information Protection even if all users have an Azure Rights Management license assigned to them.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UseRmsUserLicense</maml:name> <maml:Description> <maml:para>Specifies whether users without an Azure Rights Management license assigned to them can use Azure Information Protection to protect content. Users can always use Azure Information Protection to consume protected content regardless of this setting and their license assignment.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs.</maml:para> <maml:para>The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Restrict Azure Information Protection to users who have a license and are members of a specified group</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $True -SecurityGroupObjectId "fba99fed-32a0-44e0-b032-37b419009501" -Scope All</dev:code> <dev:remarks> <maml:para>This command configures Azure Information Protection to allow only users who have an Azure Rights Management license to use Azure Information Protection to protect content. Further, the command requires users to be members of the security group with the specified object ID. The restriction applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Restrict Azure Information Protection to users who are members of a specified group</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $False -SecurityGroupObjectId "fba99fed-32a0-44e0-b032-37b419009501" -Scope All</dev:code> <dev:remarks> <maml:para>This command allows only users that are members of the security group with the specified object ID to protect content by using Azure Information Protection. The command applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Restrict Azure Information Protection to users who have an Azure Rights Management license</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $True -Scope All</dev:code> <dev:remarks> <maml:para>This command allows only users who have an Azure Rights Management license assigned to protect content by using Azure Information Protection. The command applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Do not restrict Azure Information Protection for users</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $False -Scope All</dev:code> <dev:remarks> <maml:para>This command allows all users to protect content by using Azure Information Protection. The command applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045236</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceOnboardingControlPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AipServiceSuperUserGroup</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceSuperUserGroup</command:noun> <maml:description> <maml:para>Sets the super user group for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceSuperUserGroup cmdlet specifies a group to use as the super user group for Azure Information Protection. Members of this group are then super users, which means they become an owner for all content that is protected by your organization. These super users can decrypt this protected content and remove protection from it, even if an expiration date has been set and expired. Typically, this level of access is required for legal eDiscovery and by auditing teams.</maml:para> <maml:para>You can specify any group that has an email address, but be aware that for performance reasons, group membership is cached. For information about group requirements, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare).</maml:para> <maml:para>If a super user group already exists, running this cmdlet overwrites it. This cmdlet does not affect users that are individually assigned as super users with the Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>An organization can have only one super user group in addition to multiple users who are assigned the privilege individually, but you can nest groups.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceSuperUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the group email address for the super user group. GroupEmailAddress can specify a group that contains individual users or other nested groups. It must be a valid group email address for an existing group in the organization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the group email address for the super user group. GroupEmailAddress can specify a group that contains individual users or other nested groups. It must be a valid group email address for an existing group in the organization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Set the super user group -------------</maml:title> <dev:code>PS C:\>Set-AipServiceSuperUserGroup -GroupEmailAddress "SuperUserGroup@contoso.com"</dev:code> <dev:remarks> <maml:para>This command sets the super user group for the organization to SuperUserGroup@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045240</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AipServiceTemplateProperty</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceTemplateProperty</command:noun> <maml:description> <maml:para>Updates a property or properties of a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceTemplateProperty cmdlet updates a property or properties of a protection template for Azure Information Protection.</maml:para> <maml:para>You can update most of these properties in the Azure portal.</maml:para> <maml:para>When you use this cmdlet, the template is identified by its GUID, which must refer to an existing protection template. You cannot use this cmdlet to update the default templates.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to get the template ID.</maml:para> <maml:para>Important: When you update properties of a protection template, the existing settings for those properties will be overwritten (not supplemented) without warning, so be sure to specify all the settings that you need for the properties that you are updating.</maml:para> <maml:para>As a best practice, back up the existing template before you run this cmdlet, by using the Export-AipServiceTemplate cmdlet. Then, if you need to revert to the original configuration, you can use the Import-AipServiceTemplate cmdlet to restore the template.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceTemplateProperty</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires. </maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template.</maml:para> <maml:para>The acceptable values for this parameter are: - Never . Indicates that content is available indefinitely. - OnDate . Indicates that content expires at a certain fixed date. - AfterDays .Indicates that content will be available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AfterDays</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organizacion"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in client applications that do not support departmental templates. For this scenario, decide whether all users can see departmental templates from the list of available templates, or no users can see departmental templates in the list.</maml:para> <maml:para>Departmental templates can be created by using the ScopedIdentities parameter, or by creating protection settings in a scoped policy for Azure Information Protection. Department templates might also have been created by using the Azure classic portal (now retired).</maml:para> <maml:para>- If set to True and the template is a departmental template, all users will see the template and therefore be able to select it, regardless of whether the users are members of the template's scope or not.</maml:para> <maml:para>- If set to False, no users see and therefore cannot select the template, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on client applications that natively support departmental templates. This setting also has no effect for Outlook on the web that uses Exchange Online rather than Exchange on-premises and for this scenario, departmental templates are never displayed to users.</maml:para> <maml:para>Note that this setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to see and therefore select the template itself.</maml:para> <maml:para>If you have a client application that does not natively support departmental templates, such as Office 2010, you can use a custom script other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template. The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1.</maml:para> <maml:para>To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template. Valid values are: Published or Archived .</maml:para> <maml:para>- Archived templates are available to consume content previously protected but are not visible to users.</maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Archived</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Published</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires. </maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template.</maml:para> <maml:para>The acceptable values for this parameter are: - Never . Indicates that content is available indefinitely. - OnDate . Indicates that content expires at a certain fixed date. - AfterDays .Indicates that content will be available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organizacion"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in client applications that do not support departmental templates. For this scenario, decide whether all users can see departmental templates from the list of available templates, or no users can see departmental templates in the list.</maml:para> <maml:para>Departmental templates can be created by using the ScopedIdentities parameter, or by creating protection settings in a scoped policy for Azure Information Protection. Department templates might also have been created by using the Azure classic portal (now retired).</maml:para> <maml:para>- If set to True and the template is a departmental template, all users will see the template and therefore be able to select it, regardless of whether the users are members of the template's scope or not.</maml:para> <maml:para>- If set to False, no users see and therefore cannot select the template, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on client applications that natively support departmental templates. This setting also has no effect for Outlook on the web that uses Exchange Online rather than Exchange on-premises and for this scenario, departmental templates are never displayed to users.</maml:para> <maml:para>Note that this setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to see and therefore select the template itself.</maml:para> <maml:para>If you have a client application that does not natively support departmental templates, such as Office 2010, you can use a custom script other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template. The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1.</maml:para> <maml:para>To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template. Valid values are: Published or Archived .</maml:para> <maml:para>- Archived templates are available to consume content previously protected but are not visible to users.</maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Update a template's status ------------</maml:title> <dev:code>PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6428 -Status Published</dev:code> <dev:remarks> <maml:para>This command sets a template status to Published.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 2: Specify users and rights for a protection template </maml:title> <dev:code>PS C:\> $r1 = New-AipServiceRightsDefinition -EmailAddress marketing@contoso.com -Rights "VIEW","EXPORT" PS C:\> $r2 = New-AipServiceRightsDefinition -EmailAddress engineering@contoso.com -Rights "VIEW" PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6522 -RightsDefinitions ($r1, $r2)</dev:code> <dev:remarks> <maml:para>This example updates the existing protection template New Launch - Confidential Content for new users and rights. Whereas the existing template granted View and Export rights to the marketing department (which should not change), the engineering department must now also have View rights.</maml:para> <maml:para>Because specifying the RightsDefinitions parameter overwrites the existing settings, the first rights definition object keeps the existing settings for marketing, and another rights definition object creates the new engineering department rights.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 3: Add new users and rights to a protection template -</maml:title> <dev:code>PS C:\> $templateid = "7b1db17a-cb1a-41cf-bad7-b452f9d384c1" PS C:\> [array]$r = New-AipServiceRightsDefinition -EmailAddress pattiful@contoso.com -Rights "DOCEDIT", "EXTRACT" PS C:\> $r += New-AipServiceRightsDefinition -EmailAddress evannar@vanarsdelltd.com -Rights "VIEW" PS C:\> $CurrentRightsDefinitions = [array]((get-AipServiceTemplate -TemplateId $templateid).RightsDefinitions) PS C:\> $ResultingRightsDefinitions = $CurrentRightsDefinitions + $r PS C:\> Set-AipServiceTemplateProperty -TemplateId $templateid -RightsDefinition $ResultingRightsDefinitions</dev:code> <dev:remarks> <maml:para>This set of command adds two new users and their different rights to an existing template, without overwriting the existing users and rights already defined in the template.</maml:para> <maml:para>The new users and their rights are pattiful.contoso.com (a user within the organization) who is granted DOCEDIT and EXTRACT rights; and evannar@vanarsdelltd.com (a user from another organization) who is granted VIEW rights. These users and their rights are added to rights definition objects using an array, which is then added to the existing rights definitions for the template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045424</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplateProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Use-AipServiceKeyVaultKey</command:name> <command:verb>Use</command:verb> <command:noun>AipServiceKeyVaultKey</command:noun> <maml:description> <maml:para>Tells Azure Information Protection to use a customer-managed tenant key in Azure Key Vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Use-AipServiceKeyVaultKey cmdlet tells Azure Information Protection to use a customer-managed key (BYOK) in Azure Key Vault.</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>You can run this cmdlet before or after the protection service (Azure Rights Management) is activated. </maml:para> <maml:para>Before you run this cmdlet, make sure that the Azure Rights Management service principal has been granted permissions to the key vault that contains the key you want to use for Azure Information Protection. These permissions are granted by running the Azure Key Vault cmdlet, Set-AzKeyVaultAccessPolicy.</maml:para> <maml:para>For security reasons, the Use-AipServiceKeyVaultKey cmdlet does not let you set or change the access control for the key in Azure Key Vault. After that access is granted by running Set-AzKeyVaultAccessPolicy, run Use-AipServiceKeyVaultKey to tell Azure Information Protection to use the key and version that you specify with the KeyVaultKeyUrl parameter.</maml:para> <maml:para>Note: If you run this cmdlet before the permissions are granted to the key vault, you will see an error that displays The Rights Management service failed to add the key . To see more detailed information, run the command again, with - Verbose . If the permissions are not granted, you see VERBOSE: Failure to access Azure KeyVault .</maml:para> <maml:para>When your command successfully runs, the key is added as an archived customer-managed tenant key for Azure Information Protection for your organization. To make it the active tenant key for Azure Information Protection, you must then run the Set-AipServiceKeyProperties cmdlet.</maml:para> <maml:para>Use Azure Key Vault to centrally manage and monitor use of the key that you specified. All calls to your tenant key will be made to the key vault that your organization owns. You can confirm which key you are using in Key Vault by using the Get-AipServiceKeys cmdlet.</maml:para> <maml:para>For more information about the types of tenant keys that Azure Information Protection supports, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> <maml:para>For more information about Azure Key Vault, see What is Azure Key Vault (https://docs.microsoft.com/azure/key-vault/key-vault-whatis).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Use-AipServiceKeyVaultKey</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab. </maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key and version in Azure Key Vault that you want to use for your tenant key.</maml:para> <maml:para>This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab. </maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key and version in Azure Key Vault that you want to use for your tenant key.</maml:para> <maml:para>This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Configure Azure Information Protection to use a customer-managed key in Azure Key Vault</maml:title> <dev:code>PS C:\>Use-AipServiceKeyVaultKey -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"</dev:code> <dev:remarks> <maml:para>This command tells Azure Information Protection to use the key named contoso-aipservice-key, version aaaabbbbcccc111122223333, in the key vault named contoso.</maml:para> <maml:para>This key and version in Azure Key Vault then becomes the customer-managed tenant key for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045248</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceKeyProperties</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |