AzureFileCopy@3 — zadanie kopiowania plików platformy Azure w wersji 3

Artykuł
07/02/2024

Skopiuj pliki do Azure Blob Storage lub maszyn wirtualnych.

Uwaga

To zadanie nie obsługuje uwierzytelniania usługi Azure Resource Manager za pomocą federacji tożsamości przepływu pracy.

Składnia

# Azure file copy v3
# Copy files to Azure Blob Storage or virtual machines.
- task: AzureFileCopy@3
  inputs:
    SourcePath: # string. Required. Source. 
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription. 
    Destination: # 'AzureBlob' | 'AzureVMs'. Required. Destination Type. 
    storage: # string. Alias: StorageAccountRM. Required. RM Storage Account. 
    #ContainerName: # string. Required when Destination = AzureBlob. Container Name. 
    #BlobPrefix: # string. Optional. Use when Destination = AzureBlob. Blob Prefix. 
    #resourceGroup: # string. Alias: EnvironmentNameRM. Required when 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 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. 
    #sasTokenTimeOutInMinutes: # string. SAS Token Expiration Period In Minutes.

Dane wejściowe

SourcePath - Źródła
string. Wymagane.

Określ ścieżkę bezwzględną folderu źródłowego lub plik na komputerze lokalnym lub udział UNC. Można użyć wstępnie zdefiniowanych zmiennych systemowych, takich jak $(Build.Repository.LocalPath). Nazwy zawierające symbole wieloznaczne, takie jak *.zip nie są obsługiwane. Określona wartość lub wyrażenie powinno zwrócić pojedynczy folder lub nazwę pliku.

azureSubscription - Subskrypcja platformy Azure
Alias wejściowy: ConnectedServiceNameARM. string. Wymagane.

Określ nazwę połączenia usługi Azure Resource Manager skonfigurowanego dla subskrypcji, w której znajduje się docelowa usługa platformy Azure, maszyna wirtualna lub konto magazynu. Aby uzyskać więcej informacji, zobacz Omówienie usługi Azure Resource Manager.

Destination - Typ miejsca docelowego
string. Wymagane. Dozwolone wartości: AzureBlob (Azure Blob), AzureVMs (Maszyny wirtualne platformy Azure).

Określ typ docelowy.

storage - Konto magazynu RM
Alias wejściowy: StorageAccountRM. string. Wymagane.

Określ istniejące konto magazynu usługi ARM. Jest to konto magazynu używane jako pośrednik do kopiowania plików na maszyny wirtualne platformy Azure.

ContainerName - Nazwa kontenera
string. Wymagane, gdy Destination = AzureBlob.

Nazwa kontenera, do którego są kopiowane pliki. Jeśli określony kontener nie istnieje na koncie magazynu, zostanie utworzony.

Aby utworzyć katalog wirtualny wewnątrz kontenera, użyj danych wejściowych prefiksu obiektu blob. Na przykład dla lokalizacji https://myaccount.blob.core.windows.net/mycontainer/vd1/vd2/docelowej określ nazwę mycontainer kontenera i prefiks obiektu blob: vd1/vd2.

BlobPrefix - Prefiks obiektu blob
string. Opcjonalny. Użyj polecenia , gdy Destination = AzureBlob.

Określ prefiks, który może służyć do filtrowania plików.

Przykład: możesz dołączyć numer kompilacji, aby filtrować pliki ze wszystkich obiektów blob przy użyciu tego samego numeru kompilacji.

Przykład: Jeśli określisz prefiks myvd1obiektu blob, w kontenerze zostanie utworzony katalog wirtualny. Pliki są kopiowane ze źródła do https://myaccount.blob.core.windows.net/mycontainer/myvd1/.

resourceGroup - Grupa zasobów
Alias wejściowy: EnvironmentNameRM. string. Wymagane, gdy Destination = AzureVMs.

Określ nazwę docelowej grupy zasobów, do której zostaną skopiowane pliki.

ResourceFilteringMethod - Wybieranie maszyn według
string. Opcjonalny. Użyj polecenia , gdy Destination = AzureVMs. Dozwolone wartości: machineNames (nazwy maszyn), tags. Wartość domyślna: machineNames.

