AzureResourceManagerTemplateDeployment@3 - Arm-sjabloonimplementatie v3-taak

Gebruik deze taak om een ARM-sjabloon (Azure Resource Manager) te implementeren in alle implementatiebereiken.

Syntax

# 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 templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. 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.

Invoerwaarden

deploymentScope - Implementatiebereik
string. Vereist. Toegestane waarden: Management Group, Subscription, Resource Group. Standaardwaarde: Resource Group.

Het bereik van de implementatie. Meer informatie over implementatiebereiken.

azureResourceManagerConnection - Azure Resource Manager-verbinding
Invoeralias: ConnectedServiceName. string. Vereist.

Hiermee geeft u de Azure Resource Manager serviceverbinding met toegang tot het geselecteerde implementatiebereik.

subscriptionId - Abonnement
Invoeralias: subscriptionName. string. Vereist wanneer deploymentScope != Management Group.

Hiermee geeft u het Azure-abonnement op.

Belangrijk

De opgegeven waarde moet de abonnements-id zijn en niet de naam van het abonnement.

action - Actie
string. Vereist wanneer deploymentScope = Resource Group. Toegestane waarden: Create Or Update Resource Group, 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 wanneer deploymentScope = Resource Group.

Geeft de naam van een resourcegroep op.

location - Locatie
string. Vereist wanneer action = Create Or Update Resource Group || deploymentScope != Resource Group.

Implementatiebereiken van resourcegroepen: de locatie voor het implementeren van de resourcegroep. Als de resourcegroep al bestaat in het Azure-abonnement, wordt deze waarde genegeerd. Andere implementatiebereiken: de locatie voor het opslaan van metagegevens van de implementatie.

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

De locatie van de JSON-bestanden Sjabloon en Parameters. Kies Gekoppeld artefact als de bestanden deel uitmaken van de gekoppelde code/build-artefacten. Voor gekoppelde artefacten kunt u ook het pad naar een Bicep-bestand opgeven. Kies de URL van het bestand als de JSON-bestanden zich bevinden op openbaar toegankelijke http/https-URL's. 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. Bijvoorbeeld: <blob_storage_url>/template.json?. 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 Behulp van PowerShell of Azure CLI.

csmFileLink - Sjabloonkoppeling
string. Vereist wanneer templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != 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. Bijvoorbeeld: <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 Storage-blob bevinden, raadpleegt u Cross-Origin Resource Sharing om CORS in te schakelen.

csmParametersFileLink - Koppeling sjabloonparameters
string. Optioneel. Gebruik wanneer templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != 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. Bijvoorbeeld: <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 Storage-blob bevinden, raadpleegt u Cross-Origin Resource Sharing om CORS in te schakelen.

csmFile - Sjabloon
string. Vereist wanneer templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != 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. Ondersteunt Bicep-bestanden wanneer de Azure CLI versie > 2.20.0.

csmParametersFile - Sjabloonparameters
string. Optioneel. Gebruik wanneer templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group.

Geef het pad of een patroon op dat wijst voor het parameterbestand voor de Sjabloon Azure Resource Manager. Ondersteunt Bicep Param-bestanden wanneer de Azure CLI versie > 2.47.0.

overrideParameters - Sjabloonparameters overschrijven
string. Optioneel. Gebruik wanneer action = Create Or Update Resource Group || deploymentScope != 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 negeren. 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 || deploymentScope != 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.

deploymentName - Implementatienaam
string. Optioneel. Gebruik wanneer action = Create Or Update Resource Group || deploymentScope != 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 || deploymentScope != Resource Group.

Biedt een naam voor de variabele voor de uitvoervariabele, die de uitvoersectie van het huidige implementatieobject in tekenreeksindeling bevat. U kunt de ConvertFrom-Json PowerShell-cmdlet gebruiken om het JSON-object te parseren en toegang te krijgen tot de afzonderlijke uitvoerwaarden. Meer informatie over implementatie-uitvoer.

addSpnToEnvironment - Details van service-principal in onderdrukkingsparameters openen
boolean. Optioneel. Gebruik wanneer action = Create Or Update Resource Group || deploymentScope != 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 || deploymentScope != 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

Notitie

Deze taak ondersteunt Bicep-bestanden wanneer de Azure CLI versie > 2.20.0 is.

• Ondersteuning toegevoegd voor implementatie in alle implementatiebereiken.
  • Alle vm-gerelateerde acties zijn verwijderd.

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