AzureResourceManagerTemplateDeployment@3 - Tâche de déploiement de modèle ARM v3

Utilisez cette tâche pour déployer un modèle Azure Resource Manager (ARM) dans toutes les étendues de déploiement.

Syntaxe

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

Entrées

deploymentScope - étendue de déploiement
string. Obligatoire. Valeurs autorisées : Management Group, Subscription, Resource Group. Valeur par défaut : Resource Group.

Étendue du déploiement. En savoir plus sur les étendues de déploiement .

azureResourceManagerConnection - de connexion Azure Resource Manager
Alias d’entrée : ConnectedServiceName. string. Obligatoire.

Spécifie la connexion de service Azure Resource Manager avec accès à l’étendue de déploiement sélectionnée.

subscriptionId - abonnement
Alias d’entrée : subscriptionName. string. Obligatoire lorsque deploymentScope != Management Group.

Spécifie l’abonnement Azure.

Important

La valeur spécifiée doit être l’ID d’abonnement et non le nom de l’abonnement.

action - action
string. Obligatoire lorsque deploymentScope = Resource Group. Valeurs autorisées : Create Or Update Resource Group, DeleteRG (supprimer le groupe de ressources). Valeur par défaut : Create Or Update Resource Group.

Action à effectuer sur les ressources ou le groupe de ressources Azure.

resourceGroupName - groupe de ressources
string. Obligatoire lorsque deploymentScope = Resource Group.

Fournit le nom d’un groupe de ressources.

location - emplacement
string. Obligatoire lorsque action = Create Or Update Resource Group || deploymentScope != Resource Group.

Étendues de déploiement de groupe de ressources : emplacement où déployer le groupe de ressources. Si le groupe de ressources existe déjà dans l’abonnement Azure, cette valeur est ignorée. Autres étendues de déploiement : emplacement pour stocker les métadonnées de déploiement.

templateLocation - emplacement du modèle
string. Obligatoire lorsque action = Create Or Update Resource Group || deploymentScope != Resource Group. Valeurs autorisées : Linked artifact, URL of the file. Valeur par défaut : Linked artifact.

Emplacement du modèle et des fichiers JSON Parameters. Choisissez artefact lié si les fichiers font partie des artefacts de code/build liés. Pour les artefacts liés, vous pouvez également spécifier le chemin d’accès à un fichier Bicep. Choisissez URL du fichier si les fichiers JSON se trouvent à tout URL http/https accessible publiquement. Pour utiliser un fichier stocké dans un compte de stockage privé, récupérez et incluez le jeton de signature d’accès partagé (SAP) dans l’URL du modèle. Exemple : <blob_storage_url>/template.json?. Pour charger un fichier de paramètres dans un compte de stockage et générer un jeton SAP, vous pouvez utiliser tâche de copie de fichiers Azure ou suivre les étapes d'PowerShell ou Azure CLI.

