Compartilhar via


Set-AzVMCustomScriptExtension

Adiciona uma extensão de script personalizada a uma máquina virtual.

Sintaxe

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

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 personalizada a uma máquina virtual. (gerado automaticamente)

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.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ContainerName

Especifica o nome do contêiner de armazenamento do Azure em que esse cmdlet armazena o script.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DisableAutoUpgradeMinorVersion

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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 diferenciará 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.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-FileUri

Especifica o URI do arquivo de script.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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 nas configurações públicas ou protegidas ainda serão aplicadas pelo manipulador.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-InputObject

Objeto de extensão de VM.

Tipo:VirtualMachineCustomScriptExtensionContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Location

Especifica o local da máquina virtual.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Especifica o nome da extensão de script personalizado.

Tipo:String
Aliases:ExtensionName
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

Especifica o nome do grupo de recursos da máquina virtual.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ResourceId

ResourceID da extensão de VM.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Run

Especifica o comando a ser usado que executa o script.

Tipo:String
Aliases:RunFile, Command
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StorageAccountKey

Especifica a chave para o contêiner de armazenamento do Azure.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StorageAccountName

Especifica o nome da conta de armazenamento do Azure em que esse cmdlet armazena o script.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StorageEndpointSuffix

Especifica o sufixo do ponto de extremidade de armazenamento.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-TypeHandlerVersion

Especifica a versão da extensão a ser usada para esta 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 .

Tipo:String
Aliases:HandlerVersion, Version
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-VMName

Especifica o nome de uma máquina virtual. Esse cmdlet adiciona a extensão de script personalizado para a máquina virtual especificada por esse parâmetro.

Tipo:String
Aliases:ResourceName
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-VMObject

VM.

Tipo:PSVirtualMachine
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

String[]

SwitchParameter

Saídas

PSAzureOperationResponse