Registro
Sinopse
Gerenciar uma chave ou valor do Registro.
Sintaxe
Registry [String] #ResourceName
{
Key = [string]
ValueName = [string]
[DependsOn = [string[]]]
[Ensure = [string]{ Absent | Present }]
[Force = [bool]]
[Hex = [bool]]
[PsDscRunAsCredential = [PSCredential]]
[ValueData = [string[]]]
[ValueType = [string]{ Binary | DWord | ExpandString | MultiString | QWord | String }]
}
Descrição
O Registry
recurso permite adicionar e remover chaves do Registro e adicionar, atualizar e remover valores de chave do Registro.
Requisitos
Nenhum.
Parâmetros
Propriedades da chave
Chave
Especifique o caminho para a chave do Registro como uma cadeia de caracteres. Esse caminho deve incluir o hive ou a unidade do Registro, como HKEY_LOCAL_MACHINE
ou HKLM:
.
Type: System.String
Behavior: Key
ValueName
Especifique o nome do valor do Registro como uma cadeia de caracteres. Para adicionar ou remover uma chave do Registro, especifique essa propriedade como uma cadeia de caracteres vazia sem especificar a propriedade ValueType ou ValueData . Para atualizar ou remover o valor padrão de uma chave do Registro, especifique essa propriedade como uma cadeia de caracteres vazia com a propriedade ValueType ou ValueData .
Type: System.String
Propriedades opcionais
Ensure
Especifique se a chave ou valor do Registro deve existir. Para adicionar ou atualizar uma chave ou valor do Registro, defina essa propriedade como Present
. Para remover uma chave ou valor do Registro, defina essa propriedade como Absent
.
Type: System.String
Accepted Values:
- Absent
- Present
Default Value: Present
Force
Especifique se deseja substituir o valor da chave do Registro se ele já tiver um valor ou excluir uma chave do Registro que tenha subchaves. O valor padrão é $false
.
Type: System.Boolean
Default Value: false
Hex
Especifique se os dados de chave do Registro especificados são fornecidos em um formato hexadecimal. Especifique essa propriedade somente quando ValueType for DWord
ou QWord
. Se ValueType não DWord
for ou Qword
, o recurso ignorará essa propriedade. O valor padrão é $false
.
Type: System.Boolean
Default Value: false
ValueData
Especifique o valor da chave do Registro como uma cadeia de caracteres ou, se ValueType for MultiString
, uma matriz de cadeias de caracteres. Se ValueType não MultiString
for e o valor dessa propriedade for cadeias de caracteres mulitple, o recurso gerará uma exceção de argumento inválida.
Type: System.String[]
Default Value: None
ValueType
Especifique o tipo para os dados do valor da chave do Registro especificado.
Type: System.String
Accepted Values:
- Binary
- DWord
- ExpandString
- MultiString
- QWord
- String
Default Value: String
Exemplos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de