Set-AzVMCustomScriptExtension

Ajoute une extension de script personnalisé à une machine virtuelle.

Syntax

Set-AzVMCustomScriptExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -Name <String>
   -VMObject <PSVirtualMachine>
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -Name <String>
   -VMObject <PSVirtualMachine>
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -ResourceId <String>
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -ResourceId <String>
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -InputObject <VirtualMachineCustomScriptExtensionContext>
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -InputObject <VirtualMachineCustomScriptExtensionContext>
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande Set-AzVMCustomScriptExtension ajoute une extension de machine virtuelle de script personnalisé à une machine virtuelle. Cette extension vous permet d’exécuter vos propres scripts sur la machine virtuelle.

Exemples

Exemple 1 : Ajouter un script personnalisé

Set-AzVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts"

Cette commande ajoute un script personnalisé à la machine virtuelle nommée VirtualMachine07. Le fichier de script est contososcript.exe.

Exemple 2

Ajoute une extension de script personnalisé à une machine virtuelle. (généré automatiquement)

Set-AzVMCustomScriptExtension -Argument <String> -ContainerName 'Scripts' -DefaultProfile <IAzureContextContainer> -FileName 'ContosoScript.exe' -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -Run 'myScript.ps1' -SecureExecution -StorageAccountKey <String> -StorageAccountName 'Contoso' -TypeHandlerVersion '1.1' -VMName 'VirtualMachine07'

Paramètres

-Argument

Spécifie les arguments que l’extension de script passe au script.

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

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-ContainerName

Spécifie le nom du conteneur de stockage Azure dans lequel cette applet de commande stocke le script.

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableAutoUpgradeMinorVersion

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

-FileName

Spécifie le nom du fichier de script. Si le fichier est stocké dans le stockage Blob Azure, la valeur du nom de fichier respecte la casse. Les noms de fichiers stockés dans le stockage de fichiers Azure ne respectent pas la casse.

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

-FileUri

Spécifie l’URI du fichier de script.

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

-ForceRerun

Indique que cette applet de commande force une réexécution de la même configuration d’extension sur la machine virtuelle sans désinstaller et réinstaller l’extension. La valeur peut être n’importe quelle chaîne différente de la valeur actuelle. Si forceUpdateTag n’est pas modifié, les mises à jour apportées aux paramètres publics ou protégés sont toujours appliquées par le gestionnaire.

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

-InputObject

Objet d’extension de machine virtuelle.

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

-Location

Spécifie l’emplacement de la machine virtuelle.

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

-Name

Spécifie le nom de l’extension de script personnalisé.

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

-NoWait

Démarre l’opération et retourne immédiatement, avant la fin de l’opération. Pour déterminer si l’opération a bien été effectuée, utilisez un autre mécanisme.

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

-ResourceGroupName

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

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

-ResourceId

ResourceID de l’extension de machine virtuelle.

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

-Run

Spécifie la commande à utiliser qui exécute votre script.

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

-SecureExecution

Indique que cette applet de commande garantit que la valeur du paramètre Run n’est pas enregistrée sur le serveur ou retournée à l’utilisateur à l’aide de l’API d’extension GET. La valeur d’exécution peut contenir des secrets ou des mots de passe à transmettre au fichier de script en toute sécurité.

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

-StorageAccountKey

Spécifie la clé du conteneur de stockage Azure.

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

-StorageAccountName

Spécifie le nom du compte de stockage Azure dans lequel cette applet de commande stocke le script.

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

-StorageEndpointSuffix

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

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

-TypeHandlerVersion

Spécifie la version de l’extension à utiliser pour cette machine virtuelle. Pour obtenir la version, exécutez l’applet de commande Get-AzVMExtensionImage avec une valeur de Microsoft.Compute pour le paramètre PublisherName et CustomScriptExtension pour le paramètre Type .

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

-VMName

Spécifie le nom d'un ordinateur virtuel. Cette applet de commande ajoute l’extension de script personnalisé pour la machine virtuelle spécifiée par ce paramètre.

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

-VMObject

Objet de machine virtuelle.

Type:PSVirtualMachine
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

String

String[]

SwitchParameter

Sorties

PSAzureOperationResponse