TemplateClient.GetSecretAsync(String, RequestContext) メソッド

定義

名前空間:

Azure.Template

アセンブリ:

Azure.Template.dll

パッケージ:

Azure.Template v1.0.3-beta.2997675

[プロトコルメソッド]指定されたキー コンテナーから指定されたシークレットを取得します。

• この プロトコルメソッド を使用すると、高度なシナリオで応答の要求と処理を明示的に作成できます。

public virtual System.Threading.Tasks.Task<Azure.Response> GetSecretAsync (string secretName, Azure.RequestContext context);

abstract member GetSecretAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSecretAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetSecretAsync (secretName As String, context As RequestContext) As Task(Of Response)

パラメーター

secretName

String

シークレットの名前。

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Task<Response>

サービスから返された応答。

例外

ArgumentNullException

secretName が null です。

ArgumentException

secretName は空の文字列であり、空でないと想定されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して GetSecretAsync を呼び出し、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var client = new TemplateClient("<vaultBaseUrl>", credential);

Response response = await client.GetSecretAsync("<secretName>", new RequestContext());

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("contentType").ToString());
Console.WriteLine(result.GetProperty("tags").GetProperty("<test>").ToString());
Console.WriteLine(result.GetProperty("kid").ToString());
Console.WriteLine(result.GetProperty("managed").ToString());

注釈

GET 操作は、Azure Key Vault に格納されているシークレットに適用できます。 この操作には、secrets/get アクセス許可が必要です。

応答ペイロードの JSON スキーマを次に示します。

応答本文:

の SecretBundleスキーマ:

{
  value: string, # Optional. The secret value.
  id: string, # Optional. The secret id.
  contentType: string, # Optional. The content type of the secret.
  tags: Dictionary<string, string>, # Optional. Application specific metadata in the form of key-value pairs.
  kid: string, # Optional. If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.
  managed: boolean, # Optional. True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.
}