Określ nazwę lub tag hosta maszyny wirtualnej, który identyfikuje podzbiór maszyn wirtualnych w grupie zasobów. Tagi są obsługiwane tylko dla zasobów utworzonych za pośrednictwem usługi Azure Resource Manager.

MachineNames - Kryteria filtrowania
string. Opcjonalny. Użyj polecenia , gdy Destination = AzureVMs.

Podaj listę nazw maszyn wirtualnych lub nazw tagów identyfikujących maszyny wirtualne, których dotyczy zadanie. Prawidłowe kryteria filtrowania obejmują:

Nazwa grupy zasobów platformy Azure.
Zmienna wyjściowa z poprzedniego zadania.
Rozdzielana przecinkami lista nazw tagów lub nazw maszyn wirtualnych.
Formatuj nazwy maszyn wirtualnych przy użyciu rozdzielanej przecinkami listy nazw FQDN lub adresów IP.
Formatuj nazwy tagów filtru jako {TagName}:{Value}. Przykład: Role:DB;OS:Win8.1, , ffweb, ffdblub tagi, takie jak Role:DB, Web, OS:Win8.1.

Uwaga: Prawidłowe ograniczniki tagów obejmują ,(przecinek), :(colon) i ;(semicolon). Podczas podawania wielu tagów zadanie będzie uruchamiane tylko na maszynach wirtualnych zawierających określone tagi. Domyślnie zadanie jest uruchamiane na wszystkich maszynach wirtualnych.

vmsAdminUserName - logowanie Administracja
string. Wymagane, gdy Destination = AzureVMs.

Podaj nazwę użytkownika konta z uprawnieniami administracyjnymi na wszystkich docelowych maszynach wirtualnych.

Obsługiwane formaty to: username, , machine-name\usernamedomain\usernamei .\username.
Formaty nazwy UPN, w tym username@domain.com wbudowane konta systemowe, takie jak NT Authority\System nie są obsługiwane.

vmsAdminPassword - Hasło
string. Wymagane, gdy Destination = AzureVMs.

Podaj hasło administratora maszyn wirtualnych.

Prawidłowe dane wejściowe zawierają zmienne zdefiniowane w potokach kompilacji lub wydania, takich jak $(passwordVariable). Aby zabezpieczyć hasło, oznacz je jako secret.

TargetPath - Folder docelowy
string. Wymagane, gdy Destination = AzureVMs.

Określ ścieżkę do folderu na maszynach wirtualnych platformy Azure, do których zostaną skopiowane pliki.

Zmienne środowiskowe, takie jak $env:windir i $env:systemroot są obsługiwane. Przykłady: $env:windir\FabrikamFiber\Web i c:\FabrikamFiber

AdditionalArgumentsForBlobCopy - Opcjonalne argumenty (do przekazywania plików do obiektu blob)
string.

Podaj dodatkowe argumenty AzCopy.exe , które można zastosować podczas przekazywania do obiektów blob, takich jak /NC:10.

Jeśli nie określono żadnych opcjonalnych argumentów, następujące argumenty są domyślnie dodawane.

/Y
/SetContentType
/Z
/V
/S — Dodano, gdy nazwa kontenera nie $rootjest .
/BlobType:page - Dodane, gdy określone konto magazynu jest kontem Premium.
/Pattern — Dodano, gdy ścieżka źródłowa jest plikiem. Dołączone do innych określonych argumentów opcjonalnych.

AdditionalArgumentsForVMCopy - Argumenty opcjonalne (do pobierania plików do maszyny wirtualnej)
string. Opcjonalny. Użyj polecenia , gdy Destination = AzureVMs.

Podaj dodatkowe argumenty AzCopy.exe , które można zastosować podczas pobierania do maszyn wirtualnych, takich jak /NC:10.

Jeśli nie określono żadnych opcjonalnych argumentów, domyślnie są dodawane następujące argumenty.

/Y
/S
/Z
/V

enableCopyPrerequisites - Włączanie wymagań wstępnych kopiowania
boolean. Opcjonalny. Użyj polecenia , gdy Destination = AzureVMs. Wartość domyślna: false.

Po włączeniu użyje certyfikatu z podpisem własnym do skonfigurowania odbiornika zdalnego zarządzania systemem Windows (WinRM) na porcie 5986 zamiast protokołu HTTPS. Wymagane do wykonywania operacji kopiowania na maszynach wirtualnych platformy Azure. Jeśli docelowe maszyny wirtualne używają modułu równoważenia obciążenia, skonfiguruj reguły NAT dla portu docelowego (5986). Dotyczy tylko maszyn wirtualnych usługi ARM. Na docelowych maszynach wirtualnych skojarzonych z sieciową grupą zabezpieczeń skonfiguruj regułę zabezpieczeń dla ruchu przychodzącego, aby zezwolić na dostęp na porcie 5986.

CopyFilesInParallel - Kopiowanie równolegle
boolean. Opcjonalny. Użyj polecenia , gdy Destination = AzureVMs. Wartość domyślna: true.

Określ true , aby skopiować pliki równolegle do docelowych maszyn wirtualnych. Użycie tej wartości może skrócić całkowity czas potrzebny na wykonanie akcji.

CleanTargetBeforeCopy - Czysty obiekt docelowy
boolean. Opcjonalny. Użyj polecenia , gdy Destination = AzureVMs. Wartość domyślna: false.

Ustawienie tej wartości w celu true oczyszczenia folderu docelowego przed wykonaniem akcji kopiowania.

skipCACheck - Certyfikat testowy
boolean. Opcjonalny. Użyj polecenia , gdy Destination = AzureVMs. Wartość domyślna: true.

Wartość domyślna nie sprawdzi, czy certyfikat serwera został podpisany przez zaufany urząd certyfikacji przed nawiązaniem połączenia za pośrednictwem protokołu HTTPS.

outputStorageUri - Identyfikator URI kontenera magazynu
string.

Określ nazwę zmiennej używanej dla identyfikatora URI kontenera magazynu, do którego skopiowano pliki. Prawidłowe tylko wtedy, gdy wybrane miejsce docelowe jest obiektem blob platformy Azure.

outputStorageContainerSasToken - Token sygnatury dostępu współdzielonego kontenera magazynu
string.

Określ nazwę zmiennej używanej dla tokenu SAS kontenera magazynu, który uzyskuje dostęp do skopiowanych plików. Użyj tej zmiennej jako danych wejściowych do kolejnych zadań. Domyślnie token SAS wygasa po 4 godzinach.

sasTokenTimeOutInMinutes - Okres wygaśnięcia tokenu sygnatury dostępu współdzielonego w minutach
string.

Określ czas w minutach, po którym token SAS wygaśnie. Prawidłowe tylko wtedy, gdy wybrane miejsce docelowe to Azure Blob.

Opcje sterowania zadania

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.

Zmienne wyjściowe

Brak.

Uwagi

Co nowego w AzureFileCopy@3 wersji

AzureFileCopy@3 obsługuje moduł Az i przestał obsługiwać klasyczny punkt końcowy usługi platformy Azure.
Zadanie służy do kopiowania plików aplikacji i innych artefaktów wymaganych do zainstalowania aplikacji, takich jak skrypty programu PowerShell, moduły Programu PowerShell-DSC i inne.
Gdy obiektem docelowym są maszyny wirtualne platformy Azure, pliki są najpierw kopiowane do automatycznie wygenerowanego kontenera obiektów blob platformy Azure, a następnie pobierane do maszyn wirtualnych. Kontener zostanie usunięty po pomyślnym skopiowaniu plików do maszyn wirtualnych.
Zadanie używa narzędzia AzCopy, narzędzia wiersza polecenia utworzonego do szybkiego kopiowania danych z kont i do kont usługi Azure Storage. Zadanie w wersji 3 lub nowszej używa narzędzia AzCopy V7.
Aby dynamicznie wdrażać grupy zasobów platformy Azure zawierające maszyny wirtualne, użyj zadania Wdrażania grupy zasobów platformy Azure . To zadanie zawiera przykładowy szablon, który może wykonywać wymagane operacje, aby skonfigurować protokół HTTPS usługi WinRM na maszynach wirtualnych, otworzyć port 5986 w zaporze i zainstalować certyfikat testowy.

Uwaga

Jeśli wdrażasz usługę Azure Static Websites jako kontener w usłudze Blob Storage, użyj wersji 2 lub nowszej, aby zachować nazwę kontenera $web .

Często zadawane pytania

Jakie są Azure PowerShell wymagania wstępne dotyczące korzystania z tego zadania?

Zadanie wymaga zainstalowania Azure PowerShell na maszynie z uruchomionym agentem automatyzacji. Zalecana wersja to 1.0.2, ale zadanie działa z wersją 0.9.8 lub nowszą. Aby uzyskać zalecaną wersję, użyj instalatora Azure PowerShell w wersji 1.0.2.

Jakie są wymagania wstępne usługi WinRM dla tego zadania?

Zadanie używa protokołu HTTPS usługi WinRM do kopiowania plików z kontenera obiektów blob magazynu do maszyn wirtualnych platformy Azure. Usługa WinRM HTTPS musi być skonfigurowana na maszynach wirtualnych i zainstalowany odpowiedni certyfikat.

Jeśli maszyny wirtualne są tworzone bez otwierania portów HTTPS usługi WinRM, wykonaj następujące kroki:

Skonfiguruj regułę dostępu przychodzącego, aby zezwolić na protokół HTTPS na porcie 5986 każdej maszyny wirtualnej.
Wyłącz ograniczenia zdalne kontroli dostępu użytkownika.
Określ poświadczenia zadania, aby uzyskać dostęp do maszyn wirtualnych przy użyciu nazwy logowania na poziomie administratora sformatowanego jako nazwa użytkownika bez żadnych odwołań do domeny.
Zainstaluj certyfikat na maszynie z uruchomionym agentem automatyzacji.
Ustaw parametr Test Certificate zadania dla certyfikatu z podpisem własnym.

Jakiego typu połączenie z usługą należy wybrać?

W poniższej tabeli wymieniono typy kont magazynu i skojarzone połączenia usług. Aby określić, czy konto magazynu jest oparte na klasycznych interfejsach API, czy interfejsach API Resource Manager, zaloguj się do Azure Portal i wyszukaj konta magazynu (klasyczne) lub konta usługi Storage.

Typ konta magazynu	Połączenia usług platformy Azure w programie TFS/TS
Resource Manager	Połączenie z usługą Azure Resource Manager
Klasyczny	Połączenie usługi platformy Azure z uwierzytelnianiem opartym na certyfikatach lub poświadczeniach przy użyciu konta szkolnego lub służbowego

W przypadku zasobów klasycznych platformy Azure użyj typu połączenia usługi platformy Azure z uwierzytelnianiem opartym na certyfikatach lub poświadczeniach. Jeśli używasz uwierzytelniania opartego na poświadczeniach, upewnij się, że poświadczenia są przeznaczone dla konta służbowego. Konta Microsoft, takie jak joe@live.com i joe@hotmail.com nie są obsługiwane.
W przypadku maszyn wirtualnych platformy Azure Resource Manager użyj typu połączenia usługi Azure Resource Manager. Aby uzyskać więcej informacji, zobacz Automatyzowanie wdrażania grupy zasobów platformy Azure przy użyciu jednostki usługi.
Jeśli używasz typu połączenia usługi Azure Resource Manager lub typu połączenia usługi platformy Azure z uwierzytelnianiem opartym na certyfikatach, zadanie automatycznie filtruje odpowiednie klasyczne konta magazynu, nowsze konta magazynu platformy Azure Resource Manager i inne pola. Na przykład grupa zasobów lub usługa w chmurze oraz maszyny wirtualne.

Uwaga

Obecnie typ połączenia usługi platformy Azure z uwierzytelnianiem opartym na poświadczeniach nie filtruje pól magazynu, grupy zasobów ani usługi w chmurze oraz maszyny wirtualnej.

Jak mogę naprawić błąd "403: To żądanie nie jest autoryzowane do wykonania tej operacji przy użyciu tego uprawnienia"?

Gdy usługa Azure DevOps tworzy i autoryzuje połączenie usługi z platformą Azure, tworzy rejestrację aplikacji w usłudze Active Directory subskrypcji. Ta tożsamość jest automatycznie dodawana z rolą Contributor do wszystkich zasobów w grupie zasobów wybranej do autoryzacji. Aby przekazać obiekty blob do konta magazynu, jest Contributorto za mało. Musisz ręcznie przypisać Storage Blob Data Contributor rolę do tożsamości rejestracji aplikacji.

Skopiuj tożsamość aplikacji z istniejącego odziedziczonego wpisu, jak Contributor zobaczysz w okienku Zarządzanie tożsamościami i wyszukaj ją jawnie w interfejsie Add role assignment użytkownika. Tożsamość nie znajduje się na liście rozwijanej. Należy wyszukać jego identyfikator.

Co się stanie, jeśli moja grupa zasobów zawiera zarówno maszyny wirtualne klasyczne, jak i Resource Manager?

Jeśli określona grupa zasobów zawiera zarówno maszyny wirtualne platformy Azure Resource Manager, jak i klasyczne maszyny wirtualne, zestaw docelowych maszyn wirtualnych zależy od typu połączenia.

W przypadku połączeń opartych na certyfikatach i połączeń opartych na poświadczeniach operacja kopiowania jest wykonywana tylko na klasycznych maszynach wirtualnych.
W przypadku połączeń opartych na nazwie głównej usługi operacja kopiowania jest wykonywana tylko na maszynach wirtualnych Resource Manager.

Jak mogę utworzyć konto szkolne lub służbowe do użycia z tym zadaniem?

Odpowiednie konto można łatwo utworzyć do użycia w połączeniu z usługą:

Użyj Azure Portal, aby utworzyć nowe konto użytkownika w usłudze Azure Active Directory.
Dodaj konto użytkownika usługi Azure Active Directory do grupy współadministratorów w subskrypcji platformy Azure.
Zaloguj się do Azure Portal przy użyciu tego konta użytkownika i zmień hasło.
Użyj nowych poświadczeń dla tego konta w połączeniu usługi. Wdrożenia zostaną przetworzone przy użyciu tego konta.

Przykłady

# Example: Upload files from Pipeline staging directory to blob storage.
- task: AzureFileCopy@3
  displayName: 'Example Step Name'
  inputs:
    sourcePath: '$(Build.ArtifactStagingDirectory)/BlobsToUpload'
    additionalArgumentsForBlobCopy: |
      '/Y' # Supresses all AZCopy Confirmations. Used here to allow overwrites
      '/Pattern:*' # Pattern of files to copy.
      '/S' # Recursive Copy
    azureSubscription: 'Subscription Name'
    destination: AzureBlob
    storage: storageaccountname
    containerName: storagecontainername
    blobPrefix: targetdirectoryincontainer

Wymagania

Wymaganie	Opis
Typy potoków	YAML, kompilacja klasyczna, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Agenci hostowani samodzielnie muszą mieć możliwości zgodne z następującymi wymaganiami dotyczącymi uruchamiania zadań korzystających z tego zadania: azureps
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	1.103.0 lub nowsza
Kategoria zadania	Wdrażanie

Udostępnij za pośrednictwem

AzureFileCopy@3 — zadanie kopiowania plików platformy Azure w wersji 3

Składnia

Dane wejściowe

Opcje sterowania zadania

Zmienne wyjściowe

Uwagi

Często zadawane pytania

Jakie są Azure PowerShell wymagania wstępne dotyczące korzystania z tego zadania?

Jakie są wymagania wstępne usługi WinRM dla tego zadania?

Jakiego typu połączenie z usługą należy wybrać?

Jak mogę naprawić błąd "403: To żądanie nie jest autoryzowane do wykonania tej operacji przy użyciu tego uprawnienia"?

Co się stanie, jeśli moja grupa zasobów zawiera zarówno maszyny wirtualne klasyczne, jak i Resource Manager?

Jak mogę utworzyć konto szkolne lub służbowe do użycia z tym zadaniem?

Przykłady

Wymagania

Opinia

Opinia

Dodatkowe zasoby