AzureKeyVault@1 - Azure Key Vault v1 任务

使用此任务下载机密,例如身份验证密钥、存储帐户密钥、数据加密密钥。Azure Key Vault 实例中的 PFX 文件和密码。 该任务可用于从保管库中提取所有或机密子集的最新值,并将其设置为可在管道后续任务中使用的变量。 任务基于 Node,适用于 Linux、macOS 和 Windows 上的代理。

此版本的任务已弃用;使用 AzureKeyVault@2

使用此任务下载机密,例如身份验证密钥、存储帐户密钥、数据加密密钥。Azure Key Vault 实例中的 PFX 文件和密码。 该任务可用于从保管库中提取所有或机密子集的最新值,并将其设置为可在管道后续任务中使用的变量。 任务基于 Node,适用于 Linux、macOS 和 Windows 上的代理。

语法

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

输入

azureSubscription - Azure 订阅
输入别名:ConnectedServiceNamestring。 必填。

包含 Azure Key Vault 实例或创建新连接的 Azure 订阅的服务连接。 详细了解如何 连接到 Azure


KeyVaultName - Key Vault
string。 必填。

包含要下载的机密的 Azure Key Vault 的名称。


SecretsFilter - 机密筛选器
string。 必填。 默认值:*

根据输入的值下载机密名称。 该值可以是从所选密钥保管库下载所有机密的默认值,也可以是以逗号分隔的机密名称列表。


SecretsFilter - 机密筛选器
string。 必填。 允许的值:EditableOptions(True)。 默认值:*

根据输入的值下载机密名称。 该值可以是从所选密钥保管库下载所有机密的默认值,也可以是以逗号分隔的机密名称列表。


RunAsPreJob - 使机密可用于整个作业
boolean。 默认值:false

在作业执行开始之前运行任务。 向作业中的所有任务公开机密,而不仅仅是遵循此机密的任务。


RunAsPreJob - 使机密可用于整个作业
boolean。 允许的值:EditableOptions(True)。 默认值:false

在作业执行开始之前运行任务。 向作业中的所有任务公开机密,而不仅仅是遵循此机密的任务。


任务控制选项

除任务输入之外,所有任务都具有控制选项。 有关详细信息,请参阅 控件选项和常见任务属性

输出变量

没有。

注解

适用于跨平台代理(Linux、macOS 或 Windows)。

有较新版本的 Azure Key Vault 任务可用。

在从 Azure Key Vault 获取凭据时,我在管道上收到 forbidden 错误

如果 Azure 密钥保管库中缺少所需的权限,则会出现这种情况。 若要解决此问题,添加具有正确权限的访问策略

要求

要求 说明
管道类型 YAML,经典版本,经典版本
运行时间 代理,DeploymentGroup
需求 没有
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任何
Settable 变量 任何
代理版本 2.0.0 或更高版本
任务类别 部署

另请参阅