Delen via

Set-AzureVMDscExtension

  • Referentie
Module:
Azure

Hiermee configureert u de DSC-extensie op een virtuele machine.

Notitie

De cmdlets waarnaar in deze documentatie wordt verwezen, zijn bedoeld voor het beheren van verouderde Azure-resources die gebruikmaken van Service Management-API's. Zie de Az PowerShell-module voor cmdlets voor het beheren van Azure Resource Manager-resources.

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

De cmdlet Set-AzureVMDscExtension configureert de DSC-extensie (Desired State Configuration) op een virtuele machine.

Voorbeelden

Voorbeeld 1: De DSC-extensie configureren op een virtuele machine

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

Met deze opdracht configureert u de DSC-extensie op een virtuele machine.

Het myConfiguration.ps1.zip-pakket moet eerder zijn geüpload naar Azure Storage met behulp van de opdracht Publish-AzureVMDscConfiguration en bevat het script MyConfiguration.ps1 en de modules die ervan afhankelijk zijn.

Het argument MyConfiguration geeft de specifieke DSC-configuratie in het script aan die moet worden uitgevoerd. De parameter -ConfigurationArgument geeft een hashtabel op met de argumenten die worden doorgegeven aan de configuratiefunctie.

Voorbeeld 2: De DSC-extensie op een virtuele machine configureren met behulp van een pad naar de configuratiegegevens

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

Met deze opdracht configureert u de DSC-extensie op een virtuele machine met behulp van een pad naar de configuratiegegevens.

Parameters

-ConfigurationArchive

Hiermee geeft u de naam op van het configuratiepakket (.zip-bestand) dat eerder is geüpload door Publish-AzureVMDscConfiguration. Deze parameter moet alleen de naam van het bestand opgeven, zonder pad.

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

-ConfigurationArgument

Hiermee geeft u een hashtabel die de argumenten voor de configuratiefunctie opgeeft. De sleutels komen overeen met de parameternamen en de waarden voor de parameterwaarden.

De acceptabele waarden voor deze parameter zijn:

  • primitieve typen
  • string
  • matrix
  • PSCredential
Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationDataPath

Hiermee geeft u het pad van een .psd1-bestand dat de gegevens voor de configuratiefunctie opgeeft. Dit bestand moet een hashtabel bevatten, zoals beschreven in configuratie- en omgevingsgegevens scheidenhttps://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

Hiermee geeft u de naam van het configuratiescript of de module die wordt aangeroepen door de DSC-extensie.

De waarde van deze parameter moet de naam zijn van een van de configuratiefuncties in de scripts of modules die zijn verpakt in ConfigurationArchive.

Deze cmdlet is standaard ingesteld op de naam van het bestand dat is opgegeven door de parameter ConfigurationArchive als u deze parameter weglaat, met uitzondering van een extensie. Als ConfigurationArchive bijvoorbeeld SalesWebSite.ps1.zip is, is de standaardwaarde voor ConfigurationName 'SalesWebSite'.

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

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-ContainerName

Hiermee geeft u de naam van de Azure-opslagcontainer waar de ConfigurationArchive zich bevindt.

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

Geeft aan dat met deze cmdlet bestaande blobs worden overschreven.

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

-InformationAction

Hiermee geeft u op hoe deze cmdlet reageert op een informatie-gebeurtenis.

De acceptabele waarden voor deze parameter zijn:

  • Doorgaan
  • Negeren
  • Informeren
  • SilentlyContinue
  • Stoppen
  • Onderbreken
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Hiermee geeft u een informatievariabele op.

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

-Profile

Hiermee geeft u het Azure-profiel op waaruit deze cmdlet wordt gelezen. Als u geen profiel opgeeft, leest deze cmdlet uit het lokale standaardprofiel.

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

-ReferenceName

Hiermee geeft u een door de gebruiker gedefinieerde tekenreeks op die kan worden gebruikt om naar een extensie te verwijzen. Deze parameter wordt opgegeven wanneer de extensie voor het eerst wordt toegevoegd aan de virtuele machine. Voor volgende updates moet u de eerder gebruikte referentienaam opgeven tijdens het bijwerken van de extensie. De ReferenceName die is toegewezen aan een extensie, wordt geretourneerd met behulp van de Get-AzureVM-cmdlet .

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

-StorageContext

Hiermee geeft u de Azure-opslagcontext op die de beveiligingsinstellingen biedt die worden gebruikt voor toegang tot het configuratiescript. Deze context biedt leestoegang tot de container die is opgegeven door de parameter ContainerName .

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

-StorageEndpointSuffix

Hiermee geeft u het achtervoegsel van het DNS-eindpunt op voor alle opslagservices, bijvoorbeeld 'core.contoso.net'.

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

-Version

Hiermee geeft u de specifieke versie van de DSC-extensie te gebruiken. De standaardwaarde is ingesteld op '1.*' als deze parameter niet is opgegeven.

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

-VM

Hiermee geeft u het permanente virtuele-machineobject.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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

-WmfVersion

Hiermee geeft u de versie van het Windows Management Framework (WMF) op die op de virtuele machine moet worden geïnstalleerd. De DSC-extensie is afhankelijk van DSC-functies die alleen beschikbaar zijn in de WMF-updates. Met deze parameter geeft u op welke versie van de update moet worden geïnstalleerd op de virtuele machine. De acceptabele waarden voor deze parameter zijn:

  • 4.0. Hiermee wordt WMF 4.0 geïnstalleerd, tenzij er al een nieuwere versie is geïnstalleerd.
  • 5.0. Installeert de nieuwste versie van WMF 5.0.
  • Laatste. Installeert de nieuwste WMF, momenteel WMF 5.0.

De standaardwaarde is de meest recente.

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