Compartilhar via

Invoke-DscResource

Módulo:
PSDesiredStateConfiguration Module

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

Sintaxe

Default (Padrão) 

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

Description

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

Esse 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 windows ou Linux com recursos DSC.

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

Exemplos

Exemplo 1: invocar 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 de Caminho e argumentos propriedades 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 esse cmdlet invoca. Os valores aceitáveis para esse parâmetro são: Get, Sete Test.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Get, Set, Test
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ModuleName

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

Propriedades do parâmetro

Tipo:ModuleSpecification
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Name

Especifica o nome do recurso DSC a ser invocado.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Property

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

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:3
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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

Observações

  • No Windows PowerShell 5.1, os recursos foram executados no contexto do 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 tem mais suporte. Usar essa chave faz com que o cmdlet gere uma exceção.

  • A partir do PowerShell 7, Invoke-DscResource não dá mais suporte à invocação de recursos do WMI DSC. Isso inclui os recursos de Arquivo e do Log em PSDesiredStateConfiguration.