Set-AzureRmVMDscExtension
Konfigurálja a DSC-bővítményt egy virtuális gépen.
Figyelmeztetés
Az AzureRM PowerShell-modul 2024. február 29-én hivatalosan elavult. Javasoljuk a felhasználóknak, hogy migráljanak az AzureRM-ből az Az PowerShell-modulba a folyamatos támogatás és frissítések biztosítása érdekében.
Bár az AzureRM-modul továbbra is működik, a továbbiakban nem tart fenn vagy nem támogatott, így a folyamatos használatot a felhasználó saját belátása szerint és kockázatára teheti. Az Az modulra való áttéréshez tekintse meg a migrálási erőforrásainkat.
Syntax
Set-AzureRmVMDscExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-ArchiveBlobName] <String>
[-ArchiveStorageAccountName] <String>
[-ArchiveResourceGroupName <String>]
[-ArchiveStorageEndpointSuffix <String>]
[-ArchiveContainerName <String>]
[-ConfigurationName <String>]
[-ConfigurationArgument <Hashtable>]
[-ConfigurationData <String>]
[-Version] <String>
[-Force]
[-Location <String>]
[-AutoUpdate]
[-WmfVersion <String>]
[-DataCollection <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
A Set-AzureRmVMDscExtension parancsmag konfigurálja a Windows PowerShell Desired State Configuration (DSC) bővítményt egy erőforráscsoport virtuális gépén.
Példák
1. példa: DSC-bővítmény beállítása
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US"
Ez a parancs beállítja a VM07 nevű virtuális gép DSC-bővítményét, hogy Sample.ps1.zip töltse le az Stg nevű tárfiókból és az alapértelmezett tárolóból. A parancs meghívja a ConfigName nevű konfigurációt. A Sample.ps1.zip fájlt korábban a Publish-AzureRmVMDscConfiguration használatával töltötték fel.
2. példa: DSC-bővítmény beállítása konfigurációs adatokkal
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US"
Ez a parancs beállítja a VM13 nevű virtuális gép bővítményét, hogy Sample.ps1.zip töltse le az Stg nevű tárfiókból és a WindowsPowerShellDSC nevű tárolóból. A ConfigName nevű konfiguráció parancsa, amely megadja a konfigurációs adatokat és az argumentumokat. A Sample.ps1.zip fájlt korábban a Publish-AzureRmVMDscConfiguration használatával töltötték fel.
3. példa: DSC-bővítmény beállítása automatikus frissítéssel rendelkező konfigurációs adatokkal
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate
Ez a parancs beállítja a VM22 nevű virtuális gép bővítményét, hogy Sample.ps1.zip töltse le az Stg nevű tárfiókból és a WindowsPowerShellDSC nevű tárolóból. A parancs meghívja a ConfigName nevű konfigurációt, és megadja a konfigurációs adatokat és az argumentumokat. Ez a parancs lehetővé teszi a bővítménykezelő automatikus frissítését a legújabb verzióra. A Sample.ps1.zip korábban a Publish-AzureRmVMDscConfiguration használatával töltötték fel.
Paraméterek
-ArchiveBlobName
Megadja a Publish-AzureRmVMDscConfiguration parancsmag által korábban feltöltött konfigurációs fájl nevét.
Típus: | String |
Aliasok: | ConfigurationArchiveBlob |
Position: | 5 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ArchiveContainerName
Annak az Azure Storage-tárolónak a fajneve, ahol a konfigurációs archívum található.
Típus: | String |
Aliasok: | ContainerName |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ArchiveResourceGroupName
Megadja annak az erőforráscsoportnak a nevét, amely a konfigurációs archívumot tartalmazó tárfiókot tartalmazza. Ez a paraméter nem kötelező, ha a tárfiók és a virtuális gép ugyanabban az erőforráscsoportban található.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ArchiveStorageAccountName
Az ArchiveBlobName letöltéséhez használt Azure Storage-fiók nevét adja meg.
Típus: | String |
Aliasok: | StorageAccountName |
Position: | 4 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ArchiveStorageEndpointSuffix
Megadja a tárolási végpont utótagját.
Típus: | String |
Aliasok: | StorageEndpointSuffix |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-AutoUpdate
A Verzió paraméter által megadott bővítménykezelő verziót adja meg. Alapértelmezés szerint a bővítménykezelő nincs automatikusan feladva. Az Automatikus frissítés paraméter használatával engedélyezheti a bővítménykezelő automatikus frissítését a legújabb verzióra, amint és amikor elérhető.
Típus: | SwitchParameter |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ConfigurationArgument
Egy kivonattáblát ad meg, amely a konfigurációs függvény argumentumait tartalmazza.
Típus: | Hashtable |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ConfigurationData
Egy .psd1 fájl elérési útját adja meg, amely megadja a konfiguráció adatait.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ConfigurationName
Megadja annak a konfigurációnak a nevét, amelyet a DSC-bővítmény meghív.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-Confirm
Jóváhagyást kér a parancsmag futtatása előtt.
Típus: | SwitchParameter |
Aliasok: | cf |
Position: | Named |
Alapértelmezett érték: | False |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-DataCollection
Az adatgyűjtés típusát adja meg. A paraméter elfogadható értékei a következők: Engedélyezés és letiltás.
Típus: | String |
Elfogadott értékek: | Enable, Disable |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-DefaultProfile
Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés.
Típus: | IAzureContextContainer |
Aliasok: | AzureRmContext, AzureCredential |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Force
Kényszeríti a parancs futtatását anélkül, hogy felhasználói megerősítést kérne.
Típus: | SwitchParameter |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Location
Megadja az erőforrás-bővítmény elérési útját.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-Name
Megadja a bővítményt képviselő Azure Resource Manager-erőforrás nevét. Az alapértelmezett érték a Microsoft.Powershell.DSC.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ResourceGroupName
Megadja a virtuális gép erőforráscsoportjának nevét.
Típus: | String |
Position: | 2 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-Version
Megadja annak a DSC-bővítménynek a verzióját, amelyre a Set-AzureRmVMDscExtension alkalmazza a beállításokat.
Típus: | String |
Aliasok: | HandlerVersion |
Position: | 1 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-VMName
Annak a virtuális gépnek a nevét adja meg, amelyen telepítve van a DSC-bővítménykezelő.
Típus: | String |
Position: | 3 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-WhatIf
Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut.
Típus: | SwitchParameter |
Aliasok: | wi |
Position: | Named |
Alapértelmezett érték: | False |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-WmfVersion
A WMF-verziót adja meg.
Típus: | String |
Elfogadott értékek: | 4.0, 5.0, 5.1, latest |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |