Skript

Zusammenfassung

Führen Sie PowerShell-Skriptblöcke aus.

Syntax

Script [String] #ResourceName
{
    GetScript = [string]
    SetScript = [string]
    TestScript = [string]
    [Credential = [PSCredential]]
    [DependsOn = [string[]]]
    [PsDscRunAsCredential = [PSCredential]]
}

BESCHREIBUNG

Mit Script der Ressource können Sie PowerShell-Code schreiben, um eine Ressource abzurufen, zu testen und festzulegen, wenn eine bestimmte DSC-Ressource nicht verfügbar ist. Sie müssen den Code für diese Methoden bereitstellen, alle Abhängigkeiten behandeln und sicherstellen, dass Ihr Code idempotent ist.

Tipp

Wenn möglich, empfiehlt es sich, anstelle dieser eine definierte DSC-Ressource zu verwenden. Die Script Ressource hat Nachteile, die das Testen, Verwalten und Vorhersagen erschweren.

Im Gegensatz zu anderen DSC-Ressourcen ist jede Eigenschaft für eine Script Ressource eine Schlüsseleigenschaft, und die Get-Methode für diese Ressource kann nur eine einzelne Zeichenfolge für den aktuellen Zustand zurückgeben. Es gibt keine Garantie dafür, dass diese Ressource idempotent implementiert ist oder dass sie auf jedem System wie erwartet funktioniert, da sie benutzerdefinierten Code verwendet. Es kann nicht getestet werden, ohne auf einem Zielsystem aufgerufen zu werden.

Überlegen Sie vor der Verwendung der Script Ressource, ob Sie stattdessen eine Ressource erstellen können. Durch die Verwendung gut definierter DSC-Ressourcen werden Ihre Konfigurationen besser lesbar und verwaltbar.

Anforderungen

Keine.

Eigenschaften

Schlüsseleigenschaften

GetScript

Geben Sie einen PowerShell-Skriptblock an, der den aktuellen Zustand der Ressource abruft. Dieser Skriptblock wird ausgeführt, wenn die Get-Methode für diese Ressource aufgerufen wird.

Dieser Skriptblock sollte eine Hashtabelle zurückgeben, die einen Schlüssel mit dem Namen Result mit einem Zeichenfolgenwert enthält.

Type: System.String

SetScript

Geben Sie einen PowerShell-Skriptblock an, der die Ressource mit dem gewünschten Zustand konfiguriert. Dieser Skriptblock wird ausgeführt, wenn die Set-Methode für diese Ressource aufgerufen wird.

Dieser Skriptblock sollte keine Objekte ausgeben. Dieser Skriptblock sollte idempotent geschrieben werden, sodass beim zweimalen Aufrufen der Set-Methode das Ziel in demselben Zustand verbleibt, wie es einmal aufgerufen wird.

Type: System.String

TestScript

Geben Sie einen PowerShell-Skriptblock an, der überprüft, ob sich die Ressource im gewünschten Zustand befindet. Dieser Skriptblock wird ausgeführt, wenn die Testmethode für diese Ressource aufgerufen wird.

Dieser Skriptblock sollte zurückgegeben $true werden, wenn sich die Ressource im gewünschten Zustand befindet und $false sich nicht im gewünschten Zustand befindet.

Type: System.String

Optionale Eigenschaften

Leistungsnachweis

Geben Sie die Anmeldeinformationen eines Kontos an, unter dem die Skriptblöcke bei Bedarf ausgeführt werden sollen.

Type: System.Management.Automation.PSCredential
Default Value: None

Schreibgeschützte Eigenschaften

Ergebnis

Das Ergebnis aus dem GetScript-Skriptblock .

Type: System.String

Beispiele