Partilhar via

Invoke-DscResource

Módulo:
PSDesiredStateConfiguration Module

Executa um método de um recurso especificado de Configuração de Estado Desejado (DSC) do PowerShell.

Sintaxe

Default (Predefinição) 

Invoke-DscResource
    [-Name] <String>
    [[-ModuleName] <ModuleSpecification>]
    [-Method] <String>
    [-Property] <Hashtable>
    [<CommonParameters>]

Description

O cmdlet Invoke-DscResource executa um método de um recurso DSC (Configuração de Estado Desejado) do PowerShell especificado.

Este cmdlet invoca um recurso DSC diretamente, sem criar um documento de configuração. Usando esse cmdlet, os produtos de gerenciamento de configuração podem gerenciar o Windows ou o Linux com recursos DSC.

Este cmdlet não funciona com recursos compostos. Recursos compostos são configurações parametrizadas. O uso de recursos compostos requer o LCM.

Exemplos

Exemplo 1: Invoque o método set de um recurso especificando suas propriedades obrigatórias

Este exemplo invoca o método set de um recurso chamado WindowsProcess e fornece as propriedades obrigatórias Path e Arguments para iniciar o processo especificado do Windows.

Invoke-DscResource -Name WindowsProcess -Method Set -ModuleName PSDesiredStateConfiguration -Property @{
    Path      = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
    Arguments = ''
}

Exemplo 2: Invocar o método Test de um recurso para um módulo especificado

Este exemplo invoca o método Test de um recurso chamado WindowsProcess, que está no módulo chamado PSDesiredStateConfiguration.

$SplatParam = @{
    Name       = 'WindowsProcess'
    ModuleName = 'PSDesiredStateConfiguration'
    Method     = 'Test'
    Property   = @{
        Path      = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
        Arguments = ''
    }
}

Invoke-DscResource @SplatParam

Parâmetros

-Method

Especifica o método do recurso que este cmdlet invoca. Os valores aceitáveis para este parâmetro são: Get, sete Test.

Propriedades dos parâmetros

Tipo:String
Default value:None
Valores aceites:Get, Set, Test
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ModuleName

Especifica o nome do módulo que fornece o recurso DSC especificado a ser invocado.

Propriedades dos parâmetros

Tipo:ModuleSpecification
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:1
Obrigatório:False
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Name

Especifica o nome do recurso DSC a ser invocado.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Property

Especifica o nome da propriedade do recurso e seu valor em uma tabela de hash como chave e valor, respectivamente.

Propriedades dos parâmetros

Tipo:Hashtable
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:3
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

ModuleSpecification

Saídas

Object

Notas

  • No Windows PowerShell 5.1, os recursos eram executados no contexto Sistema, a menos que especificado com o contexto do usuário usando a chave PsDscRunAsCredential. No PowerShell 7.0, os Recursos são executados no contexto do usuário e PsDscRunAsCredential não é mais suportado. O uso dessa chave faz com que o cmdlet lance uma exceção.

  • A partir do PowerShell 7, Invoke-DscResource não suporta mais a invocação de recursos DSC WMI. Isso inclui os recursos File e Log em PSDesiredStateConfiguration.