Referenční informace ke schématu vlastností metadat Microsoft.DSC

Přehled

Vlastnosti metadat používané a vrácené DSC pro operace konfigurace a prostředků.

Description

Objekt Microsoft.DSC metadat zachycuje podrobnosti o spuštění, které DSC přidává do výstupu příkazu a případně do výsledků prostředků. Popisuje, jaká operace běžela, kdy byla spuštěna a dokončena, jak dlouho trvala, kontext zabezpečení, ve kterém DSC běžel, a verze DSC, která vytvořila výstup. Tyto vlastnosti jsou informativní a pomáhají s diagnostikou, auditováním a nástroji.

Ne každá vlastnost je k dispozici pro každou operaci. Například executionType je smysluplný pouze pro Set (a je WhatIf při vyvolání DSC pomocí --whatIf), while operation je vždy k dispozici. Časová razítka používají formát RFC 3339 date-time a doby trvání používají formát ISO 8601 duration .

Spotřebitelé by měli tolerovat další, budoucí pole metadat. Producenti by měli uchovávat neznámá metadata, která neinterpretují.

Vlastnosti

duration

Definuje dobu trvání operace DSC s konfiguračním dokumentem nebo instancí prostředku jako řetězec ve formátu definovaném v ISO8601 ABNF pro duration.

PT0.611216S Například představuje dobu trvání přibližně 0.61 sekund.

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/duration.json
Type:          string
Format:        duration

endDateTime

Definuje koncové datum a čas operace DSC jako časové razítko ve formátu definovaném v části 5.6 RFC3339 (viz date-time).

Příklad: 2024-04-14T08:49:51.395686600-07:00

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/endDateTime.json
Type:          string
Format:        date-time

executionType

Definuje, zda DSC skutečně aplikovalo operaci na konfiguraci nebo bylo spuštěno v WhatIf režimu. Tato vlastnost je vždy Actual pro operace , GetTesta Export . U Set operací je WhatIf tato hodnota v případě, že je DSC vyvoláno s argumentem --whatIf .

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/executionType.json
Type:          string
ValidValues:  [Actual, WhatIf]

operace

Definuje operaci, kterou DSC aplikovalo na konfigurační dokument: Get, Set, Testnebo Export.

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/operation.json
Type:          string
ValidValues:  [Get, Set, Test, Export]

securityContext

Definuje kontext zabezpečení, ve kterém byl DSC spuštěn. Pokud je Elevatedhodnota této vlastnosti metadat , DSC byl spuštěn jako root (mimo Windows) nebo jako zvýšená relace s oprávněními správce (v systému Windows). Pokud je Restrictedhodnota , DSC byl spuštěn jako normální uživatel nebo účet v relaci bez zvýšených oprávnění.

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/securityContext.json
Type:          string
ValidValues:  [Current, Elevated, Restricted]

startDatetime

Definuje počáteční datum a čas operace DSC jako časové razítko ve formátu definovaném v části 5.6 RFC3339 (viz date-time).

Příklad: 2024-04-14T08:49:51.395686600-07:00

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/startDatetime.json
Type:          string
Format:        date-time

verze

Definuje verzi DSC, která příkaz spustila. Tato hodnota je vždy sémantickou verzí příkazu DSC, například 3.0.0-preview.7.

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/version.json
Type:          object