AzureResourceManagerTemplateDeployment@3 - Attività distribuzione modello arm 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 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.

Input

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 - Connessione di Azure Resource Manager
Alias di input: ConnectedServiceName. string. Obbligatorio.

Specifica la connessione al servizio Resource Manager di Azure 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 nelle risorse di Azure o nel gruppo di risorse.

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

Fornisce il nome di un gruppo di risorse.

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

Ambiti di distribuzione del gruppo di risorse: percorso per 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 per 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 l'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 (SAS) 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 l'attività di copia file di Azure o seguire i passaggi tramite PowerShell o l'interfaccia della riga di comando di Azure.

csmFileLink - Collegamento modello
string. Obbligatorio quando templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != 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 firma di accesso condiviso (SAS) nell'URL del modello. Esempio: <blob_storage_url>/template.json?<SAStoken>. Per caricare un file di modello (o un modello collegato) in un account di archiviazione e generare un token di firma di accesso condiviso, usare l'attività di copia file di Azure o seguire la procedura con 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 parametri del modello di override. Questa funzionalità richiede che per l'origine le regole CORS siano abilitate. Se i modelli si trovano in un BLOB di archiviazione di Azure, vedere Condivisione risorse tra origini per abilitare CORS.

csmParametersFileLink - Collegamento parametri modello
string. facoltativo. Usare quando templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != 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 (SAS) nell'URL del modello. Esempio: <blob_storage_url>/template.json?<SAStoken>. Per caricare un file di modello (o un modello collegato) in un account di archiviazione e generare un token di firma di accesso condiviso, usare l'attività di copia file di Azure o seguire la procedura con 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 Override dei parametri del modello. Questa funzionalità richiede che per l'origine le regole CORS siano abilitate. Se i modelli si trovano in un BLOB di archiviazione di Azure, vedere Condivisione risorse tra origini per abilitare CORS.

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

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

csmParametersFile - Parametri modello
string. facoltativo. Usare quando templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group.

Specificare il percorso o un punto di modello per il file di parametri per il modello di Resource Manager di Azure. Supporta i file Bicep Param quando l'interfaccia della riga di comando di Azure versione > 2.47.0.

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

Specifica i parametri del modello da eseguire l'override.

Per visualizzare i parametri del modello in una griglia, fare clic su ... accanto alla casella di testo Override Parametri. Questa funzionalità richiede che per l'origine le regole CORS siano abilitate. 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 da sostituire nella casella di testo.

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

Se il valore del parametro ha più parole, racchiudere le parole nelle 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 || deploymentScope != Resource Group. Valori consentiti: Incremental, , CompleteValidation (solo convalida). Valore predefinito: Incremental.

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

Complete mode elimina le risorse che non sono nel modello. La modalità completa richiede relativamente più tempo rispetto alla modalità incrementale. Se l'attività è in timeout, valutare l'aumento del timeout o la modifica alla Incremental modalità.

Avviso

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 la modalità consente di trovare problemi con il modello prima di creare risorse effettive.

Nota

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

deploymentName - Nome distribuzione
string. facoltativo. 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. facoltativo. Usare quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

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

addSpnToEnvironment - Accedere ai dettagli dell'entità servizio nei parametri di override
boolean. facoltativo. 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 essere incluse nei parametri di override, ad esempio -key $servicePrincipalKey.

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

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

Opzioni di controllo delle attività

Tutte le attività dispongono di opzioni di controllo oltre ai relativi input 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 l'interfaccia della riga di comando di Azure versione > 2.20.0.

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

Requisiti

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Viene eseguito in	Agente, DeploymentGroup
Richieste	Nessuno
Capabilities	Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi	Qualsiasi
Variabili impostabili	Qualsiasi
Versione agente	2.119.1 o versione successiva
Categoria attività	Distribuire