AzureResourceGroupDeployment@2 - Implementatie v2-taak van Azure-resourcegroep

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

Syntax

# 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 enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Azure Pipelines service connection. 
    #teamProject: # string. Alias: project. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Team project. 
    #deploymentGroupName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. Password. 
    #outputVariable: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Group. 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.

Invoerwaarden

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.

Geeft 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 in het abonnement bestaat, 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 Gekoppeld 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 en neemt u dit 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-taak voor het kopiëren van bestanden of volgt u de stappen met PowerShell of Azure CLI.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak sjabloonparameters overschrijven. Deze functie vereist dat CORS-regels zijn ingeschakeld bij de bron. Als de sjablonen zich in een Azure-opslagblob bevinden, raadpleegt u CORS-aanvragen begrijpen om CORS in te schakelen.

csmParametersFileLink - Koppeling sjabloonparameters
string. Optioneel. Gebruik 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 en neemt u dit op in de URL van de sjabloon. Voorbeeld: <blob_storage_url>/template.json?<SAStoken> als u een parameterbestand wilt uploaden naar een opslagaccount en een SAS-token wilt genereren, kunt u de Azure-bestandskopietaak gebruiken of de stappen volgen met PowerShell of Azure CLI.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak sjabloonparameters overschrijven. Deze functie vereist dat CORS-regels zijn ingeschakeld bij de bron. Als de sjablonen zich in een Azure-opslagblob bevinden, raadpleegt u CORS-aanvragen begrijpen 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 op dat verwijst naar de Azure Resource Manager-sjabloon. Meer informatie over Azure Resource Manager-sjablonen. Gebruik deze voorbeeldsjabloon om direct aan de slag te gaan.

csmParametersFile - Sjabloonparameters
string. Optioneel. Gebruik 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 en neemt u dit op in de URL van de sjabloon. Voorbeeld: <blob_storage_url>/template.json?<SAStoken> als u een parameterbestand wilt uploaden naar een opslagaccount en een SAS-token wilt genereren, gebruikt u de Azure-taak voor het kopiëren van bestanden of volgt u de stappen met PowerShell of Azure CLI.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak sjabloonparameters overschrijven. Deze functie vereist dat CORS-regels zijn ingeschakeld bij de bron. Als de sjablonen zich in een Azure-opslagblob bevinden, raadpleegt u CORS-aanvragen begrijpen om CORS in te schakelen.

overrideParameters - Sjabloonparameters overschrijven
string. Optioneel. Gebruik wanneer action = Create Or Update Resource Group.

Hiermee geeft u de sjabloonparameters op die moeten worden overschreven.

Als u de sjabloonparameters in een raster wilt weergeven, klikt u op ... naast het tekstvak parameters overschrijven. Deze functie vereist dat 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.

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

Als de parameterwaarde uit meerdere woorden bestaat, 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 van het objecttype wilt overschrijven, gebruikt u tekenreeksen voor JSON-objecten. 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 over die aanwezig zijn in de resourcegroep, maar die niet zijn opgegeven in de sjabloon.

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

Waarschuwing

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

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

Notitie

De Validate modus maakt altijd een resourcegroep, zelfs als er geen resources zijn geïmplementeerd.

Meer informatie over implementatiemodi.

enableDeploymentPrerequisites - Vereisten inschakelen
string. Optioneel. Gebruik 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, configureert u de implementatiegroepagent op elk van de virtuele machines.

Als u de optie WinRM selecteert, configureert u de WinRM-listener (Windows Remote Management) via het HTTPS-protocol op poort 5986 met behulp van een zelfondertekend certificaat. Deze configuratie is vereist voor het uitvoeren van implementatiebewerkingen op Azure-machines. Als de virtuele doelmachines worden ondersteund door een load balancer, moet u ervoor zorgen dat de binnenkomende NAT-regels zijn geconfigureerd voor de doelpoort (5986).

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

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 selecteren Token-based authentication. U hebt een persoonlijk toegangstoken (PAT) nodig om een serviceverbinding in te stellen. Klik Manage om de details van de serviceverbinding bij te werken.

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

Hiermee geeft u het teamproject op dat de implementatiegroep definieert.

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

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

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

Hiermee wordt opgegeven of de geconfigureerde tags op de Azure-VM moeten worden gekopieerd naar de bijbehorende implementatiegroepagent.

Standaard worden alle Azure-tags gekopieerd met de volgende indeling: Key: Value. Voorbeeld: Een Role : Web Azure-tag wordt ongewijzigd gekopieerd naar de agentmachine.

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

runAgentServiceAsUser - Agentservice uitvoeren als gebruiker
boolean. Optioneel. Gebruik wanneer enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Standaardwaarde: false.

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

De standaardgebruiker bevindt zich NT AUTHORITY\\SYSTEM in Windows en root linux.

