dsc-resourceexport

Samenvatting

Genereert een configuratiedocument waarmee de bestaande exemplaren van een specifieke resource worden gedefinieerd.

Syntaxis

Zonder instantie-eigenschappen

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

Instantie-eigenschappen van invoeroptie

dsc resource export --input <INPUT> --resource <RESOURCE>

Instantie-eigenschappen uit bestand

dsc resource export --file <FILE> --resource <RESOURCE>

Instantie-eigenschappen van stdin

cat <FILE> | dsc resource get [Options] --resource <RESOURCE> --file -

Beschrijving

Het export subcommando genereert een configuratiedocument dat elk exemplaar van een specifieke bron bevat. De resource moet worden opgegeven met de --resource optie.

Vanaf DSC 3.1.0 kunt u de --input optie of --file gebruiken om een broninstantie op te geven die als filter voor de geëxporteerde bronnen moet worden gebruikt. Wanneer u dit doet, wordt het opgegeven exemplaar doorgegeven aan de resource voor gebruik bij het filteren. De implementatie voor het filteren is afhankelijk van elke bron, niet van DSC zelf.

Geef alleen exporteerbare resources op met een resourcemanifest dat de exportsectie definieert in de invoerconfiguratie. Als het opgegeven resourcetype niet kan worden geëxporteerd, genereert DSC een fout.

Opties

-r, --bron

Hiermee geeft u de volledig gekwalificeerde typenaam op van de DSC-resource die moet worden geëxporteerd, zoals Microsoft.Windows/Registry.

De volledig gekwalificeerde syntaxis van de typenaam is: <owner>[.<group>][.<area>]/<name>, waarbij:

• Het owner is de onderhoudende auteur of organisatie voor de bron.
• De group en area zijn optionele naamcomponenten die naamafstand voor een resource mogelijk maken.
• De name identificeert het onderdeel dat door de resource wordt beheerd.

Type        : string
Mandatory   : true
LongSyntax  : --resource <RESOURCE>
ShortSyntax : -r <RESOURCE>

-i, --invoer

Hiermee geeft u de resource-instantie op die moet worden gebruikt als filter voor geëxporteerde bron-exemplaren.

Het exemplaar moet een tekenreeks zijn die een JSON- of YAML-object bevat. DSC valideert het object aan de hand van het instantieschema van de bron. Als de validatie mislukt, genereert DSC een fout.

Deze optie sluit elkaar uit met de --file optie.

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --bestand

Definieert het pad naar een bestand dat het bronexemplaar definieert dat moet worden gebruikt als filter voor geëxporteerde bronexemplaren.

Het opgegeven bestand moet een JSON- of YAML-object bevatten dat geldige eigenschappen voor de resource vertegenwoordigt. DSC valideert het object aan de hand van het instantieschema van de bron. Als de validatie mislukt of als het opgegeven bestand niet bestaat, genereert DSC een fout.

Deze optie sluit elkaar uit met de --input optie.

Type        : string
Mandatory   : false
LongSyntax  : --file <FILE>
ShortSyntax : -f <FILE>

-o, --uitvoer-formaat

De --output-format optie bepaalt welke indeling DSC gebruikt voor de gegevens die de opdracht retourneert. De beschikbare formaten zijn:

• json om de gegevens als een JSON-lijn uit te zenden.
• pretty-json om de gegevens uit te zenden als JSON met nieuwe regels, inspringing en spaties voor leesbaarheid.
• yaml om de gegevens als YAML uit te zenden.

De standaarduitvoerindeling is afhankelijk van het feit of DSC detecteert dat de uitvoer wordt omgeleid of als een variabele wordt vastgelegd:

• Als de opdracht niet wordt omgeleid of vastgelegd, geeft DSC de uitvoer weer als de yaml indeling in de console.
• Als de opdrachtuitvoer wordt omgeleid of vastgelegd, verzendt DSC de gegevens als het json formaat om te stdout.

Wanneer u deze optie gebruikt, gebruikt DSC de opgegeven indeling, ongeacht of de opdracht wordt omgeleid of vastgelegd.

Wanneer de opdracht niet wordt omgeleid of vastgelegd, wordt de uitvoer in de console geformatteerd voor een betere leesbaarheid. Wanneer de opdracht niet wordt omgeleid of vastgelegd, bevat de uitvoer terminalsequenties voor opmaak.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --hulp

Geeft de Help voor de huidige opdracht of subopdracht weer. Wanneer u deze optie opgeeft, worden alle andere opties en argumenten genegeerd.

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Uitvoer

Met deze opdracht worden geformatteerde gegevens geretourneerd die een configuratiedocument definiëren, inclusief elk exemplaar van de resources die in de invoerconfiguratie zijn gedeclareerd. Zie Schemaverwijzing voor DSC-configuratiedocument voor meer informatie.

Zie de optie --output-format voor meer informatie over de opmaak van de uitvoergegevens.