Set-AzVMCustomScriptExtension
Adiciona uma extensão de script personalizada a uma máquina virtual.
Sintaxe
ByNameWithContainerAndFileNamesParameterSet (Padrão)
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>]
Descrição
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"
Este comando adiciona um script personalizado à máquina virtual chamada VirtualMachine07.
O arquivo de script é contososcript.exe.
Exemplo 2
Adiciona uma extensão de script personalizada 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 dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
Tipo: SwitchParameter
Valor padrão: False Suporta curingas: False DontShow: False Pseudónimos: Cf.
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: False Valor dos argumentos restantes: False
-ContainerName
Especifica o nome do contêiner de armazenamento do Azure onde esse cmdlet armazena o script.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por 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 dos parâmetros
Tipo: IAzureContextContainer
Valor padrão: None Suporta curingas: False DontShow: False Pseudónimos: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por 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 dos parâmetros
Tipo: SwitchParameter
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por 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 Blob do Azure, o valor do nome do arquivo diferenciará maiúsculas de minúsculas. Os nomes de arquivo dos arquivos armazenados no Armazenamento de arquivos do Azure não diferenciam maiúsculas de minúsculas.
Propriedades dos parâmetros
Tipo: String [ ]
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-FileUri
Especifica o URI do arquivo de script.
Propriedades dos parâmetros
Tipo: String [ ]
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithFileUriParameterSet
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por 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 dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
Objeto de extensão VM.
ByInputObjectWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: True Valor do pipeline: True Valor do pipeline por nome da propriedade: False Valor dos argumentos restantes: False
ByInputObjectWithFileUriParameterSet
Posição: Named Obrigatório: True Valor do pipeline: True Valor do pipeline por nome da propriedade: False Valor dos argumentos restantes: False
-Location
Especifica o local da máquina virtual.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-Name
Especifica o nome da extensão de script personalizada.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False Pseudónimos: ExtensionName
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
ByNameWithFileUriParameterSet
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por 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 dos parâmetros
Tipo: SwitchParameter
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: False Valor dos argumentos restantes: False
-ResourceGroupName
Especifica o nome do grupo de recursos da máquina virtual.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: 0 Obrigatório: True Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
ByNameWithFileUriParameterSet
Posição: 0 Obrigatório: True Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-ResourceId
Extensão VM ResourceID.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByResourceIdWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
ByResourceIdWithFileUriParameterSet
Posição: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-Run
Especifica o comando a ser usado que executa o script.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False Pseudónimos: RunFile, Command
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-SecureExecution
Indica que esse cmdlet garante que o valor do parâmetro Run não seja registrado no servidor ou retornado ao usuário usando a API de extensão GET.
O valor de Run pode conter segredos ou senhas a serem passados para o arquivo de script com segurança.
Propriedades dos parâmetros
Tipo: SwitchParameter
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-StorageAccountKey
Especifica a chave para o contêiner de armazenamento do Azure.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-StorageAccountName
Especifica o nome da conta de armazenamento do Azure onde esse cmdlet armazena o script.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-StorageEndpointSuffix
Especifica o sufixo do ponto de extremidade de armazenamento.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por 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 dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False Pseudónimos: HandlerVersion, Versão
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-VMName
Especifica o nome de uma máquina virtual.
Este cmdlet adiciona a extensão de script personalizada para a máquina virtual especificada por esse parâmetro.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None Suporta curingas: False DontShow: False Pseudónimos: Nome do Recurso
Conjuntos de parâmetros
ByNameWithContainerAndFileNamesParameterSet
Posição: 1 Obrigatório: True Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
ByNameWithFileUriParameterSet
Posição: 1 Obrigatório: True Valor do pipeline: False Valor do pipeline por nome da propriedade: True Valor dos argumentos restantes: False
-VMObject
Objeto VM.
Propriedades dos parâmetros
Conjuntos de parâmetros
ByParentObjectWithContainerAndFileNamesParameterSet
Posição: Named Obrigatório: True Valor do pipeline: True Valor do pipeline por nome da propriedade: False Valor dos argumentos restantes: False
ByParentObjectWithFileUriParameterSet
Posição: Named Obrigatório: True Valor do pipeline: True Valor do pipeline por 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 dos parâmetros
Tipo: SwitchParameter
Valor padrão: False Suporta curingas: False DontShow: False Pseudónimos: Wi
Conjuntos de parâmetros
(All)
Posição: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por 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