csmFileLink - lien modèle
string. Obligatoire lorsque (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Spécifie l’URL du fichier de modèle. Exemple d’URL : https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Pour déployer un modèle stocké dans un compte de stockage privé, récupérez et incluez le jeton de signature d’accès partagé (SAP) dans l’URL du modèle. Exemple : <blob_storage_url>/template.json?<SAStoken>. Pour charger un fichier de modèle (ou un modèle lié) vers un compte de stockage et générer un jeton SAS, utilisez la tâche de copie de fichier Azure ou suivez les étapes à l’aide de PowerShell ou Azure CLI.

Pour afficher les paramètres du modèle dans une grille, cliquez sur ... en regard de la zone de texte des paramètres de modèle de remplacement. Cette fonctionnalité nécessite que les règles CORS soient activées sur la source. Si les modèles se trouvent dans un objet blob de stockage Azure, reportez-vous à partage de ressources inter-origines pour activer CORS.

lien des paramètres de modèle csmParametersFileLink -
string. Optionnel. Utilisez quand (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Spécifie l’URL du fichier de paramètres. Exemple d’URL : https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Pour utiliser un fichier stocké dans un compte de stockage privé, récupérez et incluez le jeton de signature d’accès partagé (SAP) dans l’URL du modèle. Exemple : <blob_storage_url>/template.json?<SAStoken>. Pour charger un fichier de modèle (ou un modèle lié) vers un compte de stockage et générer un jeton SAS, utilisez la tâche de copie de fichier Azure ou suivez les étapes à l’aide de PowerShell ou Azure CLI.

Pour afficher les paramètres du modèle dans une grille, cliquez sur ... en regard de la zone de texte Remplacer les paramètres du modèle. Cette fonctionnalité nécessite que les règles CORS soient activées sur la source. Si les modèles se trouvent dans un objet blob de stockage Azure, reportez-vous à partage de ressources inter-origines pour activer CORS.

de modèle csmFile -
string. Obligatoire lorsque (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Spécifie le chemin d’accès ou un modèle pointant vers le modèle Azure Resource Manager. En savoir plus sur modèles Azure Resource Manager. Pour commencer immédiatement, utilisez cet exemple de modèle. Prend en charge les fichiers Bicep lorsque la version d’Azure CLI > 2.20.0.

paramètres de modèle csmParametersFile -
string. Optionnel. Utilisez quand (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Spécifiez le chemin d’accès ou un pointage de modèle pour le fichier de paramètres pour le modèle Azure Resource Manager. Prend en charge fichiers Bicep Param lorsque la version d’Azure CLI > 2.47.0.

overrideParameters - remplacer les paramètres de modèle
string. Optionnel. Utilisez quand action = Create Or Update Resource Group || deploymentScope != Resource Group.

Spécifie les paramètres de modèle à remplacer.

Pour afficher les paramètres du modèle dans une grille, cliquez sur ... en regard de la zone de texte Remplacer les paramètres. Cette fonctionnalité nécessite que les règles CORS soient activées sur la source. Si les modèles se trouvent dans l’objet blob stockage Azure, référencez cette chaîne pour activer CORS ou tapez les paramètres de modèle à remplacer dans la zone de texte.

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

Si la valeur du paramètre a plusieurs mots, placez les mots entre guillemets, même si vous transmettez la valeur à l’aide de variables. Par exemple, -name "parameter value" -name2 "$(var)". Pour remplacer les paramètres de type d’objet, utilisez des objets JSON stringifiés. Par exemple, -options ["option1"] -map {"key1": "value1" }.

deploymentMode - mode déploiement
string. Obligatoire lorsque action = Create Or Update Resource Group || deploymentScope != Resource Group. Valeurs autorisées : Incremental, Complete, Validation (Validation uniquement). Valeur par défaut : Incremental.

Le mode Incremental gère les déploiements en tant que mises à jour incrémentielles du groupe de ressources. Elle laisse des ressources inchangées qui existent dans le groupe de ressources, mais qui ne sont pas spécifiées dans le modèle.

Complete mode supprime les ressources qui ne se trouvent pas dans votre modèle. Le mode complet prend relativement plus de temps que le mode incrémentiel. Si la tâche expire, envisagez d’augmenter le délai d’attente ou de passer au mode Incremental.

Avertissement

Le mode complet supprime toutes les ressources existantes dans le groupe de ressources qui ne sont pas spécifiées dans le modèle. Vérifiez si le groupe de ressources sur lequel vous effectuez le déploiement ne contient aucune ressource nécessaire qui ne sont pas spécifiées dans le modèle. Validate mode vous permet de trouver des problèmes avec le modèle avant de créer des ressources réelles.

Note

Le mode Validate crée toujours un groupe de ressources, même si aucune ressource n’est déployée. En savoir plus sur les modes de déploiement .

deploymentName - nom de déploiement
string. Optionnel. Utilisez quand action = Create Or Update Resource Group || deploymentScope != Resource Group.

Spécifie le nom du déploiement du groupe de ressources à créer.

sorties de déploiement deploymentOutputs -
string. Optionnel. Utilisez quand action = Create Or Update Resource Group || deploymentScope != Resource Group.

Fournit un nom pour la variable de sortie, qui contient la section sorties de l’objet de déploiement actuel au format chaîne. Vous pouvez utiliser l’applet de commande PowerShell ConvertFrom-Json pour analyser l’objet JSON et accéder aux valeurs de sortie individuelles. En savoir plus sur les sorties de déploiement .

addSpnToEnvironment - détails du principal du service Access dans les paramètres de remplacement
boolean. Optionnel. Utilisez quand action = Create Or Update Resource Group || deploymentScope != Resource Group. Valeur par défaut : false.

Ajoute l’ID et la clé du principal de service du point de terminaison Azure choisi pour être l’environnement d’exécution du script. Les variables $servicePrincipalId et les $servicePrincipalKey peuvent être dans des paramètres de remplacement, tels que -key $servicePrincipalKey.

useWithoutJSON - Utiliser des valeurs de sortie individuelles sans JSON. Stringify appliqué
boolean. Optionnel. Utilisez quand action = Create Or Update Resource Group || deploymentScope != Resource Group. Valeur par défaut : false.

Les valeurs de sortie individuelles sont converties via JSON. Stringify par défaut. Si vous souhaitez utiliser les valeurs de sortie comme c’est le cas sans les convertir via JSON. Stringify, activez cette option. Pour plus d’informations, consultez cette.

Options de contrôle de tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâche. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Remarques

Note

Cette tâche prend en charge les fichiers Bicep lorsque la version d’Azure CLI > 2.20.0.

• Ajout de la prise en charge du déploiement à toutes les étendues de déploiement.
  • Suppression de toutes les actions associées à la machine virtuelle.

Exigences

Exigence	Description
Types de pipelines	YAML, Build Classique, Version Classique
Exécutions sur	Agent, DeploymentGroup
demandes	Aucun
fonctionnalités de	Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande	Quelconque
variables settables	Quelconque
Version de l’agent	2.119.1 ou version ultérieure
Catégorie de tâche	Déployer