AzureResourceGroupDeployment@2 - Attività distribuzione del gruppo di risorse di Azure v2

Distribuire un modello di Azure Resource Manager (ARM) in un gruppo di risorse e gestire le macchine virtuali.

Sintassi

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

Ingressi

azureSubscription - sottoscrizione di Azure
Alias di input: ConnectedServiceName. string. Obbligatorio.

Seleziona la connessione al servizio che contiene una sottoscrizione di Azure per la distribuzione.

action - 'azione
string. Obbligatorio. Valori consentiti: Create Or Update Resource Group, Select Resource Group (configurare le opzioni di distribuzione delle macchine virtuali), Start (Avvia macchine virtuali), Stop (Arresta macchine virtuali), StopWithDeallocate (Arresta e dealloca macchine virtuali), Restart (Riavvia macchine virtuali), Delete (Elimina macchine virtuali), 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.

Fornisce il nome del gruppo di risorse.

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

Percorso in cui distribuire il gruppo di risorse. Se il gruppo di risorse esiste già nella sottoscrizione, questo valore verrà ignorato.

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

Selezionare elemento collegato o URL del file.

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

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, vedere Informazioni sulle richieste CORS per abilitare CORS.

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

Specifica l'URL del file di parametri. Esempio: https://raw.githubusercontent.com/Azure/...

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 di parametri in un account di archiviazione e generare un token di firma di accesso condiviso, è possibile usare 'attività di copia di file di Azure o seguire i passaggi usando PowerShell o dell'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, vedere Informazioni sulle richieste CORS per abilitare CORS.

csmFile - modello
string. Obbligatorio quando templateLocation = Linked artifact && action = Create Or Update Resource Group.

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.

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

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 di parametri in un account di archiviazione e generare un token di firma di accesso condiviso, usare l'attività di copia del file di Azure o seguire la procedura usando PowerShell o dell'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, vedere Informazioni sulle richieste CORS per abilitare CORS.

overrideParameters - eseguire l'override dei parametri del modello
string. Opzionale. Usare quando action = Create Or Update 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 Override parameters (Parametri di sostituzione). 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)". Per eseguire l'override dei parametri del tipo di oggetto, usare oggetti JSON stringati. Ad esempio, -options ["option1"] -map {"key1": "value1" }.

deploymentMode - modalità di distribuzione
string. Obbligatorio quando action = Create Or Update 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 .

enableDeploymentPrerequisites - Abilitare i prerequisiti
string. Opzionale. Usare quando action = Create Or Update Resource Group || action = Select Resource Group. Valori consentiti: None, ConfigureVMwithWinRM (Configura con l'agente WinRM), ConfigureVMWithDGAgent (Configura con l'agente del gruppo di distribuzione). Valore predefinito: None.

Applicabile solo quando il gruppo di risorse contiene macchine virtuali.

Se si sceglie l'opzione Gruppo di distribuzione, l'agente del gruppo di distribuzione viene configurato in ognuna delle macchine virtuali.

Se si seleziona l'opzione WinRM, il listener gestione remota Windows (WinRM) viene configurato sul protocollo HTTPS sulla porta 5986 usando un certificato autofirmato. Questa configurazione è necessaria per eseguire l'operazione di distribuzione nei computer Azure. Se le macchine virtuali di destinazione sono supportate da un servizio di bilanciamento del carico, verificare che le regole NAT in ingresso siano configurate per la porta di destinazione (5986).

