AzureKeyVault@1 - Azure Key Vault v1 タスク
このタスクを使用して、認証キー、ストレージ アカウント キー、データ暗号化キー、などのシークレットをダウンロードします。Azure Key Vault インスタンスの PFX ファイルとパスワード。 このタスクを使用すると、コンテナーからシークレットのすべてまたはサブセットの最新の値をフェッチし、パイプラインの後続のタスクで使用できる変数として設定できます。 タスクはノードベースであり、Linux、macOS、Windows 上のエージェントで動作します。
このタスクを使用して、認証キー、ストレージ アカウント キー、データ暗号化キー、などのシークレットをダウンロードします。Azure Key Vault インスタンスの 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 Key Vault インスタンスを含む、または新しい接続を作成する Azure サブスクリプションのサービス接続。 詳細については、 Azure への接続に関するページを参照してください。
KeyVaultName
- キー コンテナー
string
. 必須です。
ダウンロードするシークレットを含む Azure Key Vaultの名前。
SecretsFilter
- シークレット フィルター
string
. 必須です。 既定値: *
。
入力した値に従ってシークレット名をダウンロードします。 この値には、選択したキー コンテナーからすべてのシークレットをダウンロードするための既定値、またはシークレット名のコンマ区切りのリストを指定できます。
SecretsFilter
- シークレット フィルター
string
. 必須です。 使用できる値: EditableOptions
(True)。 既定値: *
。
入力した値に従ってシークレット名をダウンロードします。 この値には、選択したキー コンテナーからすべてのシークレットをダウンロードするための既定値、またはシークレット名のコンマ区切りのリストを指定できます。
RunAsPreJob
- ジョブ全体でシークレットを使用できるようにする
boolean
. 既定値: false
。
ジョブの実行が開始される前にタスクを実行します。 このタスクに続くタスクだけでなく、ジョブ内のすべてのタスクにシークレットを公開します。
RunAsPreJob
- ジョブ全体でシークレットを使用できるようにする
boolean
. 使用できる値: EditableOptions
(True)。 既定値: false
。
ジョブの実行が開始される前にタスクを実行します。 このタスクに続くタスクだけでなく、ジョブ内のすべてのタスクにシークレットを公開します。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
クロスプラットフォーム エージェント (Linux、macOS、または Windows) で動作します。
新しいバージョンの Azure Key Vault タスクを使用できます。
forbidden
Azure Key Vault から資格情報を取得する時点でパイプラインでエラーが発生する
これは、必要なアクセス許可が Azure キー コンテナーに存在しない場合に発生します。 この問題を解決するには、正しいアクセス許可を持つアクセス ポリシーを追加します。
要件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
上で実行 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 2.0.0 以上 |
タスクのカテゴリ | デプロイ |