AzureResourceManagerTemplateDeployment@3 — zadanie wdrażania szablonu usługi ARM w wersji 3

To zadanie służy do wdrażania szablonu usługi Azure Resource Manager (ARM) we wszystkich zakresach wdrażania.

Składnia

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file. Template link. 
    #csmParametersFileLink: # string. Optional. Use when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file. Template parameters link. 
    #csmFile: # string. Required when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact. Template. 
    #csmParametersFile: # string. Optional. Use when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

Wejścia

zakresu wdrażania deploymentScope -
string. Wymagane. Dozwolone wartości: Management Group, Subscription, Resource Group. Wartość domyślna: Resource Group.

Zakres wdrożenia. Dowiedz się więcej o zakresach wdrażania .

azureResourceManagerConnection - połączenia usługi Azure Resource Manager
Alias wejściowy: ConnectedServiceName. string. Wymagane.

Określa połączenie usługi Azure Resource Manager z dostępem do wybranego zakresu wdrożenia.

subskrypcji subscriptionId -
Alias wejściowy: subscriptionName. string. Wymagane, gdy deploymentScope != Management Group.

Określa subskrypcję platformy Azure.

Ważny

Określona wartość musi być identyfikatorem subskrypcji, a nie nazwą subskrypcji.

action - akcja
string. Wymagane, gdy deploymentScope = Resource Group. Dozwolone wartości: Create Or Update Resource Group, DeleteRG (Usuń grupę zasobów). Wartość domyślna: Create Or Update Resource Group.

Akcja do wykonania w zasobach platformy Azure lub grupie zasobów.

grupy zasobów resourceGroupName -
string. Wymagane, gdy deploymentScope = Resource Group.

Zawiera nazwę grupy zasobów.

lokalizacji location -
string. Wymagane, gdy action = Create Or Update Resource Group || deploymentScope != Resource Group.

Zakresy wdrażania grupy zasobów: lokalizacja wdrożenia grupy zasobów. Jeśli grupa zasobów już istnieje w subskrypcji platformy Azure, ta wartość zostanie zignorowana. Inne zakresy wdrażania: lokalizacja do przechowywania metadanych wdrożenia.

templateLocation - lokalizacja szablonu
string. Wymagane, gdy action = Create Or Update Resource Group || deploymentScope != Resource Group. Dozwolone wartości: Linked artifact, URL of the file. Wartość domyślna: Linked artifact.

Lokalizacja szablonu i plików JSON parametrów. Wybierz połączony artefakt, jeśli pliki są częścią połączonego kodu/artefaktów kompilacji. W przypadku połączonych artefaktów można również określić ścieżkę do pliku Bicep. Wybierz adres URL pliku, jeśli pliki JSON znajdują się w dowolnych publicznie dostępnych adresach URL http/https. Aby użyć pliku przechowywanego na prywatnym koncie magazynu, pobierz i dołącz token sygnatury dostępu współdzielonego (SAS) w adresie URL szablonu. Przykład: <blob_storage_url>/template.json?. Aby przekazać plik parametrów do konta magazynu i wygenerować token SAS, możesz użyć zadania kopiowania plików platformy Azure lub wykonać kroki opisane w programu PowerShell lub interfejsu wiersza polecenia platformy Azure.

linku szablonu csmFileLink -
string. Wymagane, gdy (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Określa adres URL pliku szablonu. Przykładowy adres URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Aby wdrożyć szablon przechowywany na prywatnym koncie magazynu, pobierz i dołącz token sygnatury dostępu współdzielonego (SAS) w adresie URL szablonu. Przykład: <blob_storage_url>/template.json?<SAStoken>. Aby przekazać plik szablonu (lub połączony szablon) do konta magazynu i wygenerować token SAS, użyj zadania kopiowania plików platformy Azure lub wykonaj kroki opisane w programu PowerShell lub interfejsu wiersza polecenia platformy Azure.

Aby wyświetlić parametry szablonu w siatce, kliknij ... obok pola tekstowego zastąpić parametry szablonu. Ta funkcja wymaga włączenia reguł CORS w źródle. Jeśli szablony znajdują się w obiekcie blob usługi Azure Storage, zapoznaj się z udostępnianiem zasobów między źródłami, aby włączyć mechanizm CORS.

link parametrów szablonu csmParametersFileLink -
string. Fakultatywny. Użyj polecenia , gdy (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Określa adres URL pliku parametrów. Przykładowy adres URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Aby użyć pliku przechowywanego na prywatnym koncie magazynu, pobierz i dołącz token sygnatury dostępu współdzielonego (SAS) w adresie URL szablonu. Przykład: <blob_storage_url>/template.json?<SAStoken>. Aby przekazać plik szablonu (lub połączony szablon) do konta magazynu i wygenerować token SAS, użyj zadania kopiowania plików platformy Azure lub wykonaj kroki opisane w programu PowerShell lub interfejsu wiersza polecenia platformy Azure.

Aby wyświetlić parametry szablonu w siatce, kliknij ... obok pola tekstowego Przesłoń parametry szablonu. Ta funkcja wymaga włączenia reguł CORS w źródle. Jeśli szablony znajdują się w obiekcie blob usługi Azure Storage, zapoznaj się z udostępnianiem zasobów między źródłami, aby włączyć mechanizm CORS.

szablonu csmFile -
string. Wymagane, gdy (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Określa ścieżkę lub wzorzec wskazujący szablon usługi Azure Resource Manager. Dowiedz się więcej o szablonach usługi Azure Resource Manager . Aby natychmiast rozpocząć pracę, użyj tego przykładowego szablonu. Obsługuje pliki Bicep, gdy interfejs wiersza polecenia platformy Azure w wersji > 2.20.0.

parametry szablonu csmParametersFile -
string. Fakultatywny. Użyj polecenia , gdy (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Określ ścieżkę lub wzorzec wskazujący plik parametrów dla szablonu usługi Azure Resource Manager. Obsługuje pliki Bicep Param, gdy interfejs wiersza polecenia platformy Azure w wersji > 2.47.0.

overrideParameters - Przesłoń parametry szablonu
string. Fakultatywny. Użyj polecenia , gdy action = Create Or Update Resource Group || deploymentScope != Resource Group.

Określa parametry szablonu do zastąpienia.

Aby wyświetlić parametry szablonu w siatce, kliknij ... obok pola tekstowego Przesłoń parametry. Ta funkcja wymaga włączenia reguł CORS w źródle. Jeśli szablony znajdują się w obiekcie blob usługi Azure Storage, odwołaj się do tego ciągu, aby włączyć mechanizm CORS, lub wpisz parametry szablonu do zastąpienia w polu tekstowym.

Przykład: -storageName fabrikam -adminUsername $(vmusername) -adminPassword (ConvertTo-SecureString -String '$(password)' -AsPlainText -Force) -azureKeyVaultName $(fabrikamFibre).

Jeśli wartość parametru ma wiele wyrazów, należy ująć wyrazy w cudzysłowy, nawet jeśli przekazujesz wartość przy użyciu zmiennych. Na przykład -name "parameter value" -name2 "$(var)". Aby zastąpić parametry typu obiektu, użyj ciągyfikowanych obiektów JSON. Na przykład -options ["option1"] -map {"key1": "value1" }.

deploymentMode - tryb wdrażania
string. Wymagane, gdy action = Create Or Update Resource Group || deploymentScope != Resource Group. Dozwolone wartości: Incremental, Complete, Validation (tylko walidacja). Wartość domyślna: Incremental.

Tryb Incremental obsługuje wdrożenia jako aktualizacje przyrostowe do grupy zasobów. Pozostawia niezmienione zasoby, które istnieją w grupie zasobów, ale nie zostały określone w szablonie.

Complete tryb usuwa zasoby, które nie znajdują się w szablonie. Tryb ukończenia zajmuje stosunkowo więcej czasu niż tryb przyrostowy. Jeśli limit czasu zadania zostanie przekroczony, rozważ zwiększenie limitu czasu lub zmianę na tryb Incremental.

Ostrzeżenie

Tryb ukończenia spowoduje usunięcie wszystkich istniejących zasobów w grupie zasobów, które nie zostały określone w szablonie. Sprawdź, czy wdrażana grupa zasobów nie zawiera żadnych niezbędnych zasobów, które nie zostały określone w szablonie. Validate tryb umożliwia znalezienie problemów z szablonem przed utworzeniem rzeczywistych zasobów.

Nuta

Tryb Validate zawsze tworzy grupę zasobów, nawet jeśli nie są wdrażane żadne zasoby. Dowiedz się więcej o trybach wdrażania .

deploymentName - nazwa wdrożenia
string. Fakultatywny. Użyj polecenia , gdy action = Create Or Update Resource Group || deploymentScope != Resource Group.

Określa nazwę wdrożenia grupy zasobów do utworzenia.

dane wyjściowe wdrożenia deploymentOutputs -
string. Fakultatywny. Użyj polecenia , gdy action = Create Or Update Resource Group || deploymentScope != Resource Group.

Zawiera nazwę zmiennej dla zmiennej wyjściowej, która zawiera sekcję danych wyjściowych bieżącego obiektu wdrożenia w formacie ciągu. Możesz użyć ConvertFrom-Json polecenia cmdlet programu PowerShell, aby przeanalizować obiekt JSON i uzyskać dostęp do poszczególnych wartości wyjściowych. Dowiedz się więcej o danych wyjściowych wdrażania .

addSpnToEnvironment - Szczegóły jednostki usługi programu Access w zastąpić parametry
boolean. Fakultatywny. Użyj polecenia , gdy action = Create Or Update Resource Group || deploymentScope != Resource Group. Wartość domyślna: false.

Dodaje identyfikator jednostki usługi i klucz punktu końcowego platformy Azure wybranego jako środowisko wykonywania skryptu. Zmienne $servicePrincipalId i $servicePrincipalKey mogą być w parametrach zastąpienia, takich jak -key $servicePrincipalKey.

useWithoutJSON - Użyj pojedynczych wartości wyjściowych bez formatu JSON. Zastosowane stringify
boolean. Fakultatywny. Użyj polecenia , gdy action = Create Or Update Resource Group || deploymentScope != Resource Group. Wartość domyślna: false.

Poszczególne wartości wyjściowe są konwertowane za pośrednictwem formatu JSON. Ciągifikuj domyślnie. Jeśli chcesz użyć wartości wyjściowych bez konwertowania ich za pomocą formatu JSON. Stringify, włącz tę opcję. Aby uzyskać więcej informacji, zobacz tym.

Opcje sterowania zadaniami

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

Zmienne wyjściowe

Żaden.

Uwagi

Nuta

To zadanie obsługuje pliki Bicep, gdy interfejs wiersza polecenia platformy Azure w wersji > 2.20.0.

• Dodano obsługę wdrażania we wszystkich zakresach wdrażania.
  • Usunięto wszystkie akcje związane z maszyną wirtualną.

Wymagania

Wymaganie	Opis
Typy potoków	YAML, klasyczna kompilacja, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Żaden
możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
ograniczenia poleceń	Jakikolwiek
zmienne ustawiane	Jakikolwiek
Wersja agenta	2.119.1 lub nowsza
Kategoria zadań	Wdrożyć