AzureResourceManagerTemplateDeployment@3 - ARM-sjabloonimplementatie v3-taak

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

Syntaxis

# 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.

Ingangen

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

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.

Resourcegroepimplementatiebereiken: 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 sjabloon en de JSON-bestanden Parameters. Kies Gekoppeld artefact als de bestanden deel uitmaken van de gekoppelde code/buildartefacten. Voor gekoppelde artefacten kunt u ook het pad naar een Bicep-bestand opgeven. Kies 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 in de URL van de sjabloon. Voorbeeld: <blob_storage_url>/template.json?. Als u een parameterbestand wilt uploaden naar een opslagaccount en een SAS-token wilt genereren, kunt u Azure-taak voor het kopiëren van bestanden of de stappen volgen met behulp van PowerShell- of Azure CLI-.

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

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 Cross-Origin Resource Sharing- om CORS in te schakelen.

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

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>. 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 overschrijven. Voor deze functie moeten 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 (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

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. Ondersteunt Bicep-bestanden wanneer de Azure CLI-versie > 2.20.0.

csmParametersFile - sjabloonparameters
string. Facultatief. Gebruiken wanneer (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

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

overrideParameters - sjabloonparameters overschrijven
string. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group || deploymentScope != 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 overschrijven. 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 || 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 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.

deploymentName - implementatienaam
string. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group || deploymentScope != 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 || 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 van Access bij het overschrijven van parameters
boolean. Facultatief. Gebruiken wanneer action = Create Or Update Resource Group || deploymentScope != 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 || deploymentScope != 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

Notitie

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

• Er is ondersteuning toegevoegd voor implementatie in alle implementatiebereiken.
  • Alle vm-gerelateerde acties zijn verwijderd.

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