Set-AzVMCustomScriptExtension
Adiciona uma extensão de script personalizado a uma máquina virtual.
Sintaxe
ByNameWithContainerAndFileNamesParameterSet (Default)
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
O cmdlet Set-AzVMCustomScriptExtension adiciona uma extensão de máquina virtual de script personalizado a uma máquina virtual.
Essa extensão permite que você execute seus próprios scripts na máquina virtual.
Exemplos
Exemplo 1: Adicionar um script personalizado
Set-AzVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts"
Esse comando adiciona um script personalizado à máquina virtual chamada VirtualMachine07.
O arquivo de script é contososcript.exe.
Exemplo 2
Adiciona uma extensão de script personalizado a uma máquina virtual. (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'
Parâmetros
-Argument
Especifica os argumentos que a extensão de script passa para o script.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False Dá suporte a curingas: False DontShow: False Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-ContainerName
Especifica o nome do contêiner de armazenamento do Azure em que esse cmdlet armazena o script.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.
Propriedades do parâmetro
Tipo: IAzureContextContainer
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-DisableAutoUpgradeMinorVersion
O cmdlet Set-AzVMCustomScriptExtension adiciona uma extensão de máquina virtual de script personalizado a uma máquina virtual.
Essa extensão permite que você execute seus próprios scripts na máquina virtual.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-FileName
Especifica o nome do arquivo de script. Se o arquivo estiver armazenado no Armazenamento de Blobs do Azure, o valor do nome do arquivo diferencia maiúsculas de minúsculas. Os nomes de arquivo de arquivos armazenados no Armazenamento de Arquivos do Azure não diferenciam maiúsculas de minúsculas.
Propriedades do parâmetro
Tipo: String [ ]
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-FileUri
Especifica o URI do arquivo de script.
Propriedades do parâmetro
Tipo: String [ ]
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithFileUriParameterSet
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-ForceRerun
Indica que esse cmdlet força uma nova execução da mesma configuração de extensão na máquina virtual sem desinstalar e reinstalar a extensão.
O valor pode ser qualquer cadeia de caracteres diferente do valor atual.
Se forceUpdateTag não for alterado, as atualizações para configurações públicas ou protegidas ainda serão aplicadas pelo manipulador.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
Objeto de extensão de VM.
ByInputObjectWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: True Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
ByInputObjectWithFileUriParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: True Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Location
Especifica o local da máquina virtual.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Name
Especifica o nome da extensão de script personalizado.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: ExtensionName
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
ByNameWithFileUriParameterSet
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-NoWait
Inicia a operação e retorna imediatamente, antes que a operação seja concluída. Para determinar se a operação foi concluída com êxito, use algum outro mecanismo.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-ResourceGroupName
Especifica o nome do grupo de recursos da máquina virtual.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: 0 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
ByNameWithFileUriParameterSet
Cargo: 0 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-ResourceId
ResourceID da extensão de VM.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByResourceIdWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
ByResourceIdWithFileUriParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Run
Especifica o comando a ser usado que executa o script.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: RunFile, Command
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-SecureExecution
Indica que esse cmdlet garante que o valor do parâmetro Executar não esteja registrado no servidor ou retornado ao usuário usando a API de extensão GET.
O valor de Executar pode conter segredos ou senhas a serem passadas para o arquivo de script com segurança.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-StorageAccountKey
Especifica a chave para o contêiner de armazenamento do Azure.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-StorageAccountName
Especifica o nome da conta de armazenamento do Azure em que esse cmdlet armazena o script.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-StorageEndpointSuffix
Especifica o sufixo do ponto de extremidade de armazenamento.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-TypeHandlerVersion
Especifica a versão da extensão a ser usada para essa máquina virtual.
Para obter a versão, execute o cmdlet Get-AzVMExtensionImage com um valor de Microsoft.Compute para o parâmetro PublisherName e CustomScriptExtension para o parâmetro Type .
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: HandlerVersion, Versão
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-VMName
Especifica o nome de uma máquina virtual.
Esse cmdlet adiciona a extensão de script personalizada para a máquina virtual especificada por esse parâmetro.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: NomeDoRecurso
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Cargo: 1 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
ByNameWithFileUriParameterSet
Cargo: 1 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-VMObject
Objeto VM.
Propriedades do parâmetro
Tipo: PSVirtualMachine
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
ByParentObjectWithContainerAndFileNamesParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: True Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
ByParentObjectWithFileUriParameterSet
Cargo: Named Obrigatório: True Valor do pipeline: True Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False Dá suporte a curingas: False DontShow: False Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas
