Risorsa WindowsFeatureSet DSCDSC WindowsFeatureSet Resource

Si applica a: Windows PowerShell 5.xApplies To: Windows PowerShell 5.x

La risorsa WindowsFeatureSet in Windows PowerShell DSC (Desired State Configuration) fornisce un meccanismo per specificare le funzionalità e i ruoli aggiunti in un nodo di destinazione o rimossi da quest'ultimo.The WindowsFeatureSet resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to ensure that roles and features are added or removed on a target node. Questa risorsa è una risorsa composita che chiama la risorsa WindowsFeature per ogni funzionalità specificata nella proprietà Name .This resource is a composite resource that calls the WindowsFeature resource for each feature specified in the Name property.

Usare questa risorsa quando si vogliono configurare diverse istanze di WindowsFeature nello stesso stato.Use this resource when you want to configure a number of Windows Features to the same state.

Nota

La documentazione di questa risorsa DSC riguarda la versione inclusa in PowerShell.This documentation of this DSC resource covers the version that is included with PowerShell. Il modulo PSDscResources contiene elementi nuovi e aggiornati ufficialmente supportati da Microsoft.The PSDscResources module contains new and updated that are officially supported by Microsoft. Il modulo PSDscResources è disponibile da PowerShell Gallery.The PSDscResources module is available from the PowerShell Gallery.

Per altre informazioni e per la documentazione aggiornata, vedere il file LEGGIMI nel repository GitHub.For more information and updated documentation, see the README in the GitHub repository.

SintassiSyntax

WindowsFeatureSet [string] #ResourceName
{
    Name = [string[]]
    [ Source = [string] ]
    [ IncludeAllSubFeature = [Boolean] ]
    [ Credential = [PSCredential] ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

ProprietàProperties

ProprietàProperty DescrizioneDescription
NomeName Nomi dei ruoli o delle funzionalità che si vogliono aggiungere o rimuovere.The names of the roles or features that you want to ensure are added or removed. Corrisponde alla proprietà Name del cmdlet Get-WindowsFeature e non al nome visualizzato dei ruoli o delle funzionalità.This is the same as the Name property of the Get-WindowsFeature cmdlet, and not the display name of the roles or features.
Source (Sorgente)Source Indica il percorso del file di origine da usare per l'installazione, se necessario.Indicates the location of the source file to use for installation, if necessary.
IncludeAllSubFeatureIncludeAllSubFeature Impostare questa proprietà su $true per includere tutte le funzionalità secondarie necessarie insieme alle funzionalità specificata con la proprietà Name .Set this property to $true to include all required subfeatures with of the features you specify with the Name property.
CredenzialeCredential Credenziali da usare per aggiungere o rimuovere i ruoli o le funzionalità.The credentials to use to add or remove the roles or features.
LogPathLogPath Percorso di un file di registro in cui si vuole che il provider di risorse registri l'operazione.The path to a log file where you want the resource provider to log the operation.

Proprietà comuniCommon properties

ProprietàProperty DescrizioneDescription
DependsOnDependsOn Indica che prima di configurare la risorsa è necessario eseguire la configurazione di un'altra risorsa.Indicates that the configuration of another resource must run before this resource is configured. Ad esempio, se il valore di ID del blocco script di configurazione della risorsa che si vuole eseguire per primo è ResourceName e il tipo è ResourceType, la sintassi per usare questa proprietà è DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
EnsureEnsure Indica se i ruoli o le funzionalità vengono aggiunte.Indicates whether the roles or features are added. Per assicurarsi che i ruoli o le funzionalità vengano aggiunti, impostare questa proprietà su Present .To ensure that the roles or features are added, set this property to Present . Per assicurarsi che i ruoli o le funzionalità vengano rimossi, impostare la proprietà su Absent .To ensure that the roles or features are removed, set the property to Absent . Il valore predefinito è Present .The default value is Present .
PsDscRunAsCredentialPsDscRunAsCredential Imposta le credenziali per l'esecuzione dell'intera risorsa.Sets the credential for running the entire resource as.

Nota

La proprietà comune PsDscRunAsCredential è stata aggiunta in WMF 5.0 per consentire l'esecuzione di qualsiasi risorsa DSC nel contesto di altre credenziali.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Per altre informazioni, vedere Usare credenziali con risorse DSC.For more information, see Use Credentials with DSC Resources.

EsempioExample

La configurazione seguente garantisce che siano installate tutte le funzionalità e le funzionalità secondarie del server Web (IIS) e del server SMTP .The following configuration ensures that the Web-Server (IIS) and SMTP Server features, and all subfeatures of each, are installed.

configuration FeatureSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration
    Node localhost
    {

        WindowsFeatureSet WindowsFeatureSetExample
        {
            Name                    = @("SMTP-Server", "Web-Server")
            Ensure                  = 'Present'
            IncludeAllSubFeature    = $true
        }
    }
}