AzureFileCopy@2 – tarefa de cópia de arquivo v2 do Azure
Copie arquivos para Armazenamento de Blobs do Azure ou máquinas virtuais.
Observação
Essa tarefa não dá suporte à autenticação de Resource Manager do Azure com federação de identidade de fluxo de trabalho.
Sintaxe
# Azure file copy v2
# Copy files to Azure Blob Storage or virtual machines.
- task: AzureFileCopy@2
inputs:
SourcePath: # string. Required. Source.
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. Azure Subscription.
Destination: # 'AzureBlob' | 'AzureVMs'. Required. Destination Type.
#classicStorage: # string. Alias: StorageAccount. Required when ConnectedServiceNameSelector = ConnectedServiceName. Classic Storage Account.
storage: # string. Alias: StorageAccountRM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. RM Storage Account.
#ContainerName: # string. Required when Destination = AzureBlob. Container Name.
#BlobPrefix: # string. Optional. Use when Destination = AzureBlob. Blob Prefix.
#cloudService: # string. Alias: EnvironmentName. Required when ConnectedServiceNameSelector = ConnectedServiceName && Destination = AzureVMs. Cloud Service.
#resourceGroup: # string. Alias: EnvironmentNameRM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM && Destination = AzureVMs. Resource Group.
#ResourceFilteringMethod: 'machineNames' # 'machineNames' | 'tags'. Optional. Use when Destination = AzureVMs. Select Machines By. Default: machineNames.
#MachineNames: # string. Optional. Use when Destination = AzureVMs. Filter Criteria.
#vmsAdminUserName: # string. Required when Destination = AzureVMs. Admin Login.
#vmsAdminPassword: # string. Required when Destination = AzureVMs. Password.
#TargetPath: # string. Required when Destination = AzureVMs. Destination Folder.
#AdditionalArgumentsForBlobCopy: # string. Optional Arguments (for uploading files to blob).
#AdditionalArgumentsForVMCopy: # string. Optional. Use when Destination = AzureVMs. Optional Arguments (for downloading files to VM).
#enableCopyPrerequisites: false # boolean. Optional. Use when ConnectedServiceNameSelector = ConnectedServiceNameARM && Destination = AzureVMs. Enable Copy Prerequisites. Default: false.
#CopyFilesInParallel: true # boolean. Optional. Use when Destination = AzureVMs. Copy in Parallel. Default: true.
#CleanTargetBeforeCopy: false # boolean. Optional. Use when Destination = AzureVMs. Clean Target. Default: false.
#skipCACheck: true # boolean. Optional. Use when Destination = AzureVMs. Test Certificate. Default: true.
# Output
#outputStorageUri: # string. Storage Container URI.
#outputStorageContainerSasToken: # string. Storage Container SAS Token.
# Azure File Copy v2
# Copy files to Azure blob or VM(s).
- task: AzureFileCopy@2
inputs:
SourcePath: # string. Required. Source.
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. Azure Subscription.
Destination: # 'AzureBlob' | 'AzureVMs'. Required. Destination Type.
#classicStorage: # string. Alias: StorageAccount. Required when ConnectedServiceNameSelector = ConnectedServiceName. Classic Storage Account.
storage: # string. Alias: StorageAccountRM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. RM Storage Account.
#ContainerName: # string. Required when Destination = AzureBlob. Container Name.
#BlobPrefix: # string. Optional. Use when Destination = AzureBlob. Blob Prefix.
#cloudService: # string. Alias: EnvironmentName. Required when ConnectedServiceNameSelector = ConnectedServiceName && Destination = AzureVMs. Cloud Service.
#resourceGroup: # string. Alias: EnvironmentNameRM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM && Destination = AzureVMs. Resource Group.
#ResourceFilteringMethod: 'machineNames' # 'machineNames' | 'tags'. Optional. Use when Destination = AzureVMs. Select Machines By. Default: machineNames.
#MachineNames: # string. Optional. Use when Destination = AzureVMs. Filter Criteria.
#vmsAdminUserName: # string. Required when Destination = AzureVMs. Admin Login.
#vmsAdminPassword: # string. Required when Destination = AzureVMs. Password.
#TargetPath: # string. Required when Destination = AzureVMs. Destination Folder.
#AdditionalArgumentsForBlobCopy: # string. Optional Arguments (for uploading files to blob).
#AdditionalArgumentsForVMCopy: # string. Optional. Use when Destination = AzureVMs. Optional Arguments (for downloading files to VM).
#enableCopyPrerequisites: false # boolean. Optional. Use when ConnectedServiceNameSelector = ConnectedServiceNameARM && Destination = AzureVMs. Enable Copy Prerequisites. Default: false.
#CopyFilesInParallel: true # boolean. Optional. Use when Destination = AzureVMs. Copy in Parallel. Default: true.
#CleanTargetBeforeCopy: false # boolean. Optional. Use when Destination = AzureVMs. Clean Target. Default: false.
#skipCACheck: true # boolean. Optional. Use when Destination = AzureVMs. Test Certificate. Default: true.
# Output
#outputStorageUri: # string. Storage Container URI.
#outputStorageContainerSasToken: # string. Storage Container SAS Token.
Entradas
SourcePath
- Fonte
string
. Obrigatórios.
Especifique o caminho absoluto para a pasta de origem, o arquivo no computador local ou um compartilhamento UNC. O valor ou expressão especificado deve retornar um nome de pasta única ou um nome de arquivo.
azureConnectionType
- Tipo de conexão do Azure
Alias de entrada: ConnectedServiceNameSelector
. string
. Valores permitidos: ConnectedServiceName
(Azure Classic), ConnectedServiceNameARM
(Azure Resource Manager). Valor padrão: ConnectedServiceNameARM
.
Especifique o tipo de conexão do Azure.
azureClassicSubscription
- Assinatura Clássica do Azure
Alias de entrada: ConnectedServiceName
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceName
.
Especifique a assinatura clássica do Azure de destino.
azureSubscription
- Assinatura do Azure
Alias de entrada: ConnectedServiceNameARM
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceNameARM
.
Especifique a assinatura de Resource Manager do Azure de destino.
Destination
- Tipo de destino
string
. Obrigatórios. Valores permitidos: AzureBlob
(Blob do Azure), AzureVMs
(VMs do Azure).
Especifique o tipo de destino a ser usado para copiar os arquivos.
classicStorage
- Conta de armazenamento clássica
Alias de entrada: StorageAccount
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceName
.
Especifique uma conta de armazenamento clássica pré-existente. Essa é a conta de armazenamento usada como um intermediário para copiar arquivos para VMs do Azure.
storage
- Conta de Armazenamento RM
Alias de entrada: StorageAccountRM
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceNameARM
.
Especifique uma conta de armazenamento do ARM pré-existente. Essa é a conta de armazenamento usada como um intermediário para copiar arquivos para VMs do Azure.
ContainerName
- Nome do contêiner
string
. Obrigatório quando Destination = AzureBlob
.
Especifique o nome do contêiner no qual os arquivos são copiados. Se o contêiner especificado não existir na conta de armazenamento, ele será criado.
Para criar um diretório virtual dentro do contêiner, use a entrada de prefixo blob. Por exemplo, para o local de destino https://myaccount.blob.core.windows.net/mycontainer/vd1/vd2/
, especifique o nome mycontainer
do contêiner e o prefixo vd1/vd2
de Blob .
BlobPrefix
- Prefixo do blob
string
. Opcional. Use quando Destination = AzureBlob
.
Especifique um prefixo que pode ser usado para filtrar arquivos.
Exemplo: você pode acrescentar um número de build para filtrar os arquivos de todos os Blobs com o mesmo número de build.
Exemplo: se você especificar um prefixo myvd1
de Blob, um diretório virtual será criado dentro do contêiner. Os arquivos são copiados da origem para https://myaccount.blob.core.windows.net/mycontainer/myvd1/
.
cloudService
- Serviço de Nuvem
Alias de entrada: EnvironmentName
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceName && Destination = AzureVMs
.
Especifique o nome do Serviço de Nuvem de destino.
resourceGroup
- Grupo de Recursos
Alias de entrada: EnvironmentNameRM
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceNameARM && Destination = AzureVMs
.
Especifique o nome do Grupo de Recursos de destino.
ResourceFilteringMethod
- Selecionar computadores por
string
. Opcional. Use quando Destination = AzureVMs
. Valores permitidos: machineNames
(Nomes de Máquina), tags
. Valor padrão: machineNames
.
Especifique o nome ou a marca do host da VM que identifica um subconjunto de VMs em um grupo de recursos. As marcas têm suporte apenas para recursos criados por meio do Resource Manager do Azure.
MachineNames
- Critérios de Filtro
string
. Opcional. Use quando Destination = AzureVMs
.
Forneça uma lista de nomes de host de VM do Azure, como ffweb
, ffdb
ou marcas como Role:DB
, Web
, OS:Win8.1
.
Observação: delimitadores válidos para marcas incluem ,(vírgula), :(colon) e ;(semicolon). Ao fornecer várias marcas, a tarefa será executada em todas as VMs que contêm as marcas especificadas. Por padrão, a tarefa é executada em todas as VMs.
vmsAdminUserName
- Logon de administrador
string
. Obrigatório quando Destination = AzureVMs
.
Forneça o nome de usuário da conta de administrador da VM do Azure.
vmsAdminPassword
- Senha
string
. Obrigatório quando Destination = AzureVMs
.
Forneça a senha para a conta de administrador da VM do Azure.
A entrada válida inclui variáveis definidas em pipelines de build ou de lançamento, como $(passwordVariable)
. Para proteger uma senha, marque-a como secret
.
TargetPath
- Pasta de Destino
string
. Obrigatório quando Destination = AzureVMs
.
Especifique o caminho local nas VMs de destino.
A entrada válida inclui variáveis de ambiente, como $env:windir\BudgetIT\Web
.
AdditionalArgumentsForBlobCopy
- Argumentos opcionais (para carregar arquivos para o blob)
string
.
Forneça argumentos adicionais para AzCopy.exe
que podem ser aplicados ao carregar em Blobs, como /NC:10
.
Se nenhum argumento opcional for especificado, os argumentos a seguir serão adicionados por padrão.
/Y
/SetContentType
/Z
/V
/S
– Adicionado quando o nome do contêiner não$root
é ./BlobType:page
– Adicionado quando a conta de armazenamento especificada é uma conta premium./Pattern
– Adicionado quando o caminho de origem é um arquivo. Incluído com quaisquer outros argumentos opcionais especificados.
AdditionalArgumentsForVMCopy
- Argumentos opcionais (para baixar arquivos para a VM)
string
. Opcional. Use quando Destination = AzureVMs
.
Forneça argumentos adicionais para AzCopy.exe
que podem ser aplicados ao baixar para VMs como /NC:10
.
Se nenhum argumento opcional for especificado, os seguintes serão adicionados por padrão.
/Y
/S
/Z
/V
enableCopyPrerequisites
- Habilitar pré-requisitos de cópia
boolean
. Opcional. Use quando ConnectedServiceNameSelector = ConnectedServiceNameARM && Destination = AzureVMs
. Valor padrão: false
.
Quando habilitado, usa um certificado autoassinado para configurar um ouvinte do WinRM (Gerenciamento Remoto do Windows) na porta 5986 em vez do protocolo HTTPS. Necessário para executar operações de cópia em VMs do Azure. Se as VMs de destino usarem um balanceador de carga, configure as regras NAT de entrada para a porta de destino (5986). Aplica-se somente a VMs arm.
CopyFilesInParallel
- Copiar em paralelo
boolean
. Opcional. Use quando Destination = AzureVMs
. Valor padrão: true
.
Aceitar a configuração padrão copia arquivos em paralelo para as VMs de destino.
CleanTargetBeforeCopy
- Limpar destino
boolean
. Opcional. Use quando Destination = AzureVMs
. Valor padrão: false
.
Definir esse valor como true
limpa a pasta de destino antes de executar a ação de cópia.
skipCACheck
- Testar certificado
boolean
. Opcional. Use quando Destination = AzureVMs
. Valor padrão: true
.
O valor padrão não validará se o certificado do servidor foi assinado por uma AC confiável antes de se conectar por HTTPS.
outputStorageUri
- URI do Contêiner de Armazenamento
string
.
Especifique o nome da variável usada para o URI do contêiner de armazenamento para o qual os arquivos foram copiados. Válido somente quando o destino selecionado é um Blob do Azure.
outputStorageContainerSasToken
- Token SAS do contêiner de armazenamento
string
.
Especifique o nome da variável usada para o token SAS do contêiner de armazenamento que acessa os arquivos que foram copiados. Válido somente quando o destino selecionado é um Blob do Azure.
Opções de controle da tarefa
Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.
Variáveis de saída
Nenhum.
Comentários
Novidades na versão 2.0: usando a versão mais recente do AzCopy.
Requisitos
Requisito | Descrição |
---|---|
Tipos de pipeline | YAML, build clássico, versão clássica |
Executa em | Agent, DeploymentGroup |
Demandas | Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas para executar trabalhos que usam essa tarefa: azureps |
Funcionalidades | Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho. |
Restrições de comando | Qualquer |
Variáveis configuráveis | Qualquer |
Versão do agente | 1.103.0 ou superior |
Categoria da tarefa | Implantar |