AzureResourceManagerTemplateDeployment@3 - Attività distribuzione di modelli di Resource Manager v3

Usare questa attività per distribuire un modello di Azure Resource Manager (ARM) in tutti gli ambiti di distribuzione.

Sintassi

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

Ingressi

deploymentScope - ambito di distribuzione
string. Obbligatorio. Valori consentiti: Management Group, Subscription, Resource Group. Valore predefinito: Resource Group.

Ambito della distribuzione. Altre informazioni sugli ambiti di distribuzione .

azureResourceManagerConnection - di connessione di Azure Resource Manager
Alias di input: ConnectedServiceName. string. Obbligatorio.

Specifica la connessione al servizio Azure Resource Manager con accesso all'ambito di distribuzione selezionato.

subscriptionId - sottoscrizione
Alias di input: subscriptionName. string. Obbligatorio quando deploymentScope != Management Group.

Specifica la sottoscrizione di Azure.

Importante

Il valore specificato deve essere l'ID sottoscrizione e non il nome della sottoscrizione.

action - 'azione
string. Obbligatorio quando deploymentScope = Resource Group. Valori consentiti: Create Or Update Resource Group, DeleteRG (Elimina gruppo di risorse). Valore predefinito: Create Or Update Resource Group.

Azione da eseguire sulle risorse di Azure o sul gruppo di risorse.

resourceGroupName - gruppo di risorse
string. Obbligatorio quando deploymentScope = Resource Group.

Fornisce il nome di un gruppo di risorse.

location - percorso
string. Obbligatorio quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Ambiti di distribuzione del gruppo di risorse: posizione in cui distribuire il gruppo di risorse. Se il gruppo di risorse esiste già nella sottoscrizione di Azure, questo valore verrà ignorato. Altri ambiti di distribuzione: percorso in cui archiviare i metadati di distribuzione.

templateLocation - percorso modello
string. Obbligatorio quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valori consentiti: Linked artifact, URL of the file. Valore predefinito: Linked artifact.

Percorso del modello e dei file JSON dei parametri. Scegliere artefatto collegato se i file fanno parte degli artefatti di codice/compilazione collegati. Per gli artefatti collegati, è anche possibile specificare il percorso di un file Bicep. Scegliere URL del file se i file JSON si trovano in qualsiasi URL http/https accessibile pubblicamente. Per usare un file archiviato in un account di archiviazione privato, recuperare e includere il token di firma di accesso condiviso nell'URL del modello. Esempio: <blob_storage_url>/template.json?. Per caricare un file di parametri in un account di archiviazione e generare un token di firma di accesso condiviso, è possibile usare 'attività di copia file di Azure o seguire i passaggi usando PowerShell o dell'interfaccia della riga di comando di Azure.

collegamento csmFileLink - modello
string. Obbligatorio quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Specifica l'URL del file modello. URL di esempio: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Per distribuire un modello archiviato in un account di archiviazione privato, recuperare e includere il token di firma di accesso condiviso (SAS) nell'URL del modello. Esempio: <blob_storage_url>/template.json?<SAStoken>. Per caricare un file modello (o un modello collegato) in un account di archiviazione e generare un token di firma di accesso condiviso, usare l'attività di copia di file di Azure o seguire i passaggi usando PowerShell o l'interfaccia della riga di comando di Azure.

Per visualizzare i parametri del modello in una griglia, fare clic su ... accanto alla casella di testo Sostituisci parametri del modello di override. Questa funzionalità richiede che le regole CORS siano abilitate nell'origine. Se i modelli si trovano in un BLOB di archiviazione di Azure, fare riferimento a condivisione di risorse tra le origini per abilitare CORS.

collegamento ai parametri csmParametersFileLink - modello
string. Opzionale. Usare quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Specifica l'URL del file di parametri. URL di esempio: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Per usare un file archiviato in un account di archiviazione privato, recuperare e includere il token di firma di accesso condiviso nell'URL del modello. Esempio: <blob_storage_url>/template.json?<SAStoken>. Per caricare un file modello (o un modello collegato) in un account di archiviazione e generare un token di firma di accesso condiviso, usare l'attività di copia di file di Azure o seguire i passaggi usando PowerShell o l'interfaccia della riga di comando di Azure.

Per visualizzare i parametri del modello in una griglia, fare clic su ... accanto alla casella di testo Sostituisci parametri modello. Questa funzionalità richiede che le regole CORS siano abilitate nell'origine. Se i modelli si trovano in un BLOB di archiviazione di Azure, fare riferimento a condivisione di risorse tra le origini per abilitare CORS.

