Esquema de parâmetro de documento de configuração de DSC

Sinopse

Define as opções de runtime para uma configuração.

Metadados

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.parameter.json
Type:          object

Descrição

Os documentos de configuração de DSC podem incluir parâmetros, que os usuários podem substituir em runtime. Os parâmetros permitem separar segredos de definições de configuração e permitem que os usuários escrevam configurações que podem ser aplicadas a vários contextos.

Os parâmetros são definidos como pares chave-valor na propriedade parameters de um documento de configuração. A chave é o nome do parâmetro, que é usado para fazer referência ao parâmetro nos recursos propriedade do documento de configuração. O valor é um objeto que define o parâmetro.

Cada parâmetro define seu tipo de dados. Os parâmetros também podem definir um valor padrão, verificações de validação, uma descrição de sua finalidade e metadados arbitrários.

Para referenciar parâmetros em instâncias de recurso, use a função de configuração parameters().

Propriedades necessárias

• tipo

Propriedades

descrição

Os parâmetros podem definir uma breve explicação de sua finalidade e uso com a propriedade description. Para definir uma explicação mais longa no YAML, use a sintaxe de bloco dobrada ou a sintaxe de bloco literal.

Type:     string
Required: false

metadados

A propriedade metadata define um conjunto de pares chave-valor como anotações para o parâmetro. O DSC não valida os metadados. Um parâmetro pode incluir qualquer informação arbitrária nesta propriedade.

Type:     object
Required: false

tipo

Cada parâmetro deve definir o tipo de dados que ele espera como a propriedade type. O DSC valida o tipo de dados para cada parâmetro passado antes de executar uma operação de configuração.

Os tipos de dados secure* indicam que o DSC e as ferramentas de integração não devem registrar ou registrar os valores. Se um parâmetro de tipo de dados seguro for usado para uma propriedade de instância de recurso que não espera um valor seguro, o recurso ainda poderá registrar ou registrar o valor. Se o recurso tiver registro independente ou gravação que não seja tratada pelo DSC, o valor poderá ser armazenado de forma insegura.

Use cadeias de caracteres seguras para senhas e segredos.

Para obter mais informações sobre tipos de dados, consulte referência de esquema de tipo de dados de parâmetro de configuração DSC.

Type:        string
Required:    true
ValidValues: [string, securestring, int, bool, object, secureobject, array]

defaultValue

Os parâmetros podem definir um valor padrão com a propriedade defaultValue. Se o parâmetro não for passado em runtime, o DSC usará o valor padrão para o parâmetro. Se o parâmetro não for passado em runtime e nenhum valor padrão for definido, o DSC gerará um erro. O valor deve ser válido para o typedo parâmetro.

Required:       false
ValidJSONTypes: [string, integer, object, array, boolean]

allowedValues

Os parâmetros podem limitar o conjunto de valores válidos para o parâmetro definindo a propriedade allowedValues. O DSC valida parâmetros passados em runtime e definidos como defaultValue em relação a essa lista de valores. Se qualquer um dos valores for inválido, o DSC gerará um erro.

Essa propriedade é sempre uma matriz. Se essa propriedade for definida, ela deverá incluir pelo menos um item na lista de valores.

Type:               array
Required:           false
ValidItemJSONTypes: [string, integer, object, array, boolean]

minLength

A propriedade minLength define uma opção de validação para parâmetros de matriz e cadeia de caracteres. O comprimento de uma cadeia de caracteres é sua contagem de caracteres. O comprimento de uma matriz é sua contagem de itens.

Se o valor padrão ou o valor de runtime do parâmetro for menor que essa propriedade, o DSC gerará um erro. Se essa propriedade for definida para parâmetros cujo type não é array, stringou securestring, o DSC gerará um erro.

Se essa propriedade for definida com a propriedade maxLength, essa propriedade deverá ser menor que maxLength. Se não for, o DSC gerará um erro.

Type:         int
Required:     false
MinimumValue: 0

maxLength

A propriedade maxLength define uma opção de validação para parâmetros de matriz e cadeia de caracteres. O comprimento de uma cadeia de caracteres é sua contagem de caracteres. O comprimento de uma matriz é sua contagem de itens.

Se o valor padrão ou o valor de runtime do parâmetro for maior que essa propriedade, o DSC gerará um erro. Se essa propriedade for definida para parâmetros cujo type não é array, stringou securestring, o DSC gerará um erro.

Se essa propriedade for definida com a propriedade minLength, essa propriedade deverá ser maior que minLength. Se não for, o DSC gerará um erro.

Type:         int
Required:     false
MinimumValue: 0

minValue

A propriedade minValue define uma opção de validação para parâmetros inteiros. Se o valor padrão ou o valor de runtime do parâmetro for menor que essa propriedade, o DSC gerará um erro. Se essa propriedade for definida para parâmetros cujo type não é int, o DSC gerará um erro.

Se essa propriedade for definida com a propriedade maxValue, essa propriedade deverá ser menor que maxValue. Se não for, o DSC gerará um erro.

Type:     int
Required: false

maxValue

A propriedade maxValue define uma opção de validação para parâmetros inteiros. Se o valor padrão ou o valor de runtime do parâmetro for maior que essa propriedade, o DSC gerará um erro. Se essa propriedade for definida para parâmetros cujo type não é int, o DSC gerará um erro.

Se essa propriedade for definida com a propriedade minValue, essa propriedade deverá ser maior que minValue. Se não for, o DSC gerará um erro.

Type:     int
Required: false