Compartilhar via

Glossário: Desired State Configuration

  • Artigo

Desired State Configuration (DSC) v3 usa vários termos que podem ter definições diferentes em outro lugar. Este documento lista os termos, seus significados e mostra como eles são formatados na documentação.

Termos de configuração

Documento de configuração de DSC

O arquivo JSON ou YAML que define uma lista de instâncias de recurso e seu estado desejado.

Diretrizes

  • Primeiro menção: Documento de Configuração de DSC
  • Menções subsequentes: documento ou documento de configuração

Exemplos

Um documento de configuração de DSC pode ser formatado como JSON ou YAML.

Defina a scope variável no documento como machine.

Termos do recurso

Recurso de DSC

A interface DSC para gerenciar as configurações de um componente. O DSC v3 dá suporte a vários tipos de recursos.

Diretrizes

  • Primeiro menção: Recurso DSC
  • Menções subsequentes: recurso
  • Formate os nomes de recursos específicos como código.

Exemplos

Ambos usam o Microsoft/OSInfo recurso DSC.

Você pode inspecionar a definição de um recurso com o dsc resource list <resource_name> comando .

Recurso DSC baseado em comando

Um recurso definido com um manifesto de recurso é um recurso baseado em comando . O DSC usa o manifesto para determinar como invocar o recurso e como validar as propriedades da instância de recurso.

Diretrizes

  • Sempre especifique o termo com o hífen.

Exemplos

Microsoft.Windows/Registry é um recurso baseado em comando.

Grupo de recursos DSC

Um grupo de recursos é um recurso baseado em comando com uma resources propriedade que usa uma matriz de instâncias de recurso e os processa. Os grupos de recursos podem aplicar tratamento especial às instâncias de recursos aninhadas, como alterar o usuário em que os recursos são executados.

Diretrizes

  • Sempre especifique o termo como grupo de recursos. Não omita "group" do termo .

Exemplos

Para garantir que os recursos sejam invocados em paralelo, use o DSC/ParallelGroup grupo de recursos.

Instância de recurso aninhado

Uma instância de recurso incluída na resources propriedade de um grupo de recursos ou provedor de recursos.

Diretrizes

  • Primeiro menção: instância de recurso aninhado
  • Menções subsequentes: instância aninhada
  • Se estiver claro no contexto que a instância é uma instância aninhada, você pode omitir o prefixo "aninhado".

Exemplos

Adicione uma instância de recurso aninhada à DSC/ParallelGroup instância. Defina o type da instância aninhada como Microsoft.Windows/Registry.

Provedor de recursos DSC

Um provedor de recursos é um grupo de recursos que permite o uso de recursos não baseados em comando com DSC v3. Cada instância de recurso aninhada deve ser um tipo de recurso compatível com o provedor.

Diretrizes

  • Primeiro menção: provedor de recursos DSC
  • Menções subsequentes: provedor

Exemplos

Para usar recursos de DSC do PowerShell em seu documento de configuração, adicione uma instância do provedor de DSC/PowerShellGroup recursos e defina as instâncias de recurso do PowerShell como instâncias aninhadas.

Recursos de DSC do PowerShell

Um recurso implementado no PowerShell. O DSC v3 dá suporte a dois tipos de recursos do PowerShell.

  • Class-Based – um recurso definido como uma classe do PowerShell em um módulo é um recurso baseado em classe .

    Os membros da classe definem o esquema de um recurso baseado em classe. Um recurso baseado em classe deve definir os Get()métodos , Set()e Test() .

  • Baseado em MOF – um recurso definido com um arquivo MOF (.mof), um arquivo de módulo de script (.psm1) e um arquivo de manifesto de módulo opcional (.psd1) é um recurso baseado em MOF . Os recursos baseados em MOF só têm suporte por meio de Windows PowerShell.

    O arquivo MOF é o esquema do recurso e define as propriedades do recurso. O arquivo de módulo de script define as funções do recurso: Get-TargetResource, Set-TargetResourcee Test-TargetResource. Essas funções são mapeadas para os métodos Get, Set e Test .

Diretrizes

  • Primeiro menção: Recursos DSC do PowerShell
  • Menções subsequentes: Recursos do PowerShell ou recursos PSDSC.
  • Ao discutir um tipo específico de recurso do PowerShell, especifique sempre o prefixo de tipo, como recursos baseados em classe.
  • O prefixo do PowerShell e do PSDSC pode ser omitido quando o contexto é claramente ou apenas sobre recursos do PowerShell, como um tutorial para criar um recurso baseado em classe.

Exemplos

Para usar recursos de DSC do PowerShell em seu documento de configuração, adicione uma instância do provedor de DSC/PowerShellGroup recursos e defina as instâncias de recurso do PowerShell como instâncias aninhadas.

Ao desenvolver recursos do PowerShell para software multiplataforma, crie recursos baseados em classe. Os recursos baseados em MOF só têm suporte por meio de Windows PowerShell.

Manifesto do recurso DSC

