Delen via

AzureKeyVault@1 - Azure Key Vault v1-taak

  • Artikel

Gebruik deze taak om geheimen te downloaden, zoals verificatiesleutels, opslagaccountsleutels, gegevensversleutelingssleutels, . PFX-bestanden en wachtwoorden van een Azure Key Vault-exemplaar. De taak kan worden gebruikt om de meest recente waarden van alle of een subset van geheimen op te halen uit de kluis en deze in te stellen als variabelen die kunnen worden gebruikt in volgende taken van een pijplijn. De taak is gebaseerd op knooppunten en werkt met agents in Linux, macOS en Windows.

Gebruik deze taak om geheimen te downloaden, zoals verificatiesleutels, opslagaccountsleutels, gegevensversleutelingssleutels, . PFX-bestanden en wachtwoorden van een Azure Key Vault-exemplaar. De taak kan worden gebruikt om de meest recente waarden van alle of een subset van geheimen op te halen uit de kluis en deze in te stellen als variabelen die kunnen worden gebruikt in volgende taken van een pijplijn. De taak is gebaseerd op knooppunten en werkt met agents in Linux, macOS en 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: *.

Invoerwaarden

azureSubscription - Azure-abonnement
Invoeralias: ConnectedServiceName. string. Vereist.

De serviceverbinding voor het Azure-abonnement dat het Azure Key Vault-exemplaar bevat of een nieuwe verbinding maakt. Meer informatie over verbinding maken met Azure.


KeyVaultName - Sleutelkluis
string. Vereist.

De naam van de Azure-Key Vault die de geheimen bevat die moeten worden gedownload.


SecretsFilter - Geheimenfilter
string. Vereist. Standaardwaarde: *.

Downloadt geheime namen op basis van de ingevoerde waarde. De waarde kan de standaardwaarde zijn voor het downloaden van alle geheimen uit de geselecteerde sleutelkluis of een door komma's gescheiden lijst met geheime namen.


SecretsFilter - Geheimenfilter
string. Vereist. Toegestane waarden: EditableOptions (Waar). Standaardwaarde: *.

Downloadt geheime namen op basis van de ingevoerde waarde. De waarde kan de standaardwaarde zijn voor het downloaden van alle geheimen uit de geselecteerde sleutelkluis of een door komma's gescheiden lijst met geheime namen.


RunAsPreJob - Geheimen beschikbaar maken voor de hele taak
boolean. Standaardwaarde: false.

Hiermee wordt de taak uitgevoerd voordat de taak wordt uitgevoerd. Geheimen beschikbaar maken voor alle taken in de taak, niet alleen taken die volgen op deze taak.


RunAsPreJob - Geheimen beschikbaar maken voor de hele taak
boolean. Toegestane waarden: EditableOptions (Waar). Standaardwaarde: false.

Hiermee wordt de taak uitgevoerd voordat de taak wordt uitgevoerd. Geheimen beschikbaar maken voor alle taken in de taak, niet alleen taken die volgen op deze taak.


Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Besturingsopties en algemene taakeigenschappen voor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

Werkt met platformoverschrijdende agents (Linux, macOS of Windows).

Er is een nieuwere versie van de Azure Key Vault-taak beschikbaar.

Ik krijg een forbidden foutmelding over pijplijnen op het moment dat referenties worden opgehaald uit Azure Key Vault

Dit gebeurt als de vereiste machtigingen ontbreken in de Azure-sleutelkluis. Voeg een toegangsbeleid met de juiste machtigingen toe om het probleem op te lossen.

Vereisten

Vereiste Beschrijving
Pijplijntypen YAML, klassieke build, klassieke release
Wordt uitgevoerd op Agent, DeploymentGroup
Eisen Geen
Functies Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen Alle
Instelbare variabelen Alle
Agentversie 2.0.0 of hoger
Taakcategorie Implementeren

Zie ook