AzureResourceManagerTemplateDeployment@3 – ARM-malldistribution v3-uppgift

Använd den här uppgiften för att distribuera en ARM-mall (Azure Resource Manager) till alla distributionsomfång.

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

Ingångar

deploymentScope - distributionsomfång
string. Krävs. Tillåtna värden: Management Group, Subscription, Resource Group. Standardvärde: Resource Group.

Omfånget för distributionen. Läs mer om distributionsomfång.

azureResourceManagerConnection - Azure Resource Manager-anslutning
Indataalias: ConnectedServiceName. string. Krävs.

Anger Azure Resource Manager-tjänstanslutningen med åtkomst till det valda distributionsomfånget.

subscriptionId - Prenumeration
Indataalias: subscriptionName. string. Krävs när deploymentScope != Management Group.

Anger Azure-prenumerationen.

Viktig

Det angivna värdet måste vara prenumerations-ID:t och inte prenumerationsnamnet.

action - åtgärd
string. Krävs när deploymentScope = Resource Group. Tillåtna värden: Create Or Update Resource Group, DeleteRG (Ta bort resursgrupp). Standardvärde: Create Or Update Resource Group.

Åtgärden som ska utföras på Azure-resurser eller resursgruppen.

resourceGroupName - resursgrupp
string. Krävs när deploymentScope = Resource Group.

Anger namnet på en resursgrupp.

location - plats
string. Krävs när action = Create Or Update Resource Group || deploymentScope != Resource Group.

Omfång för resursgruppsdistribution: Platsen där resursgruppen ska distribueras. Om resursgruppen redan finns i Azure-prenumerationen ignoreras det här värdet. Andra distributionsomfång: Platsen där distributionsmetadata ska lagras.

templateLocation - mallplats
string. Krävs när action = Create Or Update Resource Group || deploymentScope != Resource Group. Tillåtna värden: Linked artifact, URL of the file. Standardvärde: Linked artifact.

Platsen för mallen och JSON-parametrarna. Välj länkad artefakt om filerna är en del av den länkade koden/kompileringsartefakterna. För länkade artefakter kan du också ange sökvägen till en Bicep-fil. Välj URL för filen om JSON-filerna finns på alla offentligt tillgängliga http/https-URL:er. Om du vill använda en fil som lagras i ett privat lagringskonto hämtar och inkluderar du SAS-token (signatur för delad åtkomst) i URL:en för mallen. Exempel: <blob_storage_url>/template.json?. Om du vill ladda upp en parameterfil till ett lagringskonto och generera en SAS-token kan du använda Azure-filkopieringsaktivitet eller följa stegen med PowerShell- eller Azure CLI-.

