Exportação de recursos DSC

Sinopse

Gera um documento de configuração que define as instâncias existentes de um recurso específico.

Sintaxe

Sem propriedades de instância

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

Propriedades da instância da opção de entrada

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

Propriedades da instância do arquivo

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

Propriedades de instância de stdin

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

Descrição

O export subcomando gera um documento de configuração que inclui cada instância de um recurso específico. O recurso deve ser especificado com a --resource opção.

A partir do DSC 3.1.0, você pode usar a --input opção ou --file para especificar uma instância de recurso a ser usada como filtro para os recursos exportados. Quando você faz isso, a instância especificada é passada para o recurso para uso na filtragem. A implementação para filtragem depende de cada recurso, não do DSC em si.

Especifique apenas recursos exportáveis com um manifesto de recurso que defina a seção de exportação na configuração de entrada. Se o tipo de recurso especificado não for exportável, o DSC gerará um erro.

Opções

-r, --recurso

Especifica o nome do tipo totalmente qualificado do recurso DSC a ser exportado, como Microsoft.Windows/Registry.

A sintaxe do nome de tipo totalmente qualificada é: <owner>[.<group>][.<area>]/<name>, onde:

• O owner é o autor ou organização mantenedora do recurso.
• Os group e area são componentes de nome opcionais que habilitam o namepacing para um recurso.
• O name identifica o componente que o recurso gerencia.

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

-i, --entrada

Especifica a instância de recurso a ser usada como um filtro para instâncias de recurso exportadas.

A instância deve ser uma cadeia de caracteres contendo um objeto JSON ou YAML. O DSC valida o objeto em relação ao esquema de instância do recurso. Se a validação falhar, o DSC gerará um erro.

Esta opção exclui-se mutuamente com a --file opção.

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

-f, --ficheiro

Define o caminho para um arquivo, definindo a instância de recurso a ser usada como um filtro para instâncias de recurso exportadas.

O arquivo especificado deve conter um objeto JSON ou YAML que represente propriedades válidas para o recurso. O DSC valida o objeto em relação ao esquema de instância do recurso. Se a validação falhar ou se o arquivo especificado não existir, o DSC gerará um erro.

Esta opção exclui-se mutuamente com a --input opção.

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

-o, --formato de saída

A --output-format opção controla qual formato o DSC usa para os dados retornados pelo comando. Os formatos disponíveis são:

• json para emitir os dados como uma linha JSON.
• pretty-json para emitir os dados como JSON com novas linhas, recuo e espaços para legibilidade.
• yaml para emitir os dados como YAML.

O formato de saída padrão depende se o DSC deteta que a saída está sendo redirecionada ou capturada como uma variável:

• Se o comando não estiver sendo redirecionado ou capturado, o DSC exibirá a saída como o yaml formato no console.
• Se a saída do comando for redirecionada ou capturada, o DSC emitirá os dados como o json formato para stdout.

Quando você usa essa opção, o DSC usa o formato especificado, independentemente de o comando estar sendo redirecionado ou capturado.

Quando o comando não é redirecionado ou capturado, a saída no console é formatada para melhorar a legibilidade. Quando o comando não é redirecionado ou capturado, a saída inclui sequências de terminal para formatação.

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

-h, --ajuda

Exibe a ajuda para o comando ou subcomando atual. Quando você especifica essa opção, o aplicativo ignora todas as outras opções e argumentos.

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

Resultado

Este comando retorna dados formatados que definem um documento de configuração, incluindo cada instância dos recursos declarados na configuração de entrada. Para obter mais informações, consulte Referência de esquema de documento de configuração DSC.

Para obter mais informações sobre a formatação dos dados de saída, consulte a opção --output-format.