resourceId

Zusammenfassung

Gibt den eindeutigen Bezeichner einer Ressource zurück.

Syntax

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

BESCHREIBUNG

Die resourceId() Funktion gibt ein Handle an eine bestimmte Ressource zurück, instance in der Konfiguration. Mit dieser Funktion können Instanzen auf eine andere instance für die Option dependsOn verweisen.

Hinweis

Wenn Sie die resourceId Funktion für geschachtelte Ressourceninstanzen verwenden, können Instanzen nur auf andere Instanzen in demselben Ressourcenanbieter oder derselben Gruppe verweisen instance. Sie können die resourceId() Funktion nicht verwenden, um Instanzen auf der obersten Ebene des Konfigurationsdokuments oder innerhalb eines anderen Anbieters oder einer Gruppe instance.

Beispiele

Beispiel 1: Verweisen auf eine Ressource als Abhängigkeit

Die folgende Konfiguration verwendet die resourceId() -Funktion, um auf die instance zu verweisen, die als Abhängigkeit der Update Tailspin Automatically Ressource instance benannt istTailspin Key.

# 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')]"

Beispiel 2: Verweisen auf eine Gruppenressource als Abhängigkeit

Die folgende Konfiguration verwendet die resourceId() -Funktion, um die DSC/AssertionGroup Ressource instance namens "IsWindows" als Abhängigkeit der Ressource anzugeben, die Example Key instance.

# 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

Parameter

resourceTypeName

Der Wert der type-Eigenschaft der Ressource, auf die instance verwiesen werden soll. Der Wert muss der vollqualifizierte Typname für die Ressource sein.

Type:     string
Required: true
Position: 0

INSTANCENAME

Der Wert der name-Eigenschaft der Ressource, auf die instance verwiesen werden soll.

Type:     string
Required: true
Position: 0