Compartir vía

AzureKeyVault@1: tarea de Azure Key Vault v1

  • Artículo

Use esta tarea para descargar secretos, como claves de autenticación, claves de cuenta de almacenamiento, claves de cifrado de datos, . Archivos PFX y contraseñas de una instancia de Azure Key Vault. La tarea se puede usar para capturar los valores más recientes de todos o un subconjunto de secretos del almacén y establecerlos como variables que se pueden usar en tareas posteriores de una canalización. La tarea se basa en Node y funciona con agentes en Linux, macOS y Windows.

Use esta tarea para descargar secretos, como claves de autenticación, claves de cuenta de almacenamiento, claves de cifrado de datos, . Archivos PFX y contraseñas de una instancia de Azure Key Vault. La tarea se puede usar para capturar los valores más recientes de todos o un subconjunto de secretos del almacén y establecerlos como variables que se pueden usar en tareas posteriores de una canalización. La tarea se basa en Node y funciona con agentes en Linux, macOS y 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: *.

Entradas

azureSubscription - Suscripción de Azure
Alias de entrada: ConnectedServiceName. string. Obligatorio.

La conexión de servicio para la suscripción de Azure que contiene la instancia de Azure Key Vault o crea una nueva conexión. Más información sobre cómo conectarse a Azure.


KeyVaultName - Almacén de claves
string. Obligatorio.

Nombre del Key Vault de Azure que contiene los secretos que se van a descargar.


SecretsFilter - Filtro de secretos
string. Obligatorio. Valor predeterminado: *.

Descarga los nombres de secreto según el valor especificado. El valor puede ser el valor predeterminado para descargar todos los secretos del almacén de claves seleccionado o una lista separada por comas de nombres de secretos.


SecretsFilter - Filtro de secretos
string. Obligatorio. Valores permitidos: EditableOptions (True). Valor predeterminado: *.

Descarga los nombres de secreto según el valor especificado. El valor puede ser el valor predeterminado para descargar todos los secretos del almacén de claves seleccionado o una lista separada por comas de nombres de secretos.


RunAsPreJob - Hacer que los secretos estén disponibles para todo el trabajo
boolean. Valor predeterminado: false.

Ejecuta la tarea antes de que comience la ejecución del trabajo. Expone secretos a todas las tareas del trabajo, no solo a las que siguen a esta.


RunAsPreJob - Hacer que los secretos estén disponibles para todo el trabajo
boolean. Valores permitidos: EditableOptions (True). Valor predeterminado: false.

Ejecuta la tarea antes de que comience la ejecución del trabajo. Expone secretos a todas las tareas del trabajo, no solo a las que siguen a esta.


Opciones de control de tareas

Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Comentarios

Funciona con agentes multiplataforma (Linux, macOS o Windows).

Hay una versión más reciente de la tarea azure Key Vault disponible.

Aparece un error forbidden en las canalizaciones en el momento de obtener credenciales de Azure Key Vault.

Esto ocurre si faltan los permisos necesarios en Azure Key Vault. Para resolver el problema, agregue una directiva de acceso con los permisos correctos.

Requisitos

Requisito Descripción
Tipos de canalización YAML, compilación clásica, versión clásica
Se ejecuta en Agente, DeploymentGroup
Peticiones None
Capabilities Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos Any
Variables que se pueden establecer Any
Versión del agente 2.0.0 o superior
Categoría de la tarea: Implementar

Consulte también