Partager via

Set-AzureVMDscExtension

  • Référence
Module:
Azure

Configure l’extension DSC sur une machine virtuelle.

Remarque

Les cmdlets mentionnées dans cette documentation servent à gérer les ressources Azure héritées qui utilisent les API Azure Service Manager (ASM). Ce module PowerShell hérité n’est pas recommandé lors de la création de ressources, car ASM est planifié pour la mise hors service. Pour plus d’informations, consultez la mise hors service d’Azure Service Manager.

Le module Az PowerShell est le module PowerShell recommandé pour la gestion des ressources Azure Resource Manager (ARM) avec PowerShell.

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

L’applet de commande Set-AzureVMDscExtension configure l’extension DSC (Desired State Configuration) sur une machine virtuelle.

Exemples

Exemple 1 : Configurer l’extension DSC sur une machine virtuelle

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

Cette commande configure l’extension DSC sur une machine virtuelle.

Le package MyConfiguration.ps1.zip doit avoir été précédemment chargé dans le stockage Azure à l’aide de la commande Publish-AzureVMDscConfiguration et inclut le script MyConfiguration.ps1 et les modules dont il dépend.

L’argument MyConfiguration indique la configuration DSC spécifique dans le script à exécuter. Le paramètre -ConfigurationArgument spécifie une table de hachage avec les arguments passés à la fonction de configuration.

Exemple 2 : Configurer l’extension DSC sur une machine virtuelle à l’aide d’un chemin d’accès aux données de configuration

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

Cette commande configure l’extension DSC sur une machine virtuelle à l’aide d’un chemin d’accès aux données de configuration.

Paramètres

-ConfigurationArchive

Spécifie le nom du package de configuration (fichier .zip) précédemment chargé par Publish-AzureVMDscConfiguration. Ce paramètre doit spécifier uniquement le nom du fichier, sans chemin d’accès.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ConfigurationArgument

Spécifie une table de hachage spécifiant les arguments de la fonction de configuration. Les clés correspondent aux noms des paramètres et aux valeurs des paramètres.

Les valeurs valides pour ce paramètre sont :

  • types primitifs
  • string
  • tableau
  • PSCredential
Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ConfigurationDataPath

Spécifie le chemin d’accès d’un fichier .psd1 qui spécifie les données de la fonction de configuration. Ce fichier doit contenir une table de hachage, comme décrit dans La séparation des données de configuration et d’environnementhttps://msdn.microsoft.com/en-us/PowerShell/DSC/configData.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ConfigurationName

Spécifie le nom du script de configuration ou du module appelé par l’extension DSC.

La valeur de ce paramètre doit être le nom de l’une des fonctions de configuration contenues dans les scripts ou modules empaquetés dans ConfigurationArchive.

Cette applet de commande prend par défaut le nom du fichier donné par le paramètre ConfigurationArchive si vous omettez ce paramètre, à l’exclusion de toute extension. Par exemple, si ConfigurationArchive est « SalesWebSite.ps1.zip », la valeur par défaut de ConfigurationName est « SalesWebSite ».

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter la commande cmdlet.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ContainerName

Spécifie le nom du conteneur de stockage Azure où se trouve ConfigurationArchive .

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DataCollection

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Force

Indique que cette applet de commande remplace les objets blob existants.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InformationAction

Spécifie la façon dont cette applet de commande répond à un événement d’information.

Les valeurs valides pour ce paramètre sont :

  • Continuer
  • Ignorer
  • Demander
  • SilentlyContinue
  • Stop
  • Suspendre
Type:ActionPreference
Alias:infa
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InformationVariable

Spécifie une variable d’informations.

Type:String
Alias:iv
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Profile

Spécifie le profil Azure à partir duquel cette applet de commande lit. Si vous ne spécifiez pas de profil, cette applet de commande lit le profil par défaut local.

Type:AzureSMProfile
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ReferenceName

Spécifie une chaîne définie par l’utilisateur qui peut être utilisée pour faire référence à une extension. Ce paramètre est spécifié lorsque l’extension est ajoutée à la machine virtuelle pour la première fois. Pour les mises à jour suivantes, vous devez spécifier le nom de référence précédemment utilisé lors de la mise à jour de l’extension. Le ReferenceName affecté à une extension est retourné à l’aide de l’applet de commande Get-AzureVM .

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-StorageContext

Spécifie le contexte de stockage Azure qui fournit les paramètres de sécurité utilisés pour accéder au script de configuration. Ce contexte fournit un accès en lecture au conteneur spécifié par le paramètre ContainerName .

Type:AzureStorageContext
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-StorageEndpointSuffix

Spécifie le suffixe de point de terminaison DNS pour tous les services de stockage, par exemple « core.contoso.net ».

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Version

Spécifie la version spécifique de l’extension DSC à utiliser. La valeur par défaut est définie sur « 1.* » si ce paramètre n’est pas spécifié.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-VM

Spécifie l’objet de machine virtuelle persistante.

Type:IPersistentVM
Alias:InputObject
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WmfVersion

Spécifie la version du Windows Management Framework (WMF) à installer sur la machine virtuelle. L’extension DSC dépend des fonctionnalités DSC disponibles uniquement dans les mises à jour WMF. Ce paramètre spécifie la version de la mise à jour à installer sur la machine virtuelle. Les valeurs valides pour ce paramètre sont :

  • 4.0. Installe WMF 4.0, sauf si une version plus récente est déjà installée.
  • 5.0. Installe la dernière version de WMF 5.0.
  • dernier. Installe la dernière version de WMF, actuellement WMF 5.0.

La valeur par défaut est latest.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False