Set-RetentionPolicy
Este cmdlet está disponible en Exchange local y en el servicio basado en la nube. Algunos parámetros y configuraciones pueden ser exclusivos de un entorno u otro.
Use el cmdlet Set-RetentionPolicy para modificar las propiedades de una directiva de retención existente.
Para obtener más información acerca de los conjuntos de parámetros de la sección Sintaxis a continuación, vea Sintaxis del cmdlet de Exchange.
Sintaxis
Default (valor predeterminado)
Set-RetentionPolicy
[-Identity] <MailboxPolicyIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-IsDefault]
[-IsDefaultArbitrationMailbox]
[-Name <String>]
[-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf]
[<CommonParameters>]
Description
Deberá tener asignados permisos antes de poder ejecutar este cmdlet. Aunque en este artículo se enumeran todos los parámetros del cmdlet, es posible que no tenga acceso a algunos parámetros si no se incluyen en los permisos que se le asignan. Para obtener los permisos necesarios para ejecutar cualquier cmdlet o parámetro en su organización, consulte Find the permissions required to run any Exchange cmdlet.
Ejemplos
Ejemplo 1
Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"
En este ejemplo se modifica la directiva MyPolicy para vincular a ella la etiqueta de la directiva de retención MyRetentionPolicyTag.
El parámetro Identity es posicional, lo que significa que puede usarlo sin la etiqueta -Identity en la ubicación admitida en el comando (en este caso, primero). Para obtener más información sobre los parámetros posicionales, vea Acerca de los parámetros.
Parámetros
-Confirm
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, complemento de seguridad integrado para el entorno local Buzones
El modificador Confirm especifica si se debe mostrar u ocultar el mensaje de confirmación. Cómo afecta este modificador el cmdlet depende de si el cmdlet requiere confirmación antes de continuar.
- Los cmdlets destructivos (por ejemplo, los cmdlets Remove-*) tienen una pausa integrada que obliga a confirmar el comando antes de continuar. Para estos cmdlets, puede omitir el mensaje de confirmación mediante esta sintaxis exacta:
-Confirm:$false. - La mayoría de los otros cmdlets (por ejemplo, New-* y Set-*) no tienen una pausa integrada. En estos cmdlets, si se especifica el modificador Confirm sin ningún valor, se introduce una pausa que obliga a confirmar el comando antes de continuar.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Cf |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-DomainController
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parámetro solo está disponible en Exchange local.
El parámetro DomainController especifica el controlador de dominio que el cmdlet usa para leer datos de Active Directory o escribirlos. El controlador de dominio se identifica por su nombre de dominio completo (FQDN). Por ejemplo, dc01.contoso.com.
Propiedades de parámetro
| Tipo: | Fqdn |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Force
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
El modificador Force oculta los mensajes de advertencia o confirmación. No es necesario especificar un valor con este modificador.
Use este modificador para ocultar el símbolo del sistema de confirmación cuando use el parámetro RetentionId.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Identity
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, complemento de seguridad integrado para el entorno local Buzones
El parámetro Identity especifica el nombre, el nombre distintivo (DN) o GUID de la directiva de retención.
Propiedades de parámetro
| Tipo: | MailboxPolicyIdParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | 1 |
| Obligatorio: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-IsDefault
Aplicable: Exchange Online
Este parámetro solo está disponible en el servicio basado en la nube.
El modificador IsDefault especifica que esta directiva de retención es la directiva de retención predeterminada. No es necesario especificar un valor con este modificador.
Al usar este modificador, recibe una advertencia de que esta directiva de retención reemplaza a la directiva de retención predeterminada actual (la directiva donde el valor de la propiedad IsDefault es actualmente True) como valor predeterminado. De forma predeterminada, la directiva de retención predeterminada se denomina Directiva de MRM predeterminada.
Nota: El cambio de la directiva de retención predeterminada podría afectar o no a los buzones nuevos y existentes en función del valor del parámetro RetentionPolicy en todos los planes de buzón:
- $null (en blanco): los cambios en los que la directiva de retención es la predeterminada se reflejan continuamente en buzones nuevos y existentes.
- Se especifica una directiva de retención: el valor del parámetro RetentionPolicy para todos los planes de buzón de correo debe estar $null (en blanco) o coincidir con la directiva de retención de Exchange configurada como directiva predeterminada para la organización. De lo contrario, la experiencia podría ser incoherente al crear nuevos buzones, habilitar buzones deshabilitados y cambiar las licencias. Para obtener más información, vea Planes de buzón en Exchange Online.
Si a un buzón se le asigna una directiva de retención de Exchange que no es la directiva predeterminada, el valor RetentionPolicy del buzón se sobrescribe al cambiar las licencias. Debe restablecer manualmente RetentionPolicy al valor original.
Los cambios en la directiva de retención predeterminada que afectan a los buzones existentes pueden saturar la red si hay cientos o miles de buzones que requieren actualizaciones.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-IsDefaultArbitrationMailbox
Aplicable: Exchange Online
Este parámetro solo está disponible en el servicio basado en la nube.
El modificador IsDefaultArbitrationMailbox configura esta directiva como la directiva de retención predeterminada para los buzones de correo de arbitraje de la organización de Exchange Online. No es necesario especificar un valor con este modificador.
Este parámetro no está disponible para implementaciones locales.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Name
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
El parámetro Name especifica un nombre único para la directiva de retención.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-RetentionId
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
El parámetro RetentionId especifica la identidad de la directiva de retención para asegurarse de que los buzones movidos entre dos organizaciones de Exchange siguen teniendo aplicada la misma directiva de retención. Por ejemplo, en una implementación entre bosques o en una implementación entre locales, cuando se mueve un buzón de correo de un servidor exchange local a la nube, o un buzón basado en la nube se mueve a un servidor exchange local, este parámetro se usa para asegurarse de que se aplica la misma directiva de retención al buzón.
Normalmente, no es necesario especificar ni modificar el parámetro RetentionId para una etiqueta de retención. El parámetro se rellena automáticamente al importar etiquetas de retención mediante la secuencia de comandos Import-RetentionTags.ps1.
Propiedades de parámetro
| Tipo: | Guid |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-RetentionPolicyTagLinks
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
El parámetro RetentionPolicyTagLinks especifica la identidad de las etiquetas de la directiva de retención que se deben asociar con la directiva de retención. Los buzones a los que se aplica una directiva de retención tienen etiquetas de retención vinculadas con esa directiva de retención.
Propiedades de parámetro
| Tipo: | RetentionPolicyTagIdParameter[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-WhatIf
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, complemento de seguridad integrado para el entorno local Buzones
El modificador WhatIf simula las acciones del comando. Puede usar este modificador para ver los cambios que se producirían, pero sin aplicar los cambios. No es necesario especificar un valor con este modificador.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Wi |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para más información, consulte about_CommonParameters.
Entradas
Input types
Para ver los tipos de entrada que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de entrada de un cmdlet está en blanco, el cmdlet no acepta datos de entrada.
Salidas
Output types
Para ver los tipos de valor devuelto (también conocidos como tipos de resultado) que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de resultado está en blanco, el cmdlet no devuelve datos.