PowerShell DSC-bővítmény

Cikk
07/27/2023

Megjegyzés

A DSC-bővítmény engedélyezése előtt szeretnénk tudni, hogy a DSC egy újabb verziója már általánosan elérhető, amelyet az Azure Automange nevű gépkonfiguráció egyik funkciója felügyel. A gépkonfigurációs funkció egyesíti a Desired State Configuration (DSC) bővítménykezelőjének funkcióit, a Azure Automation State Configuration és a leggyakrabban kért funkciókat az ügyfelek visszajelzései alapján. A gépkonfiguráció a hibrid gépek Arc-kompatibilis kiszolgálókon keresztüli támogatását is magában foglalja.

Áttekintés

A Windowshoz készült PowerShell DSC-bővítményt a Microsoft teszi közzé és támogatja. A bővítmény feltölt és alkalmaz egy PowerShell DSC-konfigurációt egy Azure-beli virtuális gépen. A DSC-bővítmény meghívja a PowerShell DSC-t, hogy életbe léptethesse a fogadott DSC-konfigurációt a virtuális gépen. Ez a dokumentum a Windows DSC virtuálisgép-bővítményének támogatott platformjairól, konfigurációiról és üzembehelyezési lehetőségeiről nyújt tájékoztatást.

Előfeltételek

Operációs rendszer

A DSC-bővítmény az alábbi operációs rendszereket támogatja

Windows Server 2022, Windows Server 2019, Windows Server 2016, Windows Server 2012R2, Windows Server 2012, Windows Server 2008 R2 SP1, Windows Client 7/8.1/10

Internetkapcsolat

A Windowshoz készült DSC-bővítmény megköveteli, hogy a cél virtuális gép kommunikálhasson az Azure-ral és a konfigurációs csomag (.zip fájl) helyével, ha az Azure-on kívüli helyen van tárolva.

Bővítményséma

Az alábbi JSON egy Azure Resource Manager-sablon DSC-bővítményének beállítási részéhez tartozó sémát mutatja be.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "Microsoft.Powershell.DSC",
  "apiVersion": "2018-10-01",
  "location": "<location>",
  "properties": {
    "publisher": "Microsoft.Powershell",
    "type": "DSC",
    "typeHandlerVersion": "2.77",
    "autoUpgradeMinorVersion": true,
    "settings": {
        "wmfVersion": "latest",
        "configuration": {
            "url": "http://validURLToConfigLocation",
            "script": "ConfigurationScript.ps1",
            "function": "ConfigurationFunction"
        },
        "configurationArguments": {
            "argument1": "Value1",
            "argument2": "Value2"
        },
        "configurationData": {
            "url": "https://foo.psd1"
        },
        "privacy": {
            "dataCollection": "enable"
        },
        "advancedOptions": {
            "forcePullAndApply": false,
            "downloadMappings": {
             "specificDependencyKey": "https://myCustomDependencyLocation"
            }
        }
    },
    "protectedSettings": {
        "configurationArguments": {
            "parameterOfTypePSCredential1": {
                "userName": "UsernameValue1",
                "password": "PasswordValue1"
            },
            "parameterOfTypePSCredential2": {
                "userName": "UsernameValue2",
                "password": "PasswordValue2"
            }
        },
        "configurationUrlSasToken": "?g!bber1sht0k3n",
        "configurationDataUrlSasToken": "?dataAcC355T0k3N"
    }
  }
}

Tulajdonságértékek

Name	Érték/példa	Adattípus
apiVersion	2018-10-01	dátum
közzétevő	Microsoft.Powershell.DSC	sztring
típus	DSC	sztring
typeHandlerVersion	2.77	int

Beállítások Tulajdonságértékek

Name	Adattípus	Leírás
settings.wmfVersion	sztring	A virtuális gépre telepíteni kívánt Windows Management Framework verzióját adja meg. Ha ezt a tulajdonságot a "legújabb" értékre állítja, akkor a WMF legújabb verziója lesz telepítve. Ennek a tulajdonságnak az egyetlen lehetséges értéke a "4.0", az "5.0" és a "latest". Ezekre a lehetséges értékekre frissítések vonatkoznak. Az alapértelmezett érték a "latest".
settings.configuration.url	sztring	Megadja azt az URL-címet, ahonnan a DSC konfigurációs zip-fájlját le szeretné tölteni. Ha a megadott URL-címhez SAS-jogkivonat szükséges a hozzáféréshez, a protectedSettings.configurationUrlSasToken tulajdonságot az SAS-jogkivonat értékére kell állítania. Ez a tulajdonság akkor szükséges, ha a settings.configuration.script és/vagy settings.configuration.function definiálva van.
settings.configuration.script	sztring	Megadja annak a szkriptnek a fájlnevét, amely a DSC-konfiguráció definícióját tartalmazza. Ennek a szkriptnek a configuration.url tulajdonság által megadott URL-címről letöltött zip-fájl gyökérmappájában kell lennie. Ez a tulajdonság akkor szükséges, ha a settings.configuration.url és/vagy settings.configuration.script meg van határozva.
settings.configuration.function	sztring	Megadja a DSC-konfiguráció nevét. A névvel ellátott konfigurációnak tartalmaznia kell a configuration.script által meghatározott szkriptet. Ez a tulajdonság akkor szükséges, ha a settings.configuration.url és/vagy settings.configuration.function meg van határozva.
settings.configurationArguments	Gyűjtemény	Meghatározza a DSC-konfigurációnak átadni kívánt paramétereket. Ez a tulajdonság nem lesz titkosítva.
settings.configurationData.url	sztring	Megadja azt az URL-címet, amelyről a DSC-konfiguráció bemeneteként használni kívánt konfigurációs adatfájlt (.pds1) le szeretné tölteni. Ha a megadott URL-címhez SAS-jogkivonat szükséges a hozzáféréshez, a protectedSettings.configurationDataUrlSasToken tulajdonságot az SAS-jogkivonat értékére kell állítania.
settings.privacy.dataEnabled	sztring	Engedélyezi vagy letiltja a telemetriai gyűjteményt. Ennek a tulajdonságnak az egyetlen lehetséges értéke az "Engedélyezés", a "Letiltás", a "vagy a $null. Ha ezt a tulajdonságot üresen vagy null értékként hagyja, a telemetria engedélyezve lesz
settings.advancedOptions.forcePullAndApply	Logikai	Ez a beállítás a csomópontok Azure Automation DSC-vel való regisztrálásához szükséges bővítmény használatának élményét hivatott fokozni. Ha az érték `$true`, a bővítmény megvárja a szolgáltatásból lekért konfiguráció első futtatását, mielőtt sikert/hibát ad vissza. Ha az érték $false értékre van állítva, a bővítmény által visszaadott állapot csak arra utal, hogy a csomópont sikeresen regisztrálva lett-e Azure Automation State Configuration, és a csomópont konfigurációja nem lesz futtatva a regisztráció során.
settings.advancedOptions.downloadMappings	Gyűjtemény	Alternatív helyeket határoz meg a függőségek letöltéséhez, például a WMF-et és a .NET-et

Védett beállítások tulajdonságértékek

Name	Adattípus	Leírás
protectedSettings.configurationArguments	sztring	Meghatározza a DSC-konfigurációnak átadni kívánt paramétereket. Ez a tulajdonság titkosítva lesz.
protectedSettings.configurationUrlSasToken	sztring	A configuration.url által meghatározott URL-cím eléréséhez szükséges SAS-jogkivonatot adja meg. Ez a tulajdonság titkosítva lesz.
protectedSettings.configurationDataUrlSasToken	sztring	A configurationData.url által meghatározott URL-cím eléréséhez szükséges SAS-jogkivonatot adja meg. Ez a tulajdonság titkosítva lesz.

Sablonalapú telepítés

Az Azure-beli virtuálisgép-bővítmények Azure Resource Manager-sablonokkal helyezhetők üzembe. A sablonok ideálisak egy vagy több olyan virtuális gép üzembe helyezésekor, amely az üzembe helyezés utáni konfigurációt igényli. A Windows DSC-bővítményét tartalmazó minta Resource Manager sablon az Azure Gyors üzembe helyezési gyűjteményében található.

Hibaelhárítás és támogatás

Hibaelhárítás

A bővítmények üzembe helyezésének állapotára vonatkozó adatok lekérhetők az Azure Portalról és az Azure CLI használatával. Egy adott virtuális gép bővítményeinek üzembehelyezési állapotának megtekintéséhez futtassa az alábbi parancsot az Azure CLI használatával.

az vm extension list --resource-group myResourceGroup --vm-name myVM -o table

A bővítménycsomagot a rendszer letölti és üzembe helyezi erre a helyre az Azure-beli virtuális gépen

C:\Packages\Plugins\{Extension_Name}\{Extension_Version}

A bővítmény állapotfájlja tartalmazza az alállapotot és a sikerre/hibára utaló állapotkódokat, valamint az egyes futtatott bővítmények részletes hibaüzenetét és leírását.

C:\Packages\Plugins\{Extension_Name}\{Extension_Version}\Status\{0}.Status  -> {0} being the sequence number

A bővítmény kimeneti naplói a következő könyvárban vannak naplózva:

C:\WindowsAzure\Logs\Plugins\{Extension_Name}\{Extension_Version}

Hibakódok és jelentésük

Hibakód	Értelmezés	Lehetséges művelet
1000	Általános hiba	A hiba üzenetét a bővítménynaplókban található adott kivétel adja meg
52	Bővítmény telepítési hibája	A hiba üzenetét az adott kivétel adja meg
1002	Wmf telepítési hiba	Hiba történt a WMF telepítése során.
1004	Érvénytelen zip-csomag	Érvénytelen zip ; Hiba történt a zip kicsomagolása közben
1100	Argumentumhiba	Problémát jelez a felhasználó által megadott bemenetben. A hiba üzenetét az adott kivétel adja meg

Támogatás

Ha a cikk bármely pontján további segítségre van szüksége, forduljon az Azure szakértőihez az MSDN Azure és a Stack Overflow fórumain. Másik lehetőségként Azure-támogatás incidenst is beküldhet. Nyissa meg a Azure-támogatás webhelyet, és válassza a Támogatás kérése lehetőséget. Az Azure-támogatás használatáról a Microsoft Azure-támogatás gyakori kérdések című témakörben olvashat.

Megosztás a következőn keresztül: