通过

AzureKeyVault@1 - Azure 密钥保管库 v1 任务

  • 项目

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

使用此任务下载机密，例如身份验证密钥、存储帐户密钥、数据加密密钥。来自 Azure 密钥保管库 实例的 PFX 文件和密码。 该任务可用于从保管库中提取所有机密或机密子集的最新值，并将其设置为可在管道的后续任务中使用的变量。 该任务基于节点，适用于 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.

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

输入

azureSubscription - Azure 订阅
输入别名： ConnectedServiceName。 string. 必需。

包含 Azure 密钥保管库 实例或创建新连接的 Azure 订阅的服务连接。 详细了解如何连接到 Azure。


KeyVaultName - 密钥保管库
string. 必需。

包含要下载的机密的 Azure 密钥保管库的名称。


SecretsFilter - 机密筛选器
string. 必需。 默认值：*。

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


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

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


RunAsPreJob - 使机密可供整个作业使用
boolean. 默认值：false。

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


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

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


任务控制选项

除了任务输入，所有任务都有控制选项。 有关详细信息，请参阅 控制选项和常见任务属性。

输出变量

无。

备注

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

有较新版本的 Azure 密钥保管库任务可用。

从 Azure Key Vault 获取凭据时，在管道上收到“forbidden”错误

如果在 Azure 密钥保管库中缺少所需的权限，则会发生此情况。 若要解决此问题，请添加具有正确权限的访问策略。

要求

要求 说明
管道类型 YAML，经典内部版本，经典版本
运行平台 Agent、DeploymentGroup
需求 无
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置的变量 任意
代理版本 2.0.0 或更高版本
任务类别 部署

另请参阅