About Help

Choose a topic from the list on the left or search for a specific topic. Choose a topic from the list or search for a specific topic.
Cmdlets  Providers  Aliases  Modules
 

about_SPIrmSettings

Spirmsettings

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPIrmSettings 
 
# Description 
     
    This resource is used to manipulate the IRM settings in SharePoint, integrating 
    it with AD RMS 
     
.PARAMETER Ensure 
    Key - String 
    Allowed values: Present, Absent 
    Enable or Disable IRM on this farm 
 
.PARAMETER UseADRMS 
    Write - Boolean 
    Use the RMS server published in this farm's Active Directory 
 
.PARAMETER RMSserver 
    Write - String 
    Use the specified RMS server, must provide in URL format 
 
.PARAMETER InstallAccount 
    Write - String 
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 
 
 

.EXAMPLE

    This example shows how to apply the RMS settings to a local farm, pointing to 
    a specific RMS server 
 
 
    Configuration Example  
    { 
        param( 
            [Parameter(Mandatory = $true)] 
            [PSCredential] 
            $SetupAccount 
        ) 
        Import-DscResource -ModuleName SharePointDsc 
 
        node localhost { 
            SPIrmSettings RMSSettings 
            { 
                Ensure               = "Present" 
                RMSserver            = "https://rms.contoso.com" 
                PsDscRunAsCredential = $SetupAccount 
            } 
        } 
    }