Script

Sinopse

Executar blocos de script do PowerShell.

Sintaxe

Script [String] #ResourceName
{
    GetScript = [string]
    SetScript = [string]
    TestScript = [string]
    [Credential = [PSCredential]]
    [DependsOn = [string[]]]
    [PsDscRunAsCredential = [PSCredential]]
}

Descrição

O Script recurso permite que você escreva o código do PowerShell para obter, testar e definir um recurso quando um recurso de DSC específico não estiver disponível. Você deve fornecer o código para esses métodos, lidar com todas as dependências e garantir que seu código seja idempotente.

Dica

Sempre que possível, é recomendável usar um recurso de DSC definido em vez deste. O Script recurso tem desvantagens que dificultam o teste, a manutenção e a previsão.

Ao contrário de outros recursos de DSC, cada propriedade de um Script recurso é uma propriedade de chave e o método Get para esse recurso só pode retornar uma única cadeia de caracteres para o estado atual. Não há garantias de que esse recurso seja implementado de forma idempotente ou que ele funcione conforme o esperado em qualquer sistema porque usa código personalizado. Ele não pode ser testado sem ser invocado em um sistema de destino.

Antes de usar o Script recurso, considere se você pode criar um recurso . O uso de recursos de DSC bem definidos torna suas configurações mais legíveis e mantenedíveis.

Requisitos

Nenhum.

Propriedades

Propriedades da chave

GetScript

Especifique um scriptblock do PowerShell que recupera o estado atual do recurso. Esse scriptblock é executado quando o método Get para esse recurso é invocado.

Esse scriptblock deve retornar uma tabela de hash que contém uma chave chamada Result com um valor de cadeia de caracteres.

Type: System.String

SetScript

Especifique um scriptblock do PowerShell que configure o recurso para o estado desejado. Esse bloco de script é executado quando o método Set para esse recurso é invocado.

Esse bloco de script não deve gerar nenhum objeto. Esse bloco de script deve ser gravado de forma idempotente, de modo que invocar o método Set duas vezes deixa o destino no mesmo estado que invocá-lo uma vez.

Type: System.String

TestScript

Especifique um scriptblock do PowerShell que valide se o recurso está no estado desejado. Esse bloco de script é executado quando o método Test para esse recurso é invocado.

Esse bloco de script deverá retornar $true se o recurso estiver no estado desejado e $false se ele não estiver no estado desejado.

Type: System.String

Propriedades opcionais

Credencial

Especifique a credencial de uma conta para executar os scriptblocks em, se necessário.

Type: System.Management.Automation.PSCredential
Default Value: None

Propriedades somente leitura

Result

O resultado do bloco de script GetScript .

Type: System.String

Exemplos