userName - Gebruikersnaam
string. Vereist wanneer enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group.

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 op username.

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

password - Wachtwoord
string. Optioneel. Gebruik wanneer enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group.

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 in build- of release-pijplijnen zijn gedefinieerd als $(passwordVariable). U kunt de variabele markeren als secret om deze te beveiligen.

Voor Linux-VM's is een wachtwoord niet vereist en wordt het genegeerd.

outputVariable - VM-details voor WinRM
string. Optioneel. Gebruik wanneer enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Group.

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

Alleen geldig als de geselecteerde actie , Updateof SelectisCreate.

deploymentName - Implementatienaam
string. Optioneel. Gebruik wanneer action = Create Or Update Resource Group.

Hiermee geeft u de naam van de resourcegroepimplementatie te maken.

deploymentOutputs - Implementatie-uitvoer
string. Optioneel. Gebruik 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 in onderdrukkingsparameters openen
boolean. Optioneel. Gebruik wanneer action = Create Or Update Resource Group. Standaardwaarde: false.

Hiermee voegt u de service-principal-id en sleutel toe van het Azure-eindpunt dat is gekozen als de uitvoeringsomgeving van het script. De variabelen en $servicePrincipalKey kunnen zich in onderdrukkingsparameters $servicePrincipalId bevinden, zoals -key $servicePrincipalKey.

useWithoutJSON - Gebruik afzonderlijke uitvoerwaarden zonder JSON. Stringify toegepast
boolean. Optioneel. Gebruik wanneer action = Create Or Update Resource Group. Standaardwaarde: false.

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

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Besturingsopties en algemene taakeigenschappen voor 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 die zich bevinden 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' is nu gewijzigd in '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.
  • Geen ondersteuning voor PowerShell-syntaxis omdat de taak nu node.js is. Zorg ervoor dat de hoofdlettergevoeligheid van de parameternamen overeenkomen wanneer u de sjabloonparameters overschrijft. Verwijder ook de PowerShell-cmdlets zoals ConvertTo-SecureString wanneer u migreert van versie 1.0 naar versie 2.0.

Problemen oplossen

Fout: Interne serverfout

Deze problemen zijn meestal tijdelijk van aard. Er zijn verschillende redenen voor dat dit kan gebeuren:

• Een van de Azure-services die u probeert te implementeren, ondergaat onderhoud in de regio waarin u wilt implementeren. Houd een oogje in het oog https://status.azure.com/ om downtime van Azure-services te controleren.
• De Azure Pipelines-service zelf wordt onderhouden. Houd uitvaltijd in de gaten https://status.dev.azure.com/ .

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 heeft gekozen.

Fout: Time-out

Time-outproblemen kunnen van twee locaties afkomstig zijn:

• Azure Pipelines-agent
• Portal-implementatie

U kunt bepalen of de time-out afkomstig is van de portal door te controleren op de koppeling naar de portalimplementatie die in de taaklogboeken wordt weergegeven. Als er geen koppeling is, dan wordt dit waarschijnlijk veroorzaakt door 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 portal-implementatie.

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

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

Warning: Failed to download the file from template path.

Voor deze functie moeten CORS-regels zijn ingeschakeld bij de bron. Als sjablonen zich in Azure Storage Blob bevinden, dan raadpleegt u Cross-origin-ondersteuning voor het delen van resources om CORS in te schakelen.

Zorg er naast het inschakelen van CORS ook 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 timeoutInMinutes als sleutel in de YAML in te stellen op 0. Raadpleeg Taken opgeven in uw pijplijn voor meer informatie.

Portal-implementatie

Bekijk dit document over hoe u kunt vaststellen of de fout afkomstig is van de 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, dan wordt ervan uitgegaan dat de waarde 60 minuten is. 0 zorgt ervoor dat de implementatie zo lang mogelijk wordt uitgevoerd om te slagen.

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

Fout: De validatie van de ARM-sjabloon (Azure Resource Manager) is mislukt

Dat probleem treedt voornamelijk op vanwege een ongeldige parameter in de ARM-sjabloon, zoals een niet-ondersteunde SKU of regio. Controleer het foutbericht als de validatie mislukt. Dit moet verwijzen naar de ongeldige resource en parameter.

Dat probleem kan ook optreden vanwege tekenreeksen met meerdere regels. Momenteel biedt de Azure-implementatietaak voor resourcegroepen geen ondersteuning voor tekenreeksen met meerdere regels in een ARM-sjabloon of parameter-JSON-bestand.

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

Vereisten

Vereiste	Beschrijving
Pijplijntypen	YAML, klassieke build, klassieke release
Wordt uitgevoerd op	Agent, DeploymentGroup
Eisen	Geen
Functies	Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen	Alle
Instelbare variabelen	Alle
Agentversie	2.119.1 of hoger
Taakcategorie	Implementeren