Partilhar via


AzureKeyVault@1 - Tarefa do Azure Key Vault v1

Utilize esta tarefa para transferir segredos, tais como chaves de autenticação, chaves de conta de armazenamento, chaves de encriptação de dados, . Ficheiros PFX e palavras-passe de uma instância do Azure Key Vault. A tarefa pode ser utilizada para obter os valores mais recentes de todos ou um subconjunto de segredos do cofre e defini-los como variáveis que podem ser utilizadas em tarefas subsequentes de um pipeline. A tarefa é baseada em Nós e funciona com agentes no Linux, macOS e Windows.

Utilize esta tarefa para transferir segredos, tais como chaves de autenticação, chaves de conta de armazenamento, chaves de encriptação de dados, . Ficheiros PFX e palavras-passe de uma instância do Azure Key Vault. A tarefa pode ser utilizada para obter os valores mais recentes de todos ou um subconjunto de segredos do cofre e defini-los como variáveis que podem ser utilizadas em tarefas subsequentes de um pipeline. A tarefa é baseada em Nós e funciona com agentes no Linux, macOS e 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 - Subscrição do Azure
Alias de entrada: ConnectedServiceName. string. Obrigatório.

A ligação de serviço para a subscrição do Azure que contém a instância do Azure Key Vault ou cria uma nova ligação. Saiba mais sobre como ligar ao Azure.


KeyVaultName - Cofre de chaves
string. Obrigatório.

O nome da Key Vault do Azure que contém os segredos a transferir.


SecretsFilter - Filtro de segredos
string. Obrigatório. Valor predefinido: *.

Transfere os nomes dos segredos de acordo com o valor introduzido. O valor pode ser o valor predefinido para transferir todos os segredos do cofre de chaves selecionado ou uma lista separada por vírgulas de nomes de segredos.


SecretsFilter - Filtro de segredos
string. Obrigatório. Valores permitidos: EditableOptions (Verdadeiro). Valor predefinido: *.

Transfere os nomes dos segredos de acordo com o valor introduzido. O valor pode ser o valor predefinido para transferir todos os segredos do cofre de chaves selecionado ou uma lista separada por vírgulas de nomes de segredos.


RunAsPreJob - Disponibilizar segredos para todo o trabalho
boolean. Valor predefinido: false.

Executa a tarefa antes do início da execução da tarefa. Expõe segredos a todas as tarefas na tarefa, não apenas às tarefas que se seguem a esta tarefa.


RunAsPreJob - Disponibilizar segredos para todo o trabalho
boolean. Valores permitidos: EditableOptions (Verdadeiro). Valor predefinido: false.

Executa a tarefa antes do início da execução da tarefa. Expõe segredos a todas as tarefas na tarefa, não apenas às tarefas que se seguem a esta tarefa.


Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

Funciona com agentes de várias plataformas (Linux, macOS ou Windows).

Existe uma versão mais recente da tarefa Key Vault do Azure disponível.

Recebo um forbidden erro nos pipelines no ponto de obter credenciais do Azure Key Vault

Isto ocorre se as permissões necessárias estiverem em falta no cofre de chaves do Azure. Para resolver o problema, adicione uma política de acesso com as permissões corretas.

Requisitos

Requisito Description
Tipos de pipeline YAML, Compilação clássica, Versão clássica
É executado em Agent, DeploymentGroup
Exigências Nenhuma
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos Qualquer
Variáveis de definição Qualquer
Versão do agente 2.0.0 ou superior
Categoria da tarefa Implementar

Ver também