Set-AzureVMDscExtension
Nakonfiguruje rozšíření DSC na virtuálním počítači.
Poznámka:
Rutiny, na které odkazuje tato dokumentace, slouží ke správě starších prostředků Azure, které používají rozhraní API Azure Service Manageru (ASM). Tento starší modul PowerShellu se nedoporučuje při vytváření nových prostředků, protože ASM je naplánované pro vyřazení z provozu. Další informace najdete v části Vyřazení Azure Service Manageru.
Modul Az PowerShell je doporučený modul PowerShellu pro správu prostředků Azure Resource Manageru (ARM) pomocí PowerShellu.
Syntaxe
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
Rutina Set-AzureVMDscExtension nakonfiguruje rozšíření DSC (Desired State Configuration) na virtuálním počítači.
Příklady
Příklad 1: Konfigurace rozšíření DSC na virtuálním počítači
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
Tento příkaz nakonfiguruje rozšíření DSC na virtuálním počítači.
Balíček MyConfiguration.ps1.zip musel být dříve odeslán do úložiště Azure pomocí příkazu Publish-AzureVMDscConfiguration a zahrnuje skript MyConfiguration.ps1 a moduly, na kterých závisí.
Argument MyConfiguration označuje konkrétní konfiguraci DSC v rámci skriptu, který se má spustit. Parametr -ConfigurationArgument určuje hashtable s argumenty předanými konfigurační funkci.
Příklad 2: Konfigurace rozšíření DSC na virtuálním počítači pomocí cesty ke konfiguračním datům
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
Tento příkaz nakonfiguruje rozšíření DSC na virtuálním počítači pomocí cesty ke konfiguračním datům.
Parametry
-ConfigurationArchive
Určuje název konfiguračního balíčku (.zip souboru), který byl dříve nahraný nástrojem Publish-AzureVMDscConfiguration. Tento parametr musí zadat pouze název souboru bez jakékoli cesty.
Typ: | String |
Position: | 1 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ConfigurationArgument
Určuje hashovací tabulku určující argumenty konfigurační funkce. Klíče odpovídají názvům parametrů a hodnotám parametrů.
Tento parametr přijímá tyto hodnoty:
- primitivní typy
- string
- pole
- PsCredential
Typ: | Hashtable |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ConfigurationDataPath
Určuje cestu k souboru .psd1, který určuje data pro konfigurační funkci. Tento soubor musí obsahovat hashtable, jak je popsáno v části Oddělení dat konfigurace a prostředí.https://msdn.microsoft.com/en-us/PowerShell/DSC/configData.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ConfigurationName
Určuje název konfiguračního skriptu nebo modulu, který je vyvolán rozšířením DSC.
Hodnota tohoto parametru musí být název jedné z konfiguračních funkcí obsažených ve skriptech nebo modulech zabalených v ConfigurationArchive.
Pokud tento parametr vynecháte, vyloučíte-li tento parametr, tato rutina ve výchozím nastavení nastaví název souboru zadaného parametrem ConfigurationArchive . Pokud je například ConfigurationArchive "SalesWebSite.ps1.zip", výchozí hodnota ConfigurationName je "SalesWebSite".
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Confirm
Před spuštěním rutiny zobrazí výzvu k potvrzení.
Typ: | SwitchParameter |
Aliasy: | cf |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-ContainerName
Určuje název kontejneru úložiště Azure, ve kterém se nachází ConfigurationArchive .
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-DataCollection
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Force
Označuje, že tato rutina přepíše existující objekty blob.
Typ: | SwitchParameter |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-InformationAction
Určuje, jak tato rutina reaguje na informační událost.
Tento parametr přijímá tyto hodnoty:
- Pokračovat
- Ignorovat
- Informovat se
- SilentlyContinue
- Zastavit
- Suspend
Typ: | ActionPreference |
Aliasy: | infa |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-InformationVariable
Určuje informační proměnnou.
Typ: | String |
Aliasy: | iv |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-Profile
Určuje profil Azure, ze kterého se tato rutina čte. Pokud nezadáte profil, tato rutina načte z místního výchozího profilu.
Typ: | AzureSMProfile |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-ReferenceName
Určuje uživatelem definovaný řetězec, který lze použít k odkazování na rozšíření. Tento parametr se zadává při prvním přidání rozšíření do virtuálního počítače. V případě následných aktualizací byste při aktualizaci rozšíření měli zadat dříve použitý název odkazu. ReferenceName přiřazené k rozšíření se vrátí pomocí rutiny Get-AzureVM.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-StorageContext
Určuje kontext úložiště Azure, který poskytuje nastavení zabezpečení používané pro přístup ke konfiguračnímu skriptu. Tento kontext poskytuje přístup pro čtení ke kontejneru určenému parametrem ContainerName .
Typ: | AzureStorageContext |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-StorageEndpointSuffix
Určuje příponu koncového bodu DNS pro všechny služby úložiště, například "core.contoso.net".
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Version
Určuje konkrétní verzi rozšíření DSC, která se má použít. Výchozí hodnota je nastavena na hodnotu 1.*, pokud tento parametr není zadán.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-VM
Určuje trvalý objekt virtuálního počítače.
Typ: | IPersistentVM |
Aliasy: | InputObject |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-WhatIf
Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.
Typ: | SwitchParameter |
Aliasy: | wi |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-WmfVersion
Určuje verzi rozhraní WMF (Windows Management Framework) pro instalaci na virtuální počítač. Rozšíření DSC závisí na funkcích DSC, které jsou dostupné pouze v aktualizacích WMF. Tento parametr určuje, která verze aktualizace se má nainstalovat na virtuální počítač. Tento parametr přijímá tyto hodnoty:
- 4.0. Nainstaluje WMF 4.0, pokud ještě není nainstalovaná novější verze.
- 5.0. Nainstaluje nejnovější verzi WMF 5.0.
- nejnovější. Nainstaluje nejnovější WMF, aktuálně WMF 5.0.
Výchozí hodnota je nejnovější.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |