AzureResourceGroupDeployment@2 - Azure-resourcegroepimplementatie v2-taak

Een ARM-sjabloon (Azure Resource Manager) implementeren in een resourcegroep en virtuele machines beheren.

Syntaxis

# Azure resource group deployment v2
# Deploy an Azure Resource Manager (ARM) template to a resource group and manage virtual machines.
- task: AzureResourceGroupDeployment@2
  inputs:
  # Azure Details
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'Select Resource Group' | 'Start' | 'Stop' | 'StopWithDeallocate' | 'Restart' | 'Delete' | 'DeleteRG'. Required. Action. Default: Create Or Update Resource Group.
    resourceGroupName: # string. Required. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group. Deployment mode. Default: Incremental.
  # Advanced deployment options for virtual machines
    #enableDeploymentPrerequisites: 'None' # 'None' | 'ConfigureVMwithWinRM' | 'ConfigureVMWithDGAgent'. Optional. Use when action = Create Or Update Resource Group || action = Select Resource Group. Enable prerequisites. Default: None.
    #teamServicesConnection: # string. Alias: deploymentGroupEndpoint. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Azure Pipelines service connection. 
    #teamProject: # string. Alias: project. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Team project. 
    #deploymentGroupName: # string. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true. Password. 
    #outputVariable: # string. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && (enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None). VM details for WinRM. 
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

Ingangen

azureSubscription - Azure-abonnement
Invoeralias: ConnectedServiceName. string. Vereist.

Selecteert de serviceverbinding die een Azure-abonnement voor de implementatie bevat.

action - actie-
string. Vereist. Toegestane waarden: Create Or Update Resource Group, Select Resource Group (implementatieopties voor virtuele machines configureren), Start (virtuele machines starten), Stop (virtuele machines stoppen), StopWithDeallocate (virtuele machines stoppen en de toewijzing ervan ongedaan maken), Restart (virtuele machines opnieuw opstarten), Delete (virtuele machines verwijderen), DeleteRG (resourcegroep verwijderen). Standaardwaarde: Create Or Update Resource Group.

De actie die moet worden uitgevoerd op de Azure-resources of -resourcegroep.

resourceGroupName - resourcegroep
string. Vereist.

Hiermee geeft u de naam van de resourcegroep op.

location - locatie
string. Vereist wanneer action = Create Or Update Resource Group.

De locatie voor het implementeren van de resourcegroep. Als de resourcegroep al bestaat in het abonnement, wordt deze waarde genegeerd.

templateLocation - sjabloonlocatie
string. Vereist wanneer action = Create Or Update Resource Group. Toegestane waarden: Linked artifact, URL of the file. Standaardwaarde: Linked artifact.

Selecteer gekoppelde artefact of URL van het bestand.

csmFileLink - sjabloonkoppeling
string. Vereist wanneer templateLocation = URL of the file && action = Create Or Update Resource Group.

Hiermee geeft u de URL van het sjabloonbestand. Een voorbeeld-URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Als u een sjabloon wilt implementeren die is opgeslagen in een privéopslagaccount, haalt u het SAS-token (Shared Access Signature) op in de URL van de sjabloon. Voorbeeld: <blob_storage_url>/template.json?<SAStoken>

Als u een sjabloonbestand (of een gekoppelde sjabloon) wilt uploaden naar een opslagaccount en een SAS-token wilt genereren, gebruikt u de Azure-bestandskopie taak of volgt u de stappen met behulp van PowerShell- of Azure CLI-.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak sjabloonparameters negeren. Voor deze functie moeten CORS-regels zijn ingeschakeld bij de bron. Als de sjablonen zich in een Azure Storage-blob bevinden, raadpleegt u CORS-aanvragen om CORS in te schakelen.

Koppeling naar csmParametersFileLink - sjabloonparameters
string. Facultatief. Gebruiken wanneer templateLocation = URL of the file && action = Create Or Update Resource Group.

Hiermee geeft u de URL van het parameterbestand. Voorbeeld: https://raw.githubusercontent.com/Azure/...

Als u een bestand wilt gebruiken dat is opgeslagen in een privéopslagaccount, haalt u het SAS-token (Shared Access Signature) op in de URL van de sjabloon. Voorbeeld: <blob_storage_url>/template.json?<SAStoken> Een parameterbestand uploaden naar een opslagaccount en een SAS-token genereren, kunt u Azure-bestandskopie taak gebruiken of de stappen volgen met behulp van PowerShell- of Azure CLI-.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak sjabloonparameters negeren. Voor deze functie moeten CORS-regels zijn ingeschakeld bij de bron. Als de sjablonen zich in een Azure Storage-blob bevinden, raadpleegt u CORS-aanvragen om CORS in te schakelen.

csmFile - sjabloon
string. Vereist wanneer templateLocation = Linked artifact && action = Create Or Update Resource Group.

Hiermee geeft u het pad of een patroon aan dat verwijst naar de Azure Resource Manager-sjabloon. Meer informatie over Azure Resource Manager-sjablonen. Gebruik deze voorbeeldsjabloonom direct aan de slag te gaan.

csmParametersFile - sjabloonparameters
string. Facultatief. Gebruiken wanneer templateLocation = Linked artifact && action = Create Or Update Resource Group.

Hiermee geeft u de URL van het parameterbestand. Een voorbeeld-URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Als u een bestand wilt gebruiken dat is opgeslagen in een privéopslagaccount, haalt u het SAS-token (Shared Access Signature) op in de URL van de sjabloon. Voorbeeld: <blob_storage_url>/template.json?<SAStoken> een parameterbestand uploaden naar een opslagaccount en een SAS-token genereren, gebruikt u de Azure-bestandskopie taak of volgt u de stappen met behulp van PowerShell- of Azure CLI-.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak sjabloonparameters negeren. Voor deze functie moeten CORS-regels zijn ingeschakeld bij de bron. Als de sjablonen zich in een Azure Storage-blob bevinden, raadpleegt u CORS-aanvragen om CORS in te schakelen.

overrideParameters - sjabloonparameters overschrijven
string. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group.

Hiermee geeft u de sjabloonparameters die moeten worden overschreven.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak parameters negeren. Voor deze functie moeten CORS-regels zijn ingeschakeld bij de bron. Als de sjablonen zich in de Azure Storage-blob bevinden, raadpleegt u deze tekenreeks om CORS in te schakelen of typt u de sjabloonparameters die u wilt overschrijven in het tekstvak.

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

Als de parameterwaarde meerdere woorden bevat, plaatst u de woorden tussen aanhalingstekens, zelfs als u de waarde doorgeeft met behulp van variabelen. Bijvoorbeeld -name "parameter value" -name2 "$(var)". Als u parameters voor objecttypen wilt overschrijven, gebruikt u tekenreeksen die JSON-objecten bevatten. Bijvoorbeeld -options ["option1"] -map {"key1": "value1" }.

deploymentMode - implementatiemodus
string. Vereist wanneer action = Create Or Update Resource Group. Toegestane waarden: Incremental, Complete, Validation (alleen validatie). Standaardwaarde: Incremental.

De Incremental-modus verwerkt implementaties als incrementele updates voor de resourcegroep. Er blijven ongewijzigde resources in de resourcegroep aanwezig, maar worden niet opgegeven in de sjabloon.

Complete modus verwijdert resources die zich niet in uw sjabloon bevinden. De volledige modus kost relatief meer tijd dan incrementele modus. Als er een time-out optreedt voor de taak, kunt u overwegen om de time-out te verhogen of over te schakelen naar de modus Incremental.

Waarschuwing

In de volledige modus worden alle bestaande resources in de resourcegroep verwijderd die niet in de sjabloon zijn opgegeven. Controleer of de resourcegroep waarnaar u implementeert geen benodigde resources bevat die niet zijn opgegeven in de sjabloon.

Validate modus kunt u problemen met de sjabloon vinden voordat u werkelijke resources maakt.

Notitie

In de Validate modus wordt altijd een resourcegroep gemaakt, zelfs als er geen resources zijn geïmplementeerd.

Meer informatie over implementatiemodi.

enableDeploymentPrerequisites - Vereisten inschakelen
string. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group || action = Select Resource Group. Toegestane waarden: None, ConfigureVMwithWinRM (configureren met WinRM-agent), ConfigureVMWithDGAgent (configureren met implementatiegroepagent). Standaardwaarde: None.

Alleen van toepassing wanneer de resourcegroep virtuele machines bevat.

Als u de optie Implementatiegroep kiest, wordt de implementatiegroepagent op elk van de virtuele machines geconfigureerd.

Als u de WinRM-optie selecteert, wordt de WinRM-listener (Windows Remote Management) via het HTTPS-protocol op poort 5986 geconfigureerd met behulp van een zelfondertekend certificaat. Deze configuratie is vereist voor het uitvoeren van implementatiebewerkingen op Azure-machines. Als de doel-VM's worden ondersteund door een load balancer, controleert u of de binnenkomende NAT-regels zijn geconfigureerd voor de doelpoort (5986).

teamServicesConnection - Azure Pipelines-serviceverbinding
Invoeralias: deploymentGroupEndpoint. string. Vereist wanneer (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Hiermee geeft u de serviceverbinding op om verbinding te maken met een Azure DevOps-organisatie of -verzameling voor agentregistratie.

U kunt een serviceverbinding maken met behulp van +New en vervolgens Token-based authenticationselecteren. U hebt een persoonlijke toegangstoken(PAT) nodig om een serviceverbinding in te stellen. Klik op Manage om de details van de serviceverbinding bij te werken.

teamProject - teamproject
Invoeralias: project. string. Vereist wanneer (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Hiermee geeft u het teamproject op dat de implementatiegroep definieert.

deploymentGroupName - implementatiegroep
string. Vereist wanneer (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Hiermee geeft u de implementatiegroep op waarmee de agent(en) worden geregistreerd. Meer informatie over implementatiegroepen.

copyAzureVMTags - Azure VM-tags kopiëren naar agents
boolean. Facultatief. Gebruiken wanneer (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Standaardwaarde: true.

Hiermee kiest u of de geconfigureerde tags op de Virtuele Azure-machine moeten worden gekopieerd naar de bijbehorende agent voor de implementatiegroep.

Standaard worden alle Azure-tags gekopieerd volgens de indeling: Key: Value. Voorbeeld: Een Role : Web Azure-tag wordt as-is gekopieerd naar de agentcomputer.

Meer informatie over het gebruik van tags voor Azure-resources.

runAgentServiceAsUser - Agent-service uitvoeren als gebruiker
boolean. Facultatief. Gebruiken wanneer (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Standaardwaarde: false.

Voert de agentservice uit als een andere gebruiker dan de standaardgebruiker als de waarde is ingesteld op true.

De standaardgebruiker is NT AUTHORITY\\SYSTEM in Windows en root in Linux.

userName - gebruikersnaam
string. Vereist wanneer enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true.

De gebruikersnaam voor het uitvoeren van de agentservice op de virtuele machines.

Geef voor domeingebruikers waarden op als domain\username of username@domain.com. Geef voor lokale gebruikers usernameop.

Er wordt van uitgegaan dat dezelfde domeingebruiker of een lokale gebruiker met dezelfde naam, respectievelijk aanwezig is op alle virtuele machines in de resourcegroep.

password - wachtwoord
string. Facultatief. Gebruiken wanneer enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true.

Het wachtwoord voor de gebruiker om de agentservice uit te voeren op de Windows-VM's.

Er wordt van uitgegaan dat het wachtwoord hetzelfde is voor de opgegeven gebruiker op alle VM's.

Het kan variabelen accepteren die zijn gedefinieerd in build- of release-pijplijnen als $(passwordVariable). U kunt de variabele markeren als secret om deze te beveiligen.

Voor Linux-VM's is geen wachtwoord vereist en wordt dit genegeerd.

outputVariable - VM-details voor WinRM-
string. Facultatief. Gebruiken wanneer (action = Create Or Update Resource Group || action = Select Resource Group) && (enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None).

Vereist wanneer een bestaande resourcegroep is geselecteerd. Geeft een naam op voor de resourcegroepvariabele. De variabele kan worden gebruikt als $(variableName) om te verwijzen naar de resourcegroep in volgende taken, zoals in PowerShell op doelmachines voor het implementeren van toepassingen.

Alleen geldig wanneer de geselecteerde actie is Create, Updateof Select.

deploymentName - implementatienaam
string. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group.

Hiermee geeft u de naam op van de implementatie van de resourcegroep die moet worden gemaakt.

deploymentOutputs - implementatie-uitvoer
string. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group.

Biedt een naam voor de uitvoervariabele, die de uitvoersectie van het huidige implementatieobject in tekenreeksindeling bevat. Gebruik de ConvertFrom-Json PowerShell-cmdlet om het JSON-object te parseren en toegang te krijgen tot de afzonderlijke uitvoerwaarden.

addSpnToEnvironment - Details van service-principal van Access bij het overschrijven van parameters
boolean. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group. Standaardwaarde: false.

Voegt de service-principal-id en -sleutel toe van het Azure-eindpunt dat is gekozen als de uitvoeringsomgeving van het script. De variabelen $servicePrincipalId en $servicePrincipalKey kunnen parameters overschrijven, zoals -key $servicePrincipalKey.

useWithoutJSON - Afzonderlijke uitvoerwaarden zonder JSON gebruiken. Stringify toegepaste
boolean. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group. Standaardwaarde: false.

Afzonderlijke uitvoerwaarden worden geconverteerd via JSON. Stringify standaard. Als u de uitvoerwaarden wilt gebruiken zoals het is zonder ze te converteren via JSON. Stringify, schakel deze optie in. Raadpleeg dezevoor meer informatie.

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties en algemene taakeigenschappenvoor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

Er is een nieuwe versie van deze taak beschikbaar op AzureResourceManagerTemplateDeployment@3 - ARM-sjabloonimplementatie v3-taak.

Wat is er nieuw in taakversie 2?

• Werkt met platformoverschrijdende agents (Linux, macOS of Windows)
• Ondersteunt sjabloon-JSON's op alle openbaar toegankelijke HTTP/https-URL's.
• Verbeterde UX voor onderdrukkingsparameters die nu kunnen worden weergegeven/bewerkt in een raster.
• NAT-regeltoewijzing voor VM's die worden ondersteund door een load balancer.
• Het veld Resourcegroep heeft nu de naam 'VM-details voor WinRM' en is opgenomen in de sectie Geavanceerde implementatieopties voor virtuele machines.
• Beperkingen:
  • Geen ondersteuning voor klassieke abonnementen. Alleen ARM-abonnementen worden ondersteund.
  • Er is geen ondersteuning voor PowerShell-syntaxis omdat de taak nu is node.js gebaseerd. Zorg ervoor dat de hoofdlettergevoeligheid van de parameternamen overeenkomt wanneer u de sjabloonparameters overschrijft. Verwijder ook de PowerShell-cmdlets, zoals ConvertTo-SecureString, wanneer u migreert van versie 1.0 naar versie 2.0.

Probleemoplossing

Fout: Interne serverfout

Deze problemen zijn meestal tijdelijk van aard. Er zijn meerdere redenen waarom dit kan gebeuren:

• Een van de Azure-services die u probeert te implementeren, is onderhoud ondergaan in de regio waarin u wilt implementeren. Houd https://status.azure.com/ in de gaten om downtime van Azure-services te controleren.
• De Azure Pipelines-service zelf doorloopt onderhoud. Houd https://status.dev.azure.com/ in de gaten voor downtime.

We hebben echter enkele gevallen gezien waarbij dit wordt veroorzaakt door een fout in de ARM-sjabloon, zoals de Azure-service die u probeert te implementeren, geen ondersteuning biedt voor de regio die u voor de resource hebt gekozen.

Fout: Time-out

Time-outproblemen kunnen afkomstig zijn van twee locaties:

• Azure Pipelines-agent
• Portalimplementatie

U kunt bepalen of de time-out afkomstig is van de portal door te controleren op de portalimplementatiekoppeling die zich in de taaklogboeken bevindt. Als er geen koppeling is, is dit waarschijnlijk het gevolg van de Azure Pipelines-agent. Als er een koppeling is, volgt u de koppeling om te zien of er een time-out is opgetreden in de portalimplementatie.

Fout: CORS-regels die moeten worden ingeschakeld tijdens het overschrijven van parameters

Als het sjabloonbestand wordt verwezen vanuit een BLOB en parameters in de pijplijn overschrijft, ziet u mogelijk het volgende waarschuwingsbericht:

Warning: Failed to download the file from template path.

Voor deze functie moeten de CORS-regels worden ingeschakeld bij de bron. Als sjablonen zich in azure Storage-blob bevinden, raadpleegt u ondersteuning voor cross-origin-resources delen om CORS in te schakelen.

Zorg er naast het inschakelen van CORS voor dat het SAS-token dat is opgegeven in de koppeling van de sjabloon 'srt-sco' is. Dit token is vereist om het bestand te downloaden en door te gaan.

Azure Pipelines-agent

Als het probleem afkomstig is van de Azure Pipelines-agent, kunt u de time-out verhogen door time-outInMinutes in te stellen als sleutel in de YAML op 0. Zie Taken opgeven in uw pijplijnvoor meer informatie.

Portalimplementatie

Bekijk dit document over hoe u kunt vaststellen of de fout afkomstig is uit Azure Portal: Implementatiegeschiedenis weergeven met Azure Resource Manager.

In het geval van portalimplementatie kunt u 'timeoutInMinutes' in de ARM-sjabloon instellen op '0'. Als dit niet is opgegeven, wordt ervan uitgegaan dat de waarde 60 minuten is. 0 zorgt ervoor dat de implementatie wordt uitgevoerd zolang deze kan slagen.

Dit kan ook gebeuren vanwege tijdelijke problemen in het systeem. Houd https://status.dev.azure.com/ in de gaten om te controleren of er sprake is van downtime in de Azure Pipelines-service.

Fout: Validatie van ARM-sjabloon (Azure Resource Manager) is mislukt

Dit probleem treedt meestal op vanwege een ongeldige parameter in de ARM-sjabloon, zoals een niet-ondersteunde SKU of regio. Als de validatie mislukt, controleert u het foutbericht. U wordt nu naar de resource en parameter verwijst die ongeldig is.

Dit probleem kan ook optreden vanwege tekenreeksen met meerdere regels. Momenteel biedt de azure-resourcegroepimplementatietaak geen ondersteuning voor tekenreeksen met meerdere regels in een ARM-sjabloon of parameter-JSON-bestand.

Raadpleeg daarnaast dit artikel met betrekking tot de structuur en syntaxis van ARM-sjablonen: Inzicht in de structuur en syntaxis van ARM-sjablonen.

Eisen

Eis	Beschrijving
Pijplijntypen	YAML, klassieke build, klassieke release
Wordt uitgevoerd op	Agent, DeploymentGroup
eisen	Geen
mogelijkheden	Deze taak voldoet niet aan de vereisten voor volgende taken in de taak.
opdrachtbeperkingen	Enig
variabelen instellen	Enig
Agentversie	2.119.1 of hoger
Taakcategorie	Implementeren