csmFile - modello
string. Obbligatorio quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Specifica il percorso o un modello che punta al modello di Azure Resource Manager. Altre informazioni sui modelli di Azure Resource Manager . Per iniziare immediatamente, usare questo modello di esempio. Supporta i file Bicep quando la versione dell'interfaccia della riga di comando di Azure > 2.20.0.

parametri modello di csmParametersFile -
string. Opzionale. Usare quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Specificare il percorso o un criterio che punta al file dei parametri per il modello di Azure Resource Manager. Supporta file di Bicep Param quando la versione dell'interfaccia della riga di comando di Azure > 2.47.0.

overrideParameters - eseguire l'override dei parametri del modello
string. Opzionale. Usare quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Specifica i parametri del modello di cui eseguire l'override.

Per visualizzare i parametri del modello in una griglia, fare clic su ... accanto alla casella di testo Sostituisci parametri. Questa funzionalità richiede che le regole CORS siano abilitate nell'origine. Se i modelli si trovano nel BLOB di archiviazione di Azure, fare riferimento a questa stringa per abilitare CORS o digitare i parametri del modello di cui eseguire l'override nella casella di testo.

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

Se il valore del parametro contiene più parole, racchiudere le parole tra virgolette, anche se si passa il valore usando le variabili. Ad esempio, -name "parameter value" -name2 "$(var)".

Se il parametro di cui si esegue l'override è un oggetto, è possibile fornire un valore utilizzando un oggetto JSON con stringhe a riga singola. Ad esempio, per eseguire l'override di un parametro denominato settings con due proprietà, è possibile utilizzare il formato seguente: -settings "{\"key1\": \"value1\", \"key2\": \"value2\"}".

deploymentMode - modalità di distribuzione
string. Obbligatorio quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valori consentiti: Incremental, Complete, Validation (solo convalida). Valore predefinito: Incremental.

La modalità Incremental gestisce le distribuzioni come aggiornamenti incrementali al gruppo di risorse. Lascia invariate le risorse presenti nel gruppo di risorse, ma non specificate nel modello.

Complete modalità elimina le risorse non incluse nel modello. La modalità completa richiede relativamente più tempo rispetto alla modalità incrementale. Se si verifica il timeout dell'attività, è consigliabile aumentare il timeout o passare alla modalità di Incremental.

Avvertimento

La modalità completa eliminerà tutte le risorse esistenti nel gruppo di risorse non specificate nel modello. Verificare se il gruppo di risorse in cui si esegue la distribuzione non contiene risorse necessarie non specificate nel modello. Validate modalità consente di trovare problemi con il modello prima di creare risorse effettive.

Nota

La modalità Validate crea sempre un gruppo di risorse, anche se non vengono distribuite risorse. Altre informazioni sulle modalità di distribuzione .

deploymentName - Nome distribuzione
string. Opzionale. Usare quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Specifica il nome della distribuzione del gruppo di risorse da creare.

deploymentOutputs - output della distribuzione
string. Opzionale. Usare quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Fornisce un nome per la variabile di output, che contiene la sezione output dell'oggetto di distribuzione corrente in formato stringa. È possibile usare il cmdlet di PowerShell ConvertFrom-Json per analizzare l'oggetto JSON e accedere ai singoli valori di output. Altre informazioni sugli output della distribuzione .

addSpnToEnvironment - dettagli dell'entità servizio di Access nei parametri di override
boolean. Opzionale. Usare quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valore predefinito: false.

Aggiunge l'ID dell'entità servizio e la chiave dell'endpoint di Azure scelto come ambiente di esecuzione dello script. Le variabili $servicePrincipalId e $servicePrincipalKey possono trovarsi in parametri di override, ad esempio -key $servicePrincipalKey.

useWithoutJSON - Usare singoli valori di output senza JSON. Stringify applied
boolean. Opzionale. Usare quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valore predefinito: false.

I singoli valori di output vengono convertiti tramite JSON. Stringify per impostazione predefinita. Se si vogliono usare i valori di output così come sono senza convertirli tramite JSON. Stringify, abilitare questa opzione. Per altri dettagli, vedere questo.

Opzioni di controllo attività

Tutte le attività hanno opzioni di controllo oltre ai relativi input di attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

Nessuno.

Osservazioni

Nota

Questa attività supporta i file Bicep quando la versione dell'interfaccia della riga di comando di Azure > 2.20.0.

• Aggiunta del supporto per la distribuzione in tutti gli ambiti di distribuzione.
  • Rimosse tutte le azioni correlate alla macchina virtuale.

Fabbisogno

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Viene eseguito in	Agente, DeploymentGroup
richieste	Nessuno
funzionalità di	Questa attività non soddisfa alcuna richiesta di attività successive nel processo.
restrizioni dei comandi	Qualunque
variabili impostabili	Qualunque
Versione dell'agente	2.119.1 o versione successiva
Categoria attività	Schierare