O arquivo JSON que define os metadados e a implementação de um recurso baseado em comando.

Diretrizes

  • Primeiro menção: manifesto do recurso DSC
  • Menções subsequentes: manifesto

Exemplos

Cada recurso baseado em comando deve definir um manifesto de recurso DSC. O nome do arquivo do manifesto deve terminar com .dsc.resource.json.

Nome do tipo de recurso DSC

O nome de identificação de um recurso. O nome do tipo de recurso totalmente qualificado usa a seguinte sintaxe:

`<owner>[.<group>][.<area>]/<name>`

Diretrizes

  • Primeiro menção: nome do tipo de recurso DSC
  • Menções subsequentes: tipo de recurso ou nome de tipo.
  • Ao discutir a sintaxe de um nome de tipo de recurso, sempre especifique o termo como nome de tipo de recurso totalmente qualificado.

Exemplos

Os recursos DSC são identificados exclusivamente pelo nome do tipo de recurso.

Operations

As ações que um recurso pode executar para o componente que ele gerencia.

  • Get – recupera o estado atual de uma instância do recurso.
  • Set – impõe o estado desejado de uma instância do recurso.
  • Teste – compara o estado desejado de uma instância do recurso com seu estado atual.

Diretrizes

  1. Capitalize as operações.
  2. Ao se referir especificamente à operação, formate-a como negrito.
  3. Ao fazer referência ao método da operação, conforme implementado em uma classe do PowerShell, formate o método como code com um conjunto vazio de parênteses (()) após o nome.

Exemplos

A implementação do Set() método em um recurso baseado em classe não pode usar nenhuma return instrução.

O DSC é construído em torno de um processo Get, Test e Set .

Propriedade

Uma configuração que um recurso pode gerenciar para um componente. Os recursos sempre têm pelo menos uma propriedade.

Diretrizes

  1. Formatar nomes de propriedade como negrito.
  2. Formatar valores de propriedade como código.

Exemplos

O valor da propriedade Format neste exemplo é JSON.

Termos gerais

Desired State Configuration

O Desired State Configuration (DSC) da Microsoft é uma plataforma de configuração declarativa, em que o estado de um computador é descrito usando um formato que deve ser claro para entender mesmo que o leitor não seja um especialista no assunto.

Diretrizes

  • Primeiro menção: plataforma de Desired State Configuration (DSC) da Microsoft
  • Menções subsequentes: Plataforma DSC, DSCv3 ou DSC
  • Especifique o sufixo da plataforma ao referenciar a plataforma especificamente em contextos em que o termo pode ser confundido com o DSC do PowerShell ou o dsc comando .
  • Especifique o sufixo de versão ao discutir o DSC em contextos em que o termo historicamente também se aplica ao DSC do PowerShell.

Exemplos

Na plataforma de Desired State Configuration (DSC) da Microsoft, os Recursos de DSC representam uma interface padronizada para gerenciar as configurações de um sistema.

Você pode usar o DSC para listar os recursos disponíveis com o dsc resource list comando .

Para recursos que não implementam a operação de teste , o DSCv3 pode validar o estado de uma instância com um teste sintético.

dsc

A ferramenta de linha de comando DSC que invoca recursos e gerencia documentos de configuração.

Diretrizes

  • Especifique o termo como DSC ao discutir a ferramenta de linha de comando em geral.
  • Especifique o termo como DSCv3 ao discutir a ferramenta de linha de comando em contextos em que o termo historicamente também se aplica ao DSC do PowerShell.
  • Use a formatação de código ao discutir a execução do comando, um subcomando específico ou para distinguir a ferramenta de linha de comando da plataforma conceitual.

Exemplos

Use o dsc resource test comando para invocar a operação. O DSC retorna dados que incluem:

  • O estado desejado para a instância.
  • O estado real da instância.
  • Se a instância está no estado desejado.
  • A lista de propriedades que não estão no estado desejado.

Desired State Configuration do PowerShell

O recurso Desired State Configuration do PowerShell. Antes do DSCv3, esse termo incluía a plataforma DSC do PowerShell, a Configuration Manager Local e o módulo PSDesiredStateConfiguration do PowerShell.

Para DSCv3, esse termo se aplica à definição e ao uso de recursos DSC implementados no PowerShell com o módulo PSDesiredStateConfiguration .

Diretrizes

  • Primeiro menção: Desired State Configuration do PowerShell
  • Menções subsequentes: DSC ou PSDSC do PowerShell
  • Sempre distingue o DSC do PowerShell do DSCv3.
  • Sempre especifique o módulo PSDesiredStateConfiguration pelo nome e enfatizado ao discutir o próprio módulo do PowerShell.

Exemplos

Você pode usar recursos de DSC do PowerShell com DSCv3.

Comece a criar um recurso de DSC do PowerShell baseado em classe para gerenciar um arquivo de configuração. Concluir este tutorial fornece um recurso PSDSC baseado em classe funcional em um módulo que você pode usar para mais aprendizado e personalização.