teamServicesConnection - connessione al servizio Azure Pipelines
Alias di input: deploymentGroupEndpoint. string. Obbligatorio quando (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Specifica la connessione al servizio per connettersi a un'organizzazione o a una raccolta di Azure DevOps per la registrazione dell'agente.

È possibile creare una connessione al servizio usando +New e quindi selezionare Token-based authentication. È necessario un token di accesso personale per configurare una connessione al servizio. Fare clic su Manage per aggiornare i dettagli della connessione al servizio.

teamProject - progetto team
Alias di input: project. string. Obbligatorio quando (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Specifica il progetto team che definisce il gruppo di distribuzione.

del gruppo di distribuzione deploymentGroupName -
string. Obbligatorio quando (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Specifica il gruppo di distribuzione in cui verranno registrati gli agenti. Altre informazioni sui gruppi di distribuzione .

copyAzureVMTags - Copiare i tag delle macchine virtuali di Azure in agenti
boolean. Opzionale. Usare quando (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Valore predefinito: true.

Sceglie se i tag configurati nella macchina virtuale di Azure devono essere copiati nell'agente del gruppo di distribuzione corrispondente.

Per impostazione predefinita, tutti i tag di Azure vengono copiati nel formato seguente: Key: Value. Esempio: un tag di Azure Role : Web viene copiato as-is nel computer dell'agente.

Altre informazioni su uso di tag per le risorse di Azure.

runAgentServiceAsUser - Eseguire il servizio agente come utente
boolean. Opzionale. Usare quando (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Valore predefinito: false.

Esegue il servizio agente come utente diverso dall'utente predefinito se il valore è impostato su true.

L'utente predefinito è NT AUTHORITY\\SYSTEM in Windows e root in Linux.

userName - nome utente
string. Obbligatorio quando enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true.

Nome utente per eseguire il servizio agente nelle macchine virtuali.

Per gli utenti di dominio, specificare i valori come domain\username o username@domain.com. Per gli utenti locali, specificare username.

Si presuppone che lo stesso utente di dominio o un utente locale con lo stesso nome, rispettivamente, sia presente in tutte le macchine virtuali del gruppo di risorse.

password - password
string. Opzionale. Usare quando enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true.

Password per l'utente per eseguire il servizio agente nelle macchine virtuali Windows.

Si presuppone che la password sia la stessa per l'utente specificato in tutte le macchine virtuali.

Può accettare variabili definite nelle pipeline di compilazione o versione come $(passwordVariable). È possibile contrassegnare la variabile come secret per proteggerla.

Per le macchine virtuali Linux, una password non è necessaria e verrà ignorata.

outputVariable - dettagli della macchina virtuale per WinRM
string. Opzionale. Usare quando (action = Create Or Update Resource Group || action = Select Resource Group) && (enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None).

Obbligatorio quando è selezionato un gruppo di risorse esistente. Fornisce un nome per la variabile del gruppo di risorse. La variabile può essere usata come $(variableName) per fare riferimento al gruppo di risorse nelle attività successive, ad esempio in PowerShell nelle macchine di destinazione per la distribuzione delle applicazioni.

Valido solo quando l'azione selezionata è Create, Updateo Select.

deploymentName - Nome distribuzione
string. Opzionale. Usare quando action = Create Or Update 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.

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

addSpnToEnvironment - dettagli dell'entità servizio di Access nei parametri di override
boolean. Opzionale. Usare quando action = Create Or Update 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. 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

È disponibile una nuova versione di questa attività in AzureResourceManagerTemplateDeployment@3 - Distribuzione di modelli di Resource Manager v3 attività.

Novità dell'attività versione 2

• Funziona con agenti multipiattaforma (Linux, macOS o Windows)
• Supporta jsON modello che si trovano in qualsiasi URL http/https accessibile pubblicamente.
• Esperienza utente avanzata per i parametri di override che ora possono essere visualizzati/modificati in una griglia.
• Mapping delle regole NAT per le macchine virtuali supportate da un servizio di bilanciamento del carico.
• Il campo "Gruppo di risorse" viene ora rinominato come "Dettagli macchina virtuale per WinRM" ed è incluso nella sezione "Opzioni di distribuzione avanzate per le macchine virtuali".
• Limitazioni:
  • Nessun supporto per le sottoscrizioni classiche. Sono supportate solo le sottoscrizioni arm.
  • Nessun supporto per la sintassi di PowerShell perché l'attività è ora basata su node.js. Assicurarsi che la distinzione tra maiuscole e minuscole dei nomi dei parametri corrisponda quando si esegue l'override dei parametri del modello. Rimuovere anche i cmdlet di PowerShell come "ConvertTo-SecureString" quando si esegue la migrazione dalla versione 1.0 alla versione 2.0.

Risoluzione dei problemi

Errore: Errore interno del server

Questi problemi sono per lo più temporanei. Esistono diversi motivi per cui potrebbe verificarsi:

• Uno dei servizi di Azure in cui si sta tentando di distribuire è in fase di manutenzione nell'area in cui si sta tentando di eseguire la distribuzione. Tenere d'occhio https://status.azure.com/ per controllare i tempi di inattività dei servizi di Azure.
• Il servizio Azure Pipelines sta passando attraverso la manutenzione. Tenere d'occhio https://status.dev.azure.com/ per i tempi di inattività.

Tuttavia, sono state illustrate alcune istanze in cui si tratta di un errore nel modello di Resource Manager, ad esempio il servizio di Azure che si sta tentando di distribuire non supporta l'area scelta per la risorsa.

Errore: Timeout

I problemi di timeout possono provenire da due posizioni:

• Agente di Azure Pipelines
• Distribuzione del portale

È possibile identificare se il timeout proviene dal portale, controllando il collegamento alla distribuzione del portale che si trova nei log attività. Se non è presente alcun collegamento, è probabile che ciò sia dovuto all'agente di Azure Pipelines. Se è presente un collegamento, seguire il collegamento per verificare se è presente un timeout che si è verificato nella distribuzione del portale.

Errore: regole CORS da abilitare durante l'override dei parametri

Se viene fatto riferimento al file modello da un BLOB, durante l'override dei parametri nella pipeline, è possibile che venga visualizzato il messaggio di avviso seguente:

Warning: Failed to download the file from template path.

Questa funzionalità richiede che le regole CORS siano abilitate nell'origine. Se i modelli si trovano nel BLOB di archiviazione di Azure, vedere supporto per la condivisione di risorse tra le origini per abilitare CORS.

Oltre ad abilitare CORS, assicurarsi che il token di firma di accesso condiviso specificato nel collegamento del modello sia "srt-sco". Questo token è necessario per scaricare il file e procedere.

Agente di Azure Pipelines

Se il problema proviene dall'agente di Azure Pipelines, è possibile aumentare il timeout impostando timeoutInMinutes come chiave in YAML su 0. Per altre informazioni, vedere Specificare i processi nella pipeline.

Distribuzione del portale

Vedere questo documento su come identificare se l'errore è stato generato dal portale di Azure: Visualizzare la cronologia di distribuzione con Azure Resource Manager.

In caso di distribuzione del portale, provare a impostare "timeoutInMinutes" nel modello arm su "0". Se non specificato, il valore assunto è 60 minuti. 0 assicura che la distribuzione venga eseguita per tutto il tempo possibile.

Ciò potrebbe verificarsi anche a causa di problemi temporanei nel sistema. Tenere d'occhio https://status.dev.azure.com/ per verificare se si verifica un tempo di inattività nel servizio Azure Pipelines.

Errore: Il modello di Azure Resource Manager (ARM) non è riuscito a convalidare

Questo problema si verifica principalmente a causa di un parametro non valido nel modello di Resource Manager, ad esempio uno SKU o un'area non supportata. Se la convalida non riesce, controllare il messaggio di errore. Deve puntare alla risorsa e al parametro non valido.

Questo problema può verificarsi anche a causa di stringhe su più righe. Attualmente, l'attività Distribuzione gruppo di risorse di Azure non supporta stringhe multilinea in un modello arm o in un file JSON dei parametri.

Vedere anche questo articolo relativo alla struttura e alla sintassi dei modelli arm: Comprendere la struttura e la sintassi dei modelli arm.

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