Set-AzureVMDscExtension

Konfiguruje rozszerzenie DSC na maszynie wirtualnej.

Uwaga

Polecenia cmdlet, do których odwołuje się ta dokumentacja, służą do zarządzania starszymi zasobami platformy Azure korzystającymi z interfejsów API zarządzania usługami. Zobacz moduł Az programu PowerShell, aby uzyskać polecenia cmdlet do zarządzania zasobami usługi Azure Resource Manager.

Składnia

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

Opis

Polecenie cmdlet Set-AzureVMDscExtension konfiguruje rozszerzenie Desired State Configuration (DSC) na maszynie wirtualnej.

Przykłady

Przykład 1. Konfigurowanie rozszerzenia DSC na maszynie wirtualnej

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

To polecenie konfiguruje rozszerzenie DSC na maszynie wirtualnej.

Pakiet MyConfiguration.ps1.zip musi zostać wcześniej przekazany do usługi Azure Storage przy użyciu polecenia Publish-AzureVMDscConfiguration i zawiera skrypt MyConfiguration.ps1 oraz moduły, od których zależy.

Argument MyConfiguration wskazuje konkretną konfigurację DSC w ramach skryptu do wykonania. Parametr -ConfigurationArgument określa tabelę skrótu z argumentami przekazywanymi do funkcji konfiguracji.

Przykład 2. Konfigurowanie rozszerzenia DSC na maszynie wirtualnej przy użyciu ścieżki do danych konfiguracji

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

To polecenie konfiguruje rozszerzenie DSC na maszynie wirtualnej przy użyciu ścieżki do danych konfiguracji.

Parametry

-ConfigurationArchive

Określa nazwę pakietu konfiguracji (plik zip), który został wcześniej przekazany przez polecenie Publish-AzureVMDscConfiguration. Ten parametr musi określać tylko nazwę pliku bez żadnej ścieżki.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationArgument

Określa tabelę skrótu określającą argumenty funkcji konfiguracji. Klucze odpowiadają nazwam parametrów i wartościom wartości parametrów.

Dopuszczalne wartości tego parametru to:

  • typy pierwotne
  • ciąg
  • tablica
  • PsCredential
Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationDataPath

Określa ścieżkę pliku psd1, który określa dane funkcji konfiguracji. Ten plik musi zawierać tabelę skrótów zgodnie z opisem w temacie Oddzielanie konfiguracji i danych środowiskahttps://msdn.microsoft.com/en-us/PowerShell/DSC/configData.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationName

Określa nazwę skryptu konfiguracji lub modułu wywoływanego przez rozszerzenie DSC.

Wartość tego parametru musi być nazwą jednej z funkcji konfiguracji zawartych w skryptach lub modułach spakowanych w konfiguracjiArchive.

To polecenie cmdlet domyślnie określa nazwę pliku podanego przez parametr ConfigurationArchive , jeśli pominięto ten parametr, z wyłączeniem dowolnego rozszerzenia. Na przykład jeśli parametr ConfigurationArchive to "SalesWebSite.ps1.zip", wartością domyślną parametru ConfigurationName jest "SalesWebSite".

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContainerName

Określa nazwę kontenera usługi Azure Storage, w którym znajduje się configurationArchive .

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DataCollection

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Wskazuje, że to polecenie cmdlet zastępuje istniejące obiekty blob.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationAction

Określa, jak to polecenie cmdlet reaguje na zdarzenie informacyjne.

Dopuszczalne wartości tego parametru to:

  • Kontynuuj
  • Ignoruj
  • Zapytać
  • Silentlycontinue
  • Stop
  • Wstrzymanie
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Określa zmienną informacyjną.

Type:String
Aliases:iv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

Określa profil platformy Azure, z którego to polecenie cmdlet odczytuje. Jeśli nie określisz profilu, to polecenie cmdlet odczytuje z lokalnego profilu domyślnego.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReferenceName

Określa ciąg zdefiniowany przez użytkownika, który może służyć do odwoływania się do rozszerzenia. Ten parametr jest określony, gdy rozszerzenie jest dodawane do maszyny wirtualnej po raz pierwszy. W przypadku kolejnych aktualizacji należy określić wcześniej używaną nazwę odwołania podczas aktualizowania rozszerzenia. Nazwa ReferenceName przypisana do rozszerzenia jest zwracana przy użyciu polecenia cmdlet Get-AzureVM .

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageContext

Określa kontekst usługi Azure Storage, który zapewnia ustawienia zabezpieczeń używane do uzyskiwania dostępu do skryptu konfiguracji. Ten kontekst zapewnia dostęp do odczytu do kontenera określonego przez parametr ContainerName .

Type:AzureStorageContext
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageEndpointSuffix

Określa sufiks punktu końcowego DNS dla wszystkich usług magazynu, na przykład "core.contoso.net".

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Version

Określa określoną wersję rozszerzenia DSC do użycia. Wartość domyślna jest ustawiona na wartość "1.*", jeśli ten parametr nie jest określony.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VM

Określa trwały obiekt maszyny wirtualnej.

Type:IPersistentVM
Aliases:InputObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WmfVersion

Określa wersję programu Windows Management Framework (WMF) do zainstalowania na maszynie wirtualnej. Rozszerzenie DSC zależy od funkcji DSC, które są dostępne tylko w aktualizacjach WMF. Ten parametr określa wersję aktualizacji do zainstalowania na maszynie wirtualnej. Dopuszczalne wartości tego parametru to:

  • 4.0. Instaluje program WMF 4.0, chyba że jest już zainstalowana nowsza wersja.
  • 5.0. Instaluje najnowszą wersję programu WMF 5.0.
  • Najnowsza. Instaluje najnowszą wersję programu WMF, obecnie WMF 5.0.

Wartość domyślna to najnowsza.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False