Freigeben über

AzureKeyVault@1 – Azure Key Vault v1-Aufgabe

  • Artikel

Verwenden Sie diese Aufgabe, um Geheimnisse herunterzuladen, z. B. Authentifizierungsschlüssel, Speicherkontoschlüssel, Datenverschlüsselungsschlüssel, . PFX-Dateien und Kennwörter aus einem Azure Key Vault instance. Die Aufgabe kann verwendet werden, um die neuesten Werte aller oder einer Teilmenge von Geheimnissen aus dem Tresor abzurufen und sie als Variablen festzulegen, die in nachfolgenden Aufgaben einer Pipeline verwendet werden können. Die Aufgabe ist Knotenbasiert und funktioniert mit Agents unter Linux, macOS und Windows.

Verwenden Sie diese Aufgabe, um Geheimnisse herunterzuladen, z. B. Authentifizierungsschlüssel, Speicherkontoschlüssel, Datenverschlüsselungsschlüssel, . PFX-Dateien und Kennwörter aus einer Azure-Key Vault instance. Die Aufgabe kann verwendet werden, um die neuesten Werte aller oder einer Teilmenge von Geheimnissen aus dem Tresor abzurufen und sie als Variablen festzulegen, die in nachfolgenden Aufgaben einer Pipeline verwendet werden können. Die Aufgabe ist Knotenbasiert und funktioniert mit Agents unter Linux, macOS und 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: *.

Eingaben

azureSubscription - Azure-Abonnement
Eingabealias: ConnectedServiceName. string. Erforderlich.

Die Dienstverbindung für das Azure-Abonnement, das entweder die Azure-Key Vault instance enthält oder eine neue Verbindung erstellt. Erfahren Sie mehr über die Verbindung zu Azure.


KeyVaultName - Schlüsseltresor
string. Erforderlich.

Der Name des Azure-Key Vault, der die herunterzuladenden Geheimnisse enthält.


SecretsFilter - Geheimnisfilter
string. Erforderlich. Standardwert. *.

Lädt Geheimnisnamen gemäß dem eingegebenen Wert herunter. Der Wert kann der Standardwert zum Herunterladen aller Geheimnisse aus dem ausgewählten Schlüsseltresor oder eine durch Trennzeichen getrennte Liste von Geheimnisnamen sein.


SecretsFilter - Geheimnisfilter
string. Erforderlich. Zulässige Werte: EditableOptions (True). Standardwert. *.

Lädt Geheimnisnamen gemäß dem eingegebenen Wert herunter. Der Wert kann der Standardwert zum Herunterladen aller Geheimnisse aus dem ausgewählten Schlüsseltresor oder eine durch Trennzeichen getrennte Liste von Geheimnisnamen sein.


RunAsPreJob - Geheimnisse für den ganzen Auftrag verfügbar machen
boolean. Standardwert. false.

Führt den Task aus, bevor die Auftragsausführung beginnt. Macht Geheimnisse für alle Aufgaben im Auftrag verfügbar, nicht nur für Aufgaben, die dieser Aufgabe folgen.


RunAsPreJob - Geheimnisse für den ganzen Auftrag verfügbar machen
boolean. Zulässige Werte: EditableOptions (True). Standardwert. false.

Führt den Task aus, bevor die Auftragsausführung beginnt. Macht Geheimnisse für alle Aufgaben im Auftrag verfügbar, nicht nur für Aufgaben, die dieser Aufgabe folgen.


Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Keine.

Hinweise

Funktioniert mit plattformübergreifenden Agents (Linux, macOS oder Windows).

Es ist eine neuere Version der Azure Key Vault-Aufgabe verfügbar.

Ich erhalte einen forbidden-Fehler für Pipelines, wenn ich Anmeldeinformationen aus Azure Key Vault abrufe.

Dies tritt auf, wenn die erforderlichen Berechtigungen in der Azure Key Vault-Instanz fehlen. Um das Problem zu beheben, fügen Sie eine Zugriffsrichtlinie mit den richtigen Berechtigungen hinzu.

Anforderungen

Anforderung BESCHREIBUNG
Pipelinetypen YAML, Klassischer Build, klassische Version
Wird ausgeführt auf Agent, DeploymentGroup
Forderungen Keine
Capabilities Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen Any
Einstellbare Variablen Any
Agent-Version 2.0.0 oder höher
Aufgabenkategorie Bereitstellen

Weitere Informationen