Dela via

Set-AzureVMDscExtension

  • Referens
Modul:
Azure

Konfigurerar DSC-tillägget på en virtuell dator.

Kommentar

De cmdletar som refereras i den här dokumentationen är till för att hantera äldre Azure-resurser som använder Service Management-API:er. Se Az PowerShell-modulen för cmdletar för att hantera Azure Resource Manager-resurser.

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

Cmdleten Set-AzureVMDscExtension konfigurerar DSC-tillägget (Desired State Configuration) på en virtuell dator.

Exempel

Exempel 1: Konfigurera DSC-tillägget på en virtuell dator

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

Det här kommandot konfigurerar DSC-tillägget på en virtuell dator.

Paketet MyConfiguration.ps1.zip måste tidigare ha laddats upp till Azure Storage med kommandot Publish-AzureVMDscConfiguration och innehåller skriptet MyConfiguration.ps1 och de moduler som det är beroende av.

Argumentet MyConfiguration anger den specifika DSC-konfigurationen i skriptet som ska köras. Parametern -ConfigurationArgument anger en hashtable med argumenten som skickas till konfigurationsfunktionen.

Exempel 2: Konfigurera DSC-tillägget på en virtuell dator med hjälp av en sökväg till konfigurationsdata

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

Det här kommandot konfigurerar DSC-tillägget på en virtuell dator med hjälp av en sökväg till konfigurationsdata.

Parametrar

-ConfigurationArchive

Anger namnet på konfigurationspaketet (.zip-filen) som tidigare laddades upp av Publish-AzureVMDscConfiguration. Den här parametern måste bara ange namnet på filen, utan någon sökväg.

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

-ConfigurationArgument

Anger en hashtable som anger argumenten för konfigurationsfunktionen. Nycklarna motsvarar parameternamnen och värdena för parametervärdena.

De godtagbara värdena för den här parametern är:

  • primitiva typer
  • sträng
  • matris
  • PSCredential
Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationDataPath

Anger sökvägen till en .psd1-fil som anger data för konfigurationsfunktionen. Den här filen måste innehålla en hashtable enligt beskrivningen i Avgränsa konfigurations- och miljödatahttps://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

Anger namnet på konfigurationsskriptet eller modulen som anropas av DSC-tillägget.

Värdet för den här parametern måste vara namnet på någon av konfigurationsfunktionerna i skripten eller modulerna som paketeras i ConfigurationArchive.

Den här cmdleten är som standard namnet på filen som anges av parametern ConfigurationArchive om du utelämnar den här parametern, exklusive tillägg. Om ConfigurationArchive till exempel är "SalesWebSite.ps1.zip" är standardvärdet för ConfigurationName "SalesWebSite".

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

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-ContainerName

Anger namnet på Azure Storage-containern där ConfigurationArchive finns.

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

Anger att den här cmdleten skriver över befintliga blobar.

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

-InformationAction

Anger hur den här cmdleten svarar på en informationshändelse.

De godtagbara värdena för den här parametern är:

  • Fortsätt
  • Ignorera
  • Fråga
  • TystKontinuera
  • Stoppa
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Anger en informationsvariabel.

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

-Profile

Anger den Azure-profil som den här cmdleten läser från. Om du inte anger någon profil läser den här cmdleten från den lokala standardprofilen.

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

-ReferenceName

Anger en användardefinierad sträng som kan användas för att referera till ett tillägg. Den här parametern anges när tillägget läggs till i den virtuella datorn för första gången. För efterföljande uppdateringar bör du ange det tidigare använda referensnamnet när du uppdaterar tillägget. Referensnamnet som tilldelats ett tillägg returneras med cmdleten Get-AzureVM.

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

-StorageContext

Anger azure-lagringskontexten som tillhandahåller de säkerhetsinställningar som används för att komma åt konfigurationsskriptet. Den här kontexten ger läsbehörighet till containern som anges av parametern ContainerName .

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

-StorageEndpointSuffix

Anger DNS-slutpunktssuffixet för alla lagringstjänster, till exempel "core.contoso.net".

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

-Version

Anger den specifika version av DSC-tillägget som ska användas. Standardvärdet är inställt på "1.*" om den här parametern inte har angetts.

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

-VM

Anger objektet för den beständiga virtuella datorn.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

-WmfVersion

Anger vilken version av Windows Management Framework (WMF) som ska installeras på den virtuella datorn. DSC-tillägget beror på DSC-funktioner som endast är tillgängliga i WMF-uppdateringarna. Den här parametern anger vilken version av uppdateringen som ska installeras på den virtuella datorn. De godtagbara värdena för den här parametern är:

  • 4.0. Installerar WMF 4.0 om inte en nyare version redan är installerad.
  • 5.0. Installerar den senaste versionen av WMF 5.0.
  • Senaste. Installerar den senaste WMF, för närvarande WMF 5.0.

Standardvärdet är det senaste.

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