csmFileLink - malllänk
string. Krävs när (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Anger URL:en för mallfilen. En exempel-URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Om du vill distribuera en mall som lagras i ett privat lagringskonto hämtar och inkluderar du sas-token (signatur för delad åtkomst) i URL:en för mallen. Exempel: <blob_storage_url>/template.json?<SAStoken>. Om du vill ladda upp en mallfil (eller en länkad mall) till ett lagringskonto och generera en SAS-token använder du Azure-filkopiering uppgift eller följer stegen med PowerShell- eller Azure CLI-.

Om du vill visa mallparametrarna i ett rutnät klickar du på ... bredvid textrutan åsidosätt mallparametrar. Den här funktionen kräver att CORS-regler är aktiverade vid källan. Om mallarna finns i en Azure Storage-blob läser du Resursdelning mellan ursprung för att aktivera CORS.

csmParametersFileLink - länk för mallparametrar
string. Valfri. Använd när (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Anger URL:en för parameterfilen. En exempel-URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Om du vill använda en fil som lagras i ett privat lagringskonto hämtar och inkluderar du SAS-token (signatur för delad åtkomst) i URL:en för mallen. Exempel: <blob_storage_url>/template.json?<SAStoken>. Om du vill ladda upp en mallfil (eller en länkad mall) till ett lagringskonto och generera en SAS-token använder du Azure-filkopiering uppgift eller följer stegen med PowerShell- eller Azure CLI-.

Om du vill visa mallparametrarna i ett rutnät klickar du på ... bredvid textrutan Åsidosätt mallparametrar. Den här funktionen kräver att CORS-regler är aktiverade vid källan. Om mallarna finns i en Azure Storage-blob läser du Resursdelning mellan ursprung för att aktivera CORS.

csmFile - Mall
string. Krävs när (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Anger sökvägen eller ett mönster som pekar på Azure Resource Manager-mallen. Läs mer om Azure Resource Manager-mallar. Kom igång direkt genom att använda den här exempelmallen. Stöder Bicep-filer när Azure CLI-versionen > 2.20.0.

csmParametersFile - mallparametrar
string. Valfri. Använd när (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Ange sökvägen eller ett mönster som pekar på parameterfilen för Azure Resource Manager-mallen. Stöder Bicep Param--filer när Azure CLI-versionen > 2.47.0.

overrideParameters - åsidosätt mallparametrar
string. Valfri. Använd när action = Create Or Update Resource Group || deploymentScope != Resource Group.

Anger de mallparametrar som ska åsidosättas.

Om du vill visa mallparametrarna i ett rutnät klickar du på ... bredvid textrutan Åsidosättningsparametrar. Den här funktionen kräver att CORS-regler är aktiverade vid källan. Om mallarna finns i Azure Storage-bloben refererar du till den här strängen för att aktivera CORS eller skriver de mallparametrar som ska åsidosättas i textrutan.

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

Om parametervärdet har flera ord omger du orden med citattecken, även om du skickar värdet med hjälp av variabler. Till exempel -name "parameter value" -name2 "$(var)". Om du vill åsidosätta objekttypsparametrar använder du strängifierade JSON-objekt. Till exempel -options ["option1"] -map {"key1": "value1" }.

deploymentMode - distributionsläge
string. Krävs när action = Create Or Update Resource Group || deploymentScope != Resource Group. Tillåtna värden: Incremental, Complete, Validation (endast validering). Standardvärde: Incremental.

I Incremental-läget hanteras distributioner som inkrementella uppdateringar av resursgruppen. Den lämnar oförändrade resurser som finns i resursgruppen men som inte anges i mallen.

Complete läge tar bort resurser som inte finns i mallen. Slutfört läge tar relativt mer tid än inkrementellt läge. Om aktiviteten överskrider tidsgränsen kan du överväga att öka tidsgränsen eller ändra till Incremental läge.

Varning

Fullständigt läge tar bort alla befintliga resurser i resursgruppen som inte har angetts i mallen. Granska om resursgruppen som du distribuerar till inte innehåller några nödvändiga resurser som inte anges i mallen. Validate läge kan du hitta problem med mallen innan du skapar faktiska resurser.

Not

Validate-läget skapar alltid en resursgrupp, även om inga resurser distribueras. Läs mer om distributionslägen.

deploymentName - Distributionsnamn
string. Valfri. Använd när action = Create Or Update Resource Group || deploymentScope != Resource Group.

Anger namnet på resursgruppsdistributionen som ska skapas.

deploymentOutputs - Distributionsutdata
string. Valfri. Använd när action = Create Or Update Resource Group || deploymentScope != Resource Group.

Innehåller ett namn på variabeln för utdatavariabeln, som innehåller utdataavsnittet i det aktuella distributionsobjektet i strängformat. Du kan använda cmdleten ConvertFrom-Json PowerShell för att parsa JSON-objektet och komma åt de enskilda utdatavärdena. Läs mer om distributionsutdata.

addSpnToEnvironment - Information om tjänstens huvudnamn i åsidosättningsparametrar
boolean. Valfri. Använd när action = Create Or Update Resource Group || deploymentScope != Resource Group. Standardvärde: false.

Lägger till tjänstens huvudnamns-ID och nyckeln för den Azure-slutpunkt som valts som skriptets körningsmiljö. Variablerna $servicePrincipalId och $servicePrincipalKey kan finnas i åsidosättningsparametrar, till exempel -key $servicePrincipalKey.

useWithoutJSON - Använd enskilda utdatavärden utan JSON. Stringify tillämpad
boolean. Valfri. Använd när action = Create Or Update Resource Group || deploymentScope != Resource Group. Standardvärde: false.

Enskilda utdatavärden konverteras via JSON. Stringify som standard. Om du vill använda utdatavärdena som de är utan att konvertera dem via JSON. Stringify, aktivera det här alternativet. Mer information finns i den här.

Alternativ för aktivitetskontroll

Alla aktiviteter har kontrollalternativ utöver sina uppgiftsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Ingen.

Anmärkningar

Not

Den här uppgiften stöder Bicep-filer när Azure CLI-versionen > 2.20.0.

• Stöd har lagts till för distribution i alla distributionsomfång.
  • Alla vm-relaterade åtgärder har tagits bort.

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent, DeploymentGroup
kräver	Ingen
funktioner	Den här aktiviteten uppfyller inte några krav på efterföljande uppgifter i jobbet.
Kommandobegränsningar	Någon
variabler som kan	Någon
Agentversion	2.119.1 eller senare
Aktivitetskategori	Gruppera