Partager via

Set-AzureRmVMDscExtension

  • Référence
Module:
AzureRM.Compute

Configure l’extension DSC sur une machine virtuelle.

Avertissement

Le module AzureRM PowerShell a été officiellement déconseillé depuis le 29 février 2024. Les utilisateurs sont invités à migrer d’AzureRM vers le module Az PowerShell afin de s’assurer d’une prise en charge et des mises à jour continues.

Bien que le module AzureRM puisse toujours fonctionner, il n’est plus conservé ou pris en charge, plaçant toute utilisation continue à la discrétion et au risque de l’utilisateur. Consultez nos ressources sur la migration pour obtenir des conseils sur la transition vers le module Az.

Syntaxe

Set-AzureRmVMDscExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-ArchiveBlobName] <String>
   [-ArchiveStorageAccountName] <String>
   [-ArchiveResourceGroupName <String>]
   [-ArchiveStorageEndpointSuffix <String>]
   [-ArchiveContainerName <String>]
   [-ConfigurationName <String>]
   [-ConfigurationArgument <Hashtable>]
   [-ConfigurationData <String>]
   [-Version] <String>
   [-Force]
   [-Location <String>]
   [-AutoUpdate]
   [-WmfVersion <String>]
   [-DataCollection <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande Set-AzureRmVMDscExtension configure l’extension DSC (Desired State Configuration) Windows PowerShell sur une machine virtuelle dans un groupe de ressources.

Exemples

Exemple 1 : Définir une extension DSC

PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US"

Cette commande définit l’extension DSC sur la machine virtuelle nommée VM07 pour télécharger Sample.ps1.zip à partir du compte de stockage nommé Stg et du conteneur par défaut. La commande appelle la configuration nommée ConfigName. Le fichier Sample.ps1.zip a été précédemment chargé à l’aide de Publish-AzureRmVMDscConfiguration.

Exemple 2 : Définir une extension DSC avec des données de configuration

PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US"

Cette commande définit l’extension sur la machine virtuelle nommée VM13 pour télécharger Sample.ps1.zip à partir du compte de stockage nommé Stg et du conteneur nommé WindowsPowerShellDSC. Commande de la configuration nommée ConfigName et spécifie les données et arguments de configuration. Le fichier Sample.ps1.zip a été précédemment chargé à l’aide de Publish-AzureRmVMDscConfiguration.

Exemple 3 : Définir une extension DSC avec des données de configuration qui ont une mise à jour automatique

PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate

Cette commande définit l’extension sur la machine virtuelle nommée VM22 pour télécharger Sample.ps1.zip à partir du compte de stockage nommé Stg et du conteneur nommé WindowsPowerShellDSC. La commande appelle la configuration nommée ConfigName et spécifie les données de configuration et les arguments. Cette commande active également la mise à jour automatique du gestionnaire d’extensions vers la dernière version. Le Sample.ps1.zip a été précédemment chargé à l’aide de Publish-AzureRmVMDscConfiguration.

Paramètres

-ArchiveBlobName

Spécifie le nom du fichier de configuration précédemment chargé par l’applet de commande Publish-AzureRmVMDscConfiguration.

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

-ArchiveContainerName

Nom d’espèce du conteneur de stockage Azure où se trouve l’archive de configuration.

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

-ArchiveResourceGroupName

Spécifie le nom du groupe de ressources qui contient le compte de stockage qui contient l’archive de configuration. Ce paramètre est facultatif si le compte de stockage et la machine virtuelle se trouvent tous les deux dans le même groupe de ressources.

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

-ArchiveStorageAccountName

Spécifie le nom du compte de stockage Azure utilisé pour télécharger ArchiveBlobName.

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

-ArchiveStorageEndpointSuffix

Spécifie le suffixe de point de terminaison de stockage.

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

-AutoUpdate

Spécifie la version du gestionnaire d’extensions spécifiée par le paramètre Version . Par défaut, le gestionnaire d’extensions n’est pas mis à jour automatiquement. Utilisez le paramètre AutoUpdate pour activer la mise à jour automatique du gestionnaire d’extensions vers la dernière version en tant que et quand elle est disponible.

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

-ConfigurationArgument

Spécifie une table de hachage qui contient les arguments de la fonction de configuration.

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

-ConfigurationData

Spécifie le chemin d’accès d’un fichier .psd1 qui spécifie les données de la configuration.

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 de la configuration appelée par l’extension DSC.

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 l’applet de commande.

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

-DataCollection

Spécifie le type de collecte de données. Les valeurs acceptables pour ce paramètre sont les suivantes : Activer et désactiver.

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

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

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

-Force

Force l’exécution de la commande sans demander la confirmation de l’utilisateur.

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

-Location

Spécifie le chemin d’accès de l’extension de ressource.

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

-Name

Spécifie le nom de la ressource Azure Resource Manager qui représente l’extension. La valeur par défaut est Microsoft.Powershell.DSC.

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

-ResourceGroupName

Spécifie le nom du groupe de ressources de la machine virtuelle.

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

-Version

Spécifie la version de l’extension DSC à laquelle Set-AzureRmVMDscExtension applique les paramètres.

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

-VMName

Spécifie le nom de la machine virtuelle où le gestionnaire d’extensions DSC est installé.

Type:String
Position:3
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 WMF.

Type:String
Valeurs acceptées:4.0, 5.0, 5.1, latest
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

String

Hashtable

Sorties

PSAzureOperationResponse