resourceId

Artigo
05/09/2024

Sinopse

Devolve o identificador exclusivo de um recurso.

Syntax

resourceId('<resourceTypeName>', '<instanceName>')

Descrição

A resourceId() função devolve uma alça a uma instância de recurso específica na configuração. Esta função permite que as instâncias referenciem outra instância para a opção dependsOn .

Nota

Ao utilizar a resourceId função para instâncias de recursos aninhadas, as instâncias só podem referenciar outras instâncias no mesmo fornecedor de recursos ou instância de grupo. Não podem utilizar a resourceId() função para procurar instâncias no nível superior do documento de configuração ou dentro de outro fornecedor ou instância de grupo.

Exemplos

Exemplo 1 - Referenciar um recurso como uma dependência

A seguinte configuração utiliza a resourceId() função para referenciar a instância denominada Tailspin Key como dependência da instância de Update Tailspin Automatically recurso.

# resourceId.example.1.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
  - name: Tailspin Key
    type: Microsoft.Windows/Registry
    properties:
      keyPath: HKCU\tailspin
      _ensure: Present
  - name: Update Tailspin Automatically
    type: Microsoft.Windows/Registry
    properties:
      keyPath:   HKCU\tailspin\updates
      valueName: automatic
      valueData:
        String: enable
    dependsOn:
      - "[resourceId('Microsoft.Windows/Registry', 'Tailspin Key')]"

Exemplo 2 - Referenciar um recurso de grupo como uma dependência

A seguinte configuração utiliza a resourceId() função para especificar a DSC/AssertionGroup instância de recurso denominada "IsWindows" como uma dependência da instância de Example Key recurso.

# resourceId.example.2.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
  - name: IsWindows
    type: DSC/AssertionGroup
    properties:
      $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
      resources:
        - name: os
          type: Microsoft/OSInfo
          properties:
            family: Windows
  - name: Example Key
    type: Microsoft.Windows/Registry
    properties:
      keyPath: HKCU\example
      _exist: true

Parâmetros

resourceTypeName

O valor da propriedade tipo da instância de recurso a referenciar. O valor tem de ser o nome do tipo completamente qualificado para o recurso.

Type:     string
Required: true
Position: 0

instanceName

O valor da propriedade name da instância de recurso a referenciar.

Type:     string
Required: true
Position: 0

Partilhar via