Share via

AzureKeyVault@1 - Tâche Azure Key Vault v1

  • Article

Utilisez cette tâche pour télécharger des secrets, tels que des clés d’authentification, des clés de compte de stockage, des clés de chiffrement de données, . Fichiers PFX et mots de passe d’un instance Azure Key Vault. La tâche peut être utilisée pour extraire les valeurs les plus récentes de la totalité ou d’un sous-ensemble de secrets du coffre et les définir en tant que variables pouvant être utilisées dans les tâches suivantes d’un pipeline. La tâche est basée sur les nœuds et fonctionne avec des agents sur Linux, macOS et Windows.

Utilisez cette tâche pour télécharger des secrets, tels que des clés d’authentification, des clés de compte de stockage, des clés de chiffrement de données, . Fichiers PFX et mots de passe d’un Key Vault instance Azure. La tâche peut être utilisée pour extraire les valeurs les plus récentes de la totalité ou d’un sous-ensemble de secrets du coffre et les définir en tant que variables pouvant être utilisées dans les tâches suivantes d’un pipeline. La tâche est basée sur les nœuds et fonctionne avec des agents sur Linux, macOS et Windows.

Syntax

# Azure Key Vault v1
# Download Azure Key Vault secrets.
- task: AzureKeyVault@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    KeyVaultName: # string. Required. Key vault. 
    SecretsFilter: '*' # string. Required. Secrets filter. Default: *.
    #RunAsPreJob: false # boolean. Make secrets available to whole job. Default: false.

# Azure Key Vault v1
# Download Azure Key Vault secrets.
- task: AzureKeyVault@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    KeyVaultName: # string. Required. Key vault. 
    SecretsFilter: '*' # 'EditableOptions'. Required. Secrets filter. Default: *.
    #RunAsPreJob: false # 'EditableOptions'. Make secrets available to whole job. Default: false.

# Azure Key Vault v1
# Download Azure Key Vault secrets.
- task: AzureKeyVault@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    KeyVaultName: # string. Required. Key vault. 
    SecretsFilter: '*' # 'EditableOptions'. Required. Secrets filter. Default: *.

# Azure Key Vault v1
# Download Azure Key Vault Secrets.
- task: AzureKeyVault@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    KeyVaultName: # string. Required. Key vault. 
    SecretsFilter: '*' # 'EditableOptions'. Required. Secrets filter. Default: *.

Entrées

azureSubscription - Abonnement Azure
Alias d’entrée : ConnectedServiceName. string. Obligatoire.

Connexion de service pour l’abonnement Azure qui contient le Key Vault instance Azure ou crée une nouvelle connexion. En savoir plus sur la Connexion à Azure.


KeyVaultName - Coffre de clés
string. Obligatoire.

Nom du Key Vault Azure qui contient les secrets à télécharger.


SecretsFilter - Filtre de secrets
string. Obligatoire. Valeur par défaut : *.

Télécharge les noms de secrets en fonction de la valeur entrée. La valeur peut être la valeur par défaut pour télécharger tous les secrets à partir du coffre de clés sélectionné, ou une liste de noms de secrets séparés par des virgules.


SecretsFilter - Filtre de secrets
string. Obligatoire. Valeurs autorisées : EditableOptions (True). Valeur par défaut : *.

Télécharge les noms de secrets en fonction de la valeur entrée. La valeur peut être la valeur par défaut pour télécharger tous les secrets à partir du coffre de clés sélectionné, ou une liste de noms de secrets séparés par des virgules.


RunAsPreJob - Rendre les secrets disponibles pour l’ensemble du travail
boolean. Valeur par défaut : false.

Exécute la tâche avant le début de l’exécution du travail. Expose les secrets à toutes les tâches du travail, pas seulement aux tâches qui suivent celle-ci.


RunAsPreJob - Rendre les secrets disponibles pour l’ensemble du travail
boolean. Valeurs autorisées : EditableOptions (True). Valeur par défaut : false.

Exécute la tâche avant le début de l’exécution du travail. Expose les secrets à toutes les tâches du travail, pas seulement aux tâches qui suivent celle-ci.


Options de contrôle de la tâche

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

Variables de sortie

Aucun.

Notes

Fonctionne avec les agents multiplateformes (Linux, macOS ou Windows).

Une version plus récente de la tâche Azure Key Vault est disponible.

J’obtiens une erreur forbidden sur les pipelines au moment de l’obtention des informations d’identification à partir d’Azure Key Vault

Cette erreur se produit si les autorisations requises sont manquantes dans le coffre de clés Azure. Pour résoudre le problème, ajoutez une stratégie d’accès avec les autorisations appropriées.

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 2.0.0 ou version ultérieure
Catégorie de la tâche Déployer

Voir aussi