Recurso Registry de DSCDSC Registry Resource

Aplica-se a: Windows PowerShell 4.0, Windows PowerShell 5.0Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

O recurso Registry na Configuração de Estado Desejado (DSC) do Windows PowerShell fornece um mecanismo para gerenciar chaves e valores do registro em um nó de destino.The Registry resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage registry keys and values on a target node.

SintaxeSyntax

Registry [string] #ResourceName
{
    Key = [string]
    ValueName = [string]
    [ Ensure = [string] { Enable | Disable }  ]
    [ Force =  [bool]   ]
    [ Hex = [bool] ]
    [ DependsOn = [string[]] ]
    [ ValueData = [string[]] ]
    [ ValueType = [string] { Binary | Dword | ExpandString | MultiString | Qword | String }  ]
}

PropriedadesProperties

PropriedadeProperty DescriçãoDescription
ChaveKey Indica o caminho da chave do Registro para o qual você deseja garantir um estado específico.Indicates the path of the registry key for which you want to ensure a specific state. Esse caminho deve incluir o hive.This path must include the hive.
ValueNameValueName Indica o nome do valor de registro.Indicates the name of the registry value. Para adicionar ou remover uma chave do Registro, especifique essa propriedade como uma cadeia de caracteres vazia sem especificar ValueType ou ValueData.To add or remove a registry key, specify this property as an empty string without specifying ValueType or ValueData. Para modificar ou remover o valor padrão de uma chave do Registro, especifica essa propriedade como uma cadeia de caracteres vazia e também especifique ValueType ou ValueData.To modify or remove the default value of a registry key, specify this property as an empty string while also specifying ValueType or ValueData.
EnsureEnsure Indica se a chave e o valor existem.Indicates if the key and value exist. Para garantir que existam, defina essa propriedade como "Present".To ensure that they do, set this property to "Present". Para garantir que não existam, defina a propriedade como "Absent".To ensure that they do not exist, set the property to "Absent". O valor padrão é "Present".The default value is "Present".
ForceForce Se a chave do Registro especificada estiver presente, Force a substituirá pelo novo valor.If the specified registry key is present, Force overwrites it with the new value. Para excluir uma chave do Registro com subchaves, isso deve ser $trueIf deleting a registry key with subkeys, this needs to be $true
HexHex Indica se os dados serão expressos em formato hexadecimal.Indicates if data will be expressed in hexadecimal format. Se especificado, os dados do valor DWORD/QWORD são apresentados em formato hexadecimal.If specified, the DWORD/QWORD value data is presented in hexadecimal format. Não é válido para outros tipos.Not valid for other types. O valor padrão é $false.The default value is $false.
DependsOnDependsOn Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado.Indicates that the configuration of another resource must run before this resource is configured. Por exemplo, se a ID do bloco de script de configuração do recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será 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".
ValueDataValueData Os dados para o valor de registro.The data for the registry value.
ValueTypeValueType Indica o tipo de valor.Indicates the type of the value. Há suporte para estes tipos:The supported types are:
  • Cadeia de caracteres (REG_SZ)String (REG_SZ)
  • Binário (REG-BINARY)Binary (REG-BINARY)
  • DWORD de 32 bits (REG_DWORD)Dword 32-bit (REG_DWORD)
  • QWORD de 64 bits (REG_QWORD)Qword 64-bit (REG_QWORD)
  • Cadeia de caracteres múltipla (REG_MULTI_SZ)Multi-string (REG_MULTI_SZ)
  • Cadeia de caracteres expansível (REG_EXPAND_SZ)Expandable string (REG_EXPAND_SZ)

ExemploExample

Este exemplo assegura que uma chave chamada "ExampleKey" está presente no hive HKEY_LOCAL_MACHINE.This example ensures that a key named "ExampleKey" is present in the HKEY_LOCAL_MACHINE hive.

Configuration RegistryTest
{
    Registry RegistryExample
    {
        Ensure      = "Present"  # You can also set Ensure to "Absent"
        Key         = "HKEY_LOCAL_MACHINE\SOFTWARE\ExampleKey"
        ValueName   = "TestValue"
        ValueData   = "TestData"
    }
}

Observação: alterar uma configuração do Registro no hive HKEY_CURRENT_USER requer que a configuração seja executada com credenciais de usuário, em vez de como o sistema.Note: Changing a registry setting in the HKEY_CURRENT_USER hive requires that the configuration runs with user credentials, rather than as the system. Você pode usar a propriedade PsDscRunAsCredential para especificar credenciais de usuário para a configuração.You can use the PsDscRunAsCredential property to specify user credentials for the configuration. Por exemplo, veja Executar DSC com as credenciais do usuárioFor an example, see Running DSC with user credentials