Dela via

dsc-resurs hämta

  • Artikel

Synopsis

Anropar get-åtgärden för en resurs.

Syntax

Utan instansegenskaper

dsc resource get [Options] --resource <RESOURCE>

Instansegenskaper från stdin

<instance-properties> | dsc resource get [Options] --resource <RESOURCE>

Instansegenskaper från indataalternativet

dsc resource get --input '<instance-properties>' --resource <RESOURCE>

Instansegenskaper från fil

dsc resource get --path <instance-properties-filepath> --resource <RESOURCE>

Description

Underkommandot get returnerar det aktuella tillståndet för en resursinstans.

Som standard returnerar den här underkommandot en instans från en specifik DSC-resurs. Om du vill returnera flera resurser använder du parametern --all , en resursgrupp eller kommandot dsc config get .

Alla egenskaper som resursen kräver för att hämta tillståndet för en instans måste skickas till det här kommandot som ett JSON- eller YAML-objekt. Objektet kan skickas till det här kommandot från stdin eller med alternativet --input . Du kan också använda --path alternativet för att läsa objektet från en JSON- eller YAML-fil.

Exempel

Exempel 1 – Hämta resursinstans utan indata

För resurser med en instans som inte kräver några egenskapsvärden för att returnera resursinstansens faktiska tillstånd krävs inte instansegenskaperna.

dsc resource get --resource Microsoft/OSInfo

actualState:
  $id: https://developer.microsoft.com/json-schemas/dsc/os_info/20230303/Microsoft.Dsc.OS_Info.schema.json
  family: Windows
  version: 10.0.22621
  edition: Windows 11 Enterprise
  bitness: '64'

Exempel 2 – Hämta resursinstans med indataalternativ

Om en resurs kräver ett eller flera egenskapsvärden för att returnera instansens faktiska tillstånd kan instansegenskaperna skickas med indataalternativet som antingen JSON eller YAML.

dsc resource get --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}'

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Exempel 3 – Hämta resursinstans med indata från stdin

Om en resurs kräver ett eller flera egenskapsvärden för att returnera instansens faktiska tillstånd kan instansegenskaperna skickas över stdin som antingen JSON eller YAML.

'{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}' | dsc resource get --resource Microsoft.Windows/Registry

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Exempel 4 – Hämta resursinstans med indata från en YAML-fil

Om en resurs kräver ett eller flera egenskapsvärden för att returnera instansens faktiska tillstånd kan instansegenskaperna hämtas från en sparad JSON- eller YAML-fil.

cat ./example.yaml

keyPath:   HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion
valueName: SystemRoot

dsc resource get --resource Microsoft.Windows/Registry --path ./example.yaml

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Alternativ

-a, --all

Anger att kommandot ska returnera varje instans av den angivna DSC-resursen i stället för en specifik instans.

Det här alternativet är endast giltigt när resursen är en exportbar resurs som definierar exportavsnittet i indatakonfigurationen. Om resurstypen inte kan exporteras genererar DSC ett fel.

När det här alternativet anges ignorerar --input DSC alternativen och --path och eventuella JSON- eller YAML-filer som skickas till kommandot från stdin.

Type:      Boolean
Mandatory: false

-r, --resource

Anger det fullständigt kvalificerade typnamnet för DSC-resursen som ska användas, till exempel Microsoft.Windows/Registry.

Den fullständigt kvalificerade typnamnsyntaxen är: <owner>[.<group>][.<area>]/<name>, där:

  • owner är den underhållna författaren eller organisationen för resursen.
  • group Och area är valfria namnkomponenter som aktiverar namnavstånd för en resurs.
  • name Identifierar komponenten som resursen hanterar.
Type:      String
Mandatory: true

-i, --input

Anger ett JSON- eller YAML-objekt med de egenskaper som behövs för att hämta en instans av DSC-resursen. DSC validerar objektet mot resursens instansschema. Om verifieringen misslyckas genererar DSC ett fel.

Det här alternativet kan inte användas med instansegenskaper över stdin eller alternativet --path . Välj om instansegenskaperna ska skickas till kommandot över stdin, från en fil med --path alternativet eller med --input alternativet .

DSC ignorerar det här alternativet när alternativet --all anges.

Type:      String
Mandatory: false

-p, --path

Definierar sökvägen till en textfil som ska läsas som indata för kommandot i stället för att skicka indata från stdin eller skicka den som en sträng med --input alternativet . Den angivna filen måste innehålla JSON eller YAML som representerar giltiga egenskaper för resursen. DSC validerar objektet mot resursens instansschema. Om verifieringen misslyckas, eller om den angivna filen inte finns, genererar DSC ett fel.

Det här alternativet är ömsesidigt uteslutande med alternativet --input . När du använder det här alternativet ignorerar DSC alla indata från stdin.

DSC ignorerar det här alternativet när alternativet --all anges.

Type:      String
Mandatory: false

-f, --format

Alternativet --format styr konsolens utdataformat för kommandot. Om kommandoutdata omdirigeras eller avbildas som en variabel är utdata alltid JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

Visar hjälpen för det aktuella kommandot eller underkommandot. När du anger det här alternativet ignorerar programmet alla alternativ och argument efter det här alternativet.

Type:      Boolean
Mandatory: false

Utdata

Som standard returnerar det här kommandot JSON-utdata som innehåller instansens faktiska tillstånd. När alternativet --all anges returnerar kommandot JSON-utdata för varje instans som JSON-rader.

Mer information om strukturen för utdata-JSON finns i dsc-resursen hämta resultatschema.