Set-SPIRMSettings

  • Referencia
Módulo:
SharePointServer
Se aplica a:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Establece la configuración de Information Rights Management (IRM).

Syntax

Set-SPIRMSettings
   -CertificateServerUrl <Uri>
   [-IrmEnabled]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CertificatePassword <SecureString>]
   [-Confirm]
   [-ServiceAuthenticationCertificate <X509Certificate2>]
   [-SubscriptionScopeSettingsEnabled]
   [-WhatIf]
   [-UseOauth]
   [<CommonParameters>]
Set-SPIRMSettings
   [-IrmEnabled]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CertificatePassword <SecureString>]
   [-Confirm]
   [-ServiceAuthenticationCertificate <X509Certificate2>]
   [-SubscriptionScopeSettingsEnabled]
   [-UseActiveDirectoryDiscovery]
   [-WhatIf]
   [-UseOauth]
   [<CommonParameters>]

Description

Este cmdlet contiene más de un conjunto de parámetros. Solo puede usar parámetros de un conjunto y no puede combinar parámetros de conjuntos distintos. Para más información sobre cómo usar conjuntos de parámetros, vea Conjuntos de parámetros de cmdlets.

Use el Set-SPIRMSettings cmdlet para establecer la configuración de Information Rights Management (IRM) para el inquilino.

Para obtener permisos y la información más reciente acerca de Windows PowerShell para Productos de SharePoint, vea la documentación en línea en Cmdlets de SharePoint Server.

Ejemplos

--------------EJEMPLO 1------------

Set-SPIRMSettings -RmsEnabled -UseActiveDirectoryDiscovery

Este ejemplo habilita IRM para la granja y lo configura para usar el servidor RMS predeterminado configurado en Active Directory.

--------------EJEMPLO 2------------

Set-SPIRMSettings -RmsEnabled -CertificateServerUrl https://myrmsserver

Este ejemplo habilita IRM para la granja y especifica la dirección URL del servidor RMS que se va a usar.

--------------EJEMPLO 3------------

site = Get-SPSite http://myspserver
$subscription = $site.SiteSubscription
Set-SPIRMSettings -SiteSubscription $subscription -RmsEnabled -CertificateServerUrl https://myrmsserver

Este ejemplo habilita IRM para el inquilino especificado y especifica la dirección URL del servidor RMS que se va a usar.

--------------EJEMPLO 4------------

Set-SPIRMSettings -RmsEnabled:$false

Este ejemplo deshabilita IRM para la granja.

Parámetros

-AssignmentCollection

Administra objetos para su correcta eliminación. El uso de objetos como SPWeb o SPSite puede requerir una gran cantidad de memoria y su uso en scripts de Windows PowerShell requiere una administración adecuada de la memoria. Mediante el uso del objeto SPAssignment se pueden asignar objetos a una variable y eliminar los objetos cuando ya no sean necesarios para liberar memoria. Cuando se usan los objetos SPWeb, SPSite o SPSiteAdministration, los objetos se eliminan automáticamente si no se usa una colección de asignaciones o el parámetro Global.

Cuando se usa el parámetro Global, todos los objetos se guardan en el almacén global. Si los objetos no se usan de forma inmediata o se eliminan mediante el comando Stop-SPAssignment, puede producirse un error de memoria insuficiente.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-CertificatePassword

Especifica la contraseña para obtener acceso al certificado de autenticación de servicio. Esta contraseña es necesaria para instalar el certificado en el almacén de certificados del PC.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-CertificateServerUrl

Especifica la dirección del servidor de certificados RMS que se va a usar para el inquilino.

Type:Uri
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Confirm

Le pide confirmación antes de ejecutar el comando. Para obtener más información, escriba el siguiente comando: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-IrmEnabled

Especifica si IRM está habilitado o no en el inquilino.

El valor predeterminado es False.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ServiceAuthenticationCertificate

Especifica el certificado de autenticación de servicio.

Si el parámetro se especifica y no es nulo, el certificado de autenticación se usa al conectar desde esta granja con el servidor RMS. Si el parámetro no se especifica, la granja local se conecta al servidor RMS con la autenticación integrada de Windows.

Type:X509Certificate2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SubscriptionScopeSettingsEnabled

Especifica si IRM se puede configurar o no en el ámbito de suscripción del sitio.

Solo se puede establecer una configuración personalizada de IRM en las suscripciones de sitio si IRM está habilitado en el ámbito de la granja.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-UseActiveDirectoryDiscovery

Especifica si el servicio RMS se debe usar o no para el sistema de detección. Esto determinará la dirección del servidor RMS en el dominio.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-UseOauth

Especifica si se debe usar OAuth.

Los valores válidos son True y False.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2016, SharePoint Server 2019

-WhatIf

Muestra un mensaje que describe el efecto del comando en lugar de ejecutar dicho comando. Para obtener más información, escriba el siguiente comando: get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019