Freigeben über

Set-AzureVMDscExtension

  • Referenz
Modul:
Azure

Konfiguriert die DSC-Erweiterung auf einem virtuellen Computer.

Hinweis

Die Cmdlets, auf die in dieser Dokumentation verwiesen wird, dienen zum Verwalten von Azure-Legacyressourcen, die Azure Dienst-Manager (ASM) APIs verwenden. Dieses ältere PowerShell-Modul wird beim Erstellen neuer Ressourcen nicht empfohlen, da ASM für den Ruhestand geplant ist. Weitere Informationen finden Sie unter Einstellung des Azure Service Manager.

Das Az PowerShell-Modul ist das empfohlene PowerShell-Modul zum Verwalten von Azure Resource Manager (ARM)-Ressourcen mit PowerShell.

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>]

Beschreibung

Das Cmdlet Set-AzureVMDscExtension konfiguriert die DSC-Erweiterung (Desired State Configuration) auf einem virtuellen Computer.

Beispiele

Beispiel 1: Konfigurieren der DSC-Erweiterung auf einem virtuellen Computer

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

Mit diesem Befehl wird die DSC-Erweiterung auf einem virtuellen Computer konfiguriert.

Das MyConfiguration.ps1.zip-Paket muss zuvor mithilfe des Befehls "Publish-AzureVMDscConfiguration " in Azure Storage hochgeladen worden sein und enthält das Skript "MyConfiguration.ps1" und die Module, von denen es abhängt.

Das Argument MyConfiguration gibt die spezifische DSC-Konfiguration innerhalb des auszuführenden Skripts an. Der Parameter "-ConfigurationArgument " gibt eine Hashtabelle mit den Argumenten an, die an die Konfigurationsfunktion übergeben werden.

Beispiel 2: Konfigurieren der DSC-Erweiterung auf einem virtuellen Computer mithilfe eines Pfads zu den Konfigurationsdaten

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

Mit diesem Befehl wird die DSC-Erweiterung auf einem virtuellen Computer mithilfe eines Pfads zu den Konfigurationsdaten konfiguriert.

Parameter

-ConfigurationArchive

Gibt den Namen des Konfigurationspakets (.zip Datei) an, das zuvor von Publish-AzureVMDscConfiguration hochgeladen wurde. Dieser Parameter darf nur den Namen der Datei ohne Pfad angeben.

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ConfigurationArgument

Gibt eine Hashtabelle an, die die Argumente für die Konfigurationsfunktion angibt. Die Schlüssel entsprechen den Parameternamen und den Werten den Parameterwerten.

Zulässige Werte für diesen Parameter:

  • Grundtypen
  • Zeichenfolge
  • array
  • PSCredential
Typ:Hashtable
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ConfigurationDataPath

Gibt den Pfad einer PSD1-Datei an, die die Daten für die Konfigurationsfunktion angibt. Diese Datei muss eine Hashtabelle enthalten, wie unter Trennen von Konfigurations- und Umgebungsdaten beschrieben.https://msdn.microsoft.com/en-us/PowerShell/DSC/configData.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ConfigurationName

Gibt den Namen des Konfigurationsskripts oder Moduls an, das von der DSC-Erweiterung aufgerufen wird.

Der Wert dieses Parameters muss der Name einer der Konfigurationsfunktionen sein, die in den Skripts oder Modulen enthalten sind, die in ConfigurationArchive verpackt sind.

Dieses Cmdlet verwendet standardmäßig den Namen der Datei, die vom Parameter ConfigurationArchive angegeben wird, wenn Sie diesen Parameter weglassen, ohne die Erweiterung. Wenn configurationArchive beispielsweise "SalesWebSite.ps1.zip" lautet, lautet der Standardwert für "ConfigurationName" "SalesWebSite".

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ContainerName

Gibt den Namen des Azure-Speichercontainers an, in dem sich die ConfigurationArchive befindet.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DataCollection

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Force

Gibt an, dass dieses Cmdlet vorhandene Blobs überschreibt.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-InformationAction

Gibt an, wie dieses Cmdlet auf ein Informationsereignis reagiert.

Zulässige Werte für diesen Parameter:

  • Fortsetzen
  • Ignorieren
  • Inquire
  • SilentlyContinue
  • Beenden
  • Angehalten
Typ:ActionPreference
Aliase:infa
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-InformationVariable

Gibt eine Informationsvariable an.

Typ:String
Aliase:iv
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Profile

Gibt das Azure-Profil an, aus dem dieses Cmdlet liest. Wenn Sie kein Profil angeben, liest dieses Cmdlet aus dem lokalen Standardprofil.

Typ:AzureSMProfile
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ReferenceName

Gibt eine benutzerdefinierte Zeichenfolge an, die verwendet werden kann, um auf eine Erweiterung zu verweisen. Dieser Parameter wird angegeben, wenn die Erweiterung zum ersten Mal dem virtuellen Computer hinzugefügt wird. Bei nachfolgenden Updates sollten Sie den zuvor verwendeten Verweisnamen angeben, während Sie die Erweiterung aktualisieren. Der einer Erweiterung zugewiesene Verweisname wird mithilfe des Cmdlets "Get-AzureVM " zurückgegeben.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-StorageContext

Gibt den Azure-Speicherkontext an, der die Sicherheitseinstellungen bereitstellt, die für den Zugriff auf das Konfigurationsskript verwendet werden. Dieser Kontext bietet Lesezugriff auf den container, der durch den ContainerName-Parameter angegeben wird.

Typ:AzureStorageContext
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-StorageEndpointSuffix

Gibt das DNS-Endpunktsuffix für alle Speicherdienste an, z. B. "core.contoso.net".

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Version

Gibt die spezifische Version der zu verwendenden DSC-Erweiterung an. Der Standardwert wird auf "1.*" festgelegt, wenn dieser Parameter nicht angegeben ist.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-VM

Gibt das objekt des beständigen virtuellen Computers an.

Typ:IPersistentVM
Aliase:InputObject
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WmfVersion

Gibt die Version von Windows Management Framework (WMF) an, die auf dem virtuellen Computer installiert werden soll. Die DSC-Erweiterung hängt von DSC-Features ab, die nur in den WMF-Updates verfügbar sind. Dieser Parameter gibt an, welche Version des Updates auf dem virtuellen Computer installiert werden soll. Zulässige Werte für diesen Parameter:

  • 4.0. Installiert WMF 4.0, es sei denn, eine neuere Version ist bereits installiert.
  • 5.0. Installiert die neueste Version von WMF 5.0.
  • neueste. Installiert die neueste WMF, derzeit WMF 5.0.

Der Standardwert ist neueste.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False