Partager via


Set-AzureVMBGInfoExtension

Définit l’extension BGInfo pour 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-AzureVMBGInfoExtension
   [-Disable]
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Set-AzureVMBGInfoExtension
   [-Uninstall]
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

L’applet de commande Set-AzureVMBGInfoExtension définit l’extension BGInfo pour une machine virtuelle.

Exemples

Exemple 1 : Définir l’extension BGInfo pour une machine virtuelle

PS C:\> Set-AzureVMBGInfoExtension -VM $VM

Cette commande définit l’extension BGInfo pour la machine virtuelle spécifiée comme stockée dans la variable $VM.

Paramètres

-Disable

Indique que cette applet de commande désactive l’état de l’extension.

Type:SwitchParameter
Position:1
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
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 le nom de référence de l’extension BGInfo.

Ce paramètre est une chaîne définie par l’utilisateur qui peut être utilisée pour faire référence à une extension. Elle est spécifiée lorsque l’extension est ajoutée à la machine virtuelle pour la première fois. Vous pouvez spécifier le nom de référence précédemment utilisé lors de la mise à jour de l’extension.

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

-Uninstall

Indique que cette applet de commande désinstalle l’extension BGInfo.

Type:SwitchParameter
Position:1
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 de l’extension BGInfo.

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