Set-AzureVMDscExtension
Konfigurálja a DSC-bővítményt egy virtuális gépen.
Feljegyzés
A jelen dokumentációban hivatkozott parancsmagok az Azure Service Manager (ASM) API-kat használó örökölt Azure-erőforrások kezelésére szolgálnak. Ez az örökölt PowerShell-modul nem ajánlott új erőforrások létrehozásakor, mivel az ASM a kivonásra van ütemezve. További információkért lásd az Azure Service Manager kivonását.
Az Az PowerShell-modul az ajánlott PowerShell-modul az Azure Resource Manager-erőforrások PowerShell-lel való kezeléséhez.
Syntax
Set-AzureVMDscExtension
[-ReferenceName <String>]
[-ConfigurationArgument <Hashtable>]
[-ConfigurationDataPath <String>]
[-ConfigurationArchive] <String>
[-ConfigurationName <String>]
[-ContainerName <String>]
[-Force]
[-StorageContext <AzureStorageContext>]
[-Version <String>]
[-StorageEndpointSuffix <String>]
[-WmfVersion <String>]
[-DataCollection <String>]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
A Set-AzureVMDscExtension parancsmag konfigurálja a Desired State Configuration (DSC) bővítményt egy virtuális gépen.
Példák
1. példa: A DSC-bővítmény konfigurálása virtuális gépen
PS C:\> Set-AzureVMDscExtension -VM $VM -ConfigurationArchive MyConfiguration.ps1.zip -ConfigurationName MyConfiguration -ConfigurationArgument @{ Path = 'C:\MyDirectory' }
DeploymentName : my-vm-svc
Name : my-vm
Label :
VM : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM
InstanceStatus : ReadyRole
IpAddress : 10.10.10.10
InstanceStateDetails :
PowerState : Started
InstanceErrorCode :
InstanceFaultDomain : 0
InstanceName : my-vm
InstanceUpgradeDomain : 0
InstanceSize : Small
AvailabilitySetName :
DNSName : http://my-vm-svc.cloudapp.net/
Status : ReadyRole
GuestAgentStatus : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus
ResourceExtensionStatusList : {Contoso.Compute.BGInfo}
PublicIPAddress :
PublicIPName :
ServiceName : my-vm-svc
OperationDescription : Get-AzureVM
OperationId : a0217a7af900c1f8a212299a3333cdbd6
OperationStatus : OK
Ez a parancs konfigurálja a DSC-bővítményt egy virtuális gépen.
A MyConfiguration.ps1.zip csomagot korábban a Publish-AzureVMDscConfiguration paranccsal kellett feltölteni az Azure Storage-ba, és tartalmazza a MyConfiguration.ps1 szkriptet és az attól függő modulokat.
A MyConfiguration argumentum azt jelzi, hogy a szkripten belül milyen DSC-konfigurációt kell végrehajtani. A -ConfigurationArgument paraméter egy kivonatolót ad meg a konfigurációs függvénynek átadott argumentumokkal.
2. példa: A DSC-bővítmény konfigurálása virtuális gépen a konfigurációs adatok elérési útján
PS C:\> $VM | Set-AzureVMDscExtension -ConfigurationArchive MyConfiguration.ps1.zip -ConfigurationName MyConfiguration -ConfigurationArgument @{ Credential = Get-Credential } -ConfigurationDataPath MyConfigurationData.psd1
DeploymentName : my-vm-svc
Name : my-vm
Label :
VM : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM
InstanceStatus : ReadyRole
IpAddress : 10.10.10.10
InstanceStateDetails :
PowerState : Started
InstanceErrorCode :
InstanceFaultDomain : 0
InstanceName : my-vm
InstanceUpgradeDomain : 0
InstanceSize : Small
AvailabilitySetName :
DNSName : http://my-vm-svc.cloudapp.net/
Status : ReadyRole
GuestAgentStatus : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus
ResourceExtensionStatusList : {Microsoft.Compute.BGInfo, Microsoft.Powershell.DSC}
PublicIPAddress :
PublicIPName :
ServiceName : my-vm-svc
OperationDescription : Get-AzureVM
OperationId : a0217a7af900c1f8a212299a3333cdbd7
OperationStatus : OK
Ez a parancs konfigurálja a DSC-bővítményt egy virtuális gépen a konfigurációs adatok elérési útján.
Paraméterek
-ConfigurationArchive
Megadja a Publish-AzureVMDscConfiguration által korábban feltöltött konfigurációs csomag (.zip fájl) nevét. Ennek a paraméternek csak a fájl nevét kell megadnia, elérési út nélkül.
Típus: | String |
Position: | 1 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ConfigurationArgument
Egy kivonatolót ad meg, amely megadja a konfigurációs függvény argumentumait. A kulcsok a paraméterneveknek és a paraméterértékeknek megfelelő értékeknek felelnek meg.
A paraméter elfogadható értékei a következők:
- primitív típusok
- húr
- array
- PSCredential
Típus: | Hashtable |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-ConfigurationDataPath
Egy .psd1 fájl elérési útját adja meg, amely megadja a konfigurációs függvény adatait. Ennek a fájlnak tartalmaznia kell egy kivonatolót a konfigurációs és környezeti adatok elkülönítése című cikkben leírtak szerinthttps://msdn.microsoft.com/en-us/PowerShell/DSC/configData.
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ós szkriptnek vagy modulnak a nevét, amelyet a DSC-bővítmény hív meg.
Ennek a paraméternek az értékének a ConfigurationArchive-ben csomagolt szkriptekben vagy modulokban található egyik konfigurációs függvény nevének kell lennie.
Ez a parancsmag alapértelmezés szerint a ConfigurationArchive paraméter által megadott fájl nevére vonatkozik, ha kihagyja ezt a paramétert, a bővítmények kivételével. Ha például a ConfigurationArchive értéke "SalesWebSite.ps1.zip", a ConfigurationName alapértelmezett értéke a "SalesWebSite".
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 |
-ContainerName
Annak az Azure Storage-tárolónak a nevét adja meg, amelyben a ConfigurationArchive 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 |
-DataCollection
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-Force
Azt jelzi, hogy ez a parancsmag felülírja a meglévő blobokat.
Típus: | SwitchParameter |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-InformationAction
Meghatározza, hogy ez a parancsmag hogyan reagál egy információs eseményre.
A paraméter elfogadható értékei a következők:
- Folytatás
- Mellőzés
- Érdeklődik
- SilentlyContinue
- Leállítás
- Felfüggesztés
Típus: | ActionPreference |
Aliasok: | infa |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-InformationVariable
Egy információs változót ad meg.
Típus: | String |
Aliasok: | iv |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Profile
Azt az Azure-profilt adja meg, amelyből a parancsmag beolvassa. Ha nem ad meg profilt, ez a parancsmag a helyi alapértelmezett profilból olvas be.
Típus: | AzureSMProfile |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ReferenceName
Egy felhasználó által definiált sztringet ad meg, amely egy bővítményre hivatkozhat. Ezt a paramétert akkor adja meg a rendszer, ha a bővítmény első alkalommal lesz hozzáadva a virtuális géphez. A későbbi frissítésekhez meg kell adnia a korábban használt hivatkozásnevet a bővítmény frissítése során. A bővítményhez rendelt ReferenceName a Get-AzureVM parancsmaggal lesz visszaadva.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-StorageContext
A konfigurációs szkript eléréséhez használt biztonsági beállításokat biztosító Azure Storage-környezetet adja meg. Ez a környezet olvasási hozzáférést biztosít a ContainerName paraméter által megadott tárolóhoz.
Típus: | AzureStorageContext |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-StorageEndpointSuffix
Az összes tárolási szolgáltatás DNS-végpontjának utótagját adja meg, például "core.contoso.net".
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-Version
A használni kívánt DSC-bővítmény adott verzióját adja meg. Ha ez a paraméter nincs megadva, az alapértelmezett érték "1.*" lesz.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-VM
Az állandó virtuálisgép-objektumot adja meg.
Típus: | IPersistentVM |
Aliasok: | InputObject |
Position: | Named |
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
Megadja a virtuális gépre telepíteni kívánt Windows Management Framework (WMF) verzióját. A DSC-bővítmény olyan DSC-funkcióktól függ, amelyek csak a WMF-frissítésekben érhetők el. Ez a paraméter határozza meg, hogy a frissítés melyik verzióját telepítse a virtuális gépre. A paraméter elfogadható értékei a következők:
- 4.0. Telepíti a WMF 4.0-t, kivéve, ha egy újabb verzió már telepítve van.
- 5.0. Telepíti a WMF 5.0 legújabb kiadását.
- legkésőbbi. Telepíti a legújabb WMF-et, amely jelenleg a WMF 5.0-s verziója.
Az alapértelmezett érték a legújabb.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |