Set-AzVMCustomScriptExtension
Ajoute une extension de script personnalisé à une machine virtuelle.
Syntaxe
ByNameWithContainerAndFileNamesParameterSet (Par défaut)
Set-AzVMCustomScriptExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-ContainerName <String>
-FileName <String[]>
[-Name <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>]
ByNameWithFileUriParameterSet
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>]
ByParentObjectWithContainerAndFileNamesParameterSet
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>]
ByParentObjectWithFileUriParameterSet
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>]
ByResourceIdWithContainerAndFileNamesParameterSet
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>]
ByResourceIdWithFileUriParameterSet
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. (autogenerated)
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.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: cf
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ContainerName
Spécifie le nom du conteneur de stockage Azure dans lequel cette applet de commande stocke le script.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Propriétés du paramètre
Type: IAzureContextContainer
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-DisableAutoUpgradeMinorVersion
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.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: 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.
Propriétés du paramètre
Type: String [ ]
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-FileUri
Spécifie l’URI du fichier de script.
Propriétés du paramètre
Type: String [ ]
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameWithFileUriParameterSet
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: 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.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
Objet d’extension de machine virtuelle.
ByInputObjectWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
ByInputObjectWithFileUriParameterSet
Position: Named Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Location
Spécifie l’emplacement de la machine virtuelle.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Name
Spécifie le nom de l’extension de script personnalisé.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: ExtensionName
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
ByNameWithFileUriParameterSet
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: 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.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ResourceGroupName
Spécifie le nom du groupe de ressources de la machine virtuelle.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
ByNameWithFileUriParameterSet
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-ResourceId
ResourceID de l’extension de machine virtuelle.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByResourceIdWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
ByResourceIdWithFileUriParameterSet
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Run
Spécifie la commande à utiliser qui exécute votre script.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: RunFile, Command
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: 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é.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-StorageAccountKey
Spécifie la clé du conteneur de stockage Azure.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-StorageAccountName
Spécifie le nom du compte de stockage Azure dans lequel cette applet de commande stocke le script.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-StorageEndpointSuffix
Spécifie le suffixe de point de terminaison de stockage.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: 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 la valeur Microsoft.Compute pour le paramètre PublisherName et CustomScriptExtension pour le paramètre Type .
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: HandlerVersion, Version
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-VMName
Spécifie le nom d’une machine virtuelle.
Cette applet de commande ajoute l’extension de script personnalisé pour la machine virtuelle spécifiée par ce paramètre.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: ResourceName
Jeux de paramètres
ByNameWithContainerAndFileNamesParameterSet
Position: 1 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
ByNameWithFileUriParameterSet
Position: 1 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-VMObject
Objet de machine virtuelle.
Propriétés du paramètre
Type: PSVirtualMachine
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByParentObjectWithContainerAndFileNamesParameterSet
Position: Named Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
ByParentObjectWithFileUriParameterSet
Position: Named Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute.
L’applet de commande ne s’exécute pas.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: Wi
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters .
Sorties
