Referência de esquema de resultado do conjunto de configurações dsc
Sinopse
A saída do resultado do comando dsc config set
.
Metadados
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/config/set.json
Type: object
Descrição
A saída do comando dsc config set
inclui o estado de cada instância de recurso na configuração antes e depois da operação definida e a lista de propriedades que a operação alterou para cada instância.
Propriedades necessárias
A saída sempre inclui estas propriedades:
- de metadados
- resultados
- mensagens
- hadErrors
Propriedades
metadados
Define os retornos de DSC de metadados para uma operação de configuração. As propriedades na propriedade Microsoft.DSC
descrevem o contexto da operação.
Type: object
Required: true
Microsoft.DSC
Os metadados nessa propriedade descrevem o contexto da operação geral:
- versão define a versão do DSC que executou o comando. Esse valor é sempre a versão semântica do comando DSC, como
3.0.0-preview.7
. - operação define a operação que o DSC aplicou ao documento de configuração:
Get
,Set
,Test
ouExport
. - executionType define se o DSC realmente aplicou uma operação à configuração ou foi executado no modo
WhatIf
. Essa propriedade é sempreActual
para operações deGet
,Test
eExport
. Para operações deSet
, esse valor éWhatIf
quando dSC é invocado com o argumento--what-if
. - startDatetime define a data e a hora de início da operação DSC como um carimbo de data/hora após o formato definido em RFC3339, seção 5.6 (consulte
date-time
), como2024-04-14T08:49:51.395686600-07:00
. - endDatetime define a data e a hora de término da operação DSC como um carimbo de data/hora após o formato definido em RFC3339, seção 5.6 (consulte
date-time
), como2024-04-14T08:49:51.395686600-07:00
. - duração define a duração de uma operação DSC em relação a um documento de configuração ou instância de recurso como uma cadeia de caracteres seguindo o formato definido em ISO8601 ABNF para
duration
. Por exemplo,PT0.611216S
representa uma duração de cerca de0.61
segundos. - securityContext define o contexto de segurança no qual o DSC foi executado. Se o valor dessa propriedade de metadados for
Elevated
, o DSC foi executado comoroot
(não Windows) ou uma sessão elevada com privilégios de Administrador (no Windows). Se o valor forRestricted
, o DSC será executado como um usuário ou uma conta normal em uma sessão não elevada.
Resultados
Define a lista de resultados para a operação de set
invocada em todas as instâncias do documento de configuração. Cada entrada na lista inclui o nome do tipo do recurso, o nome da instância e os dados de resultado de uma instância.
Type: array
Required: true
ItemsType: object
tipo
A propriedade type
de um item identifica o Recurso DSC da instância por seu nome de tipo totalmente qualificado.
Para obter mais informações sobre nomes de tipo, consulte referência de esquema de nome de tipo totalmente qualificado do Recurso DSC.
Type: string
Required: true
Pattern: ^\w+(\.\w+){0,2}\/\w+$
nome
A propriedade name
de um item identifica a instância por seu nome curto, exclusivo e legível por humanos.
Type: string
Required: true
resultado
A propriedade result
de um item inclui o estado imposto para a instância de recurso. O valor dessa propriedade adere ao mesmo esquema que a saída do comando dsc resource set
. Para obter mais informações, consulte referência de esquema de resultado do conjunto de recursos dsc.
Mensagens
Define a lista de mensagens estruturadas emitidas pelos recursos durante a operação de conjunto. Para obter mais informações, consulte referência de esquema de mensagem estruturada.
Type: array
Required: true
hadErrors
Indica se a operação encontrou erros. Esse valor será true
se o documento de configuração falhou na validação ou qualquer recurso encerrado com um código de saída diferente de 0
.
Type: boolean
Required: true