你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

TemplateClient.GetSecret(String, RequestContext) 方法

定义

命名空间:

Azure.Template

程序集:

Azure.Template.dll

包:

Azure.Template v1.0.3-beta.2997675

[协议方法]从给定密钥保管库获取指定的机密。

• 此 协议方法 允许显式创建请求并处理高级方案的响应。

public virtual Azure.Response GetSecret (string secretName, Azure.RequestContext context);

abstract member GetSecret : string * Azure.RequestContext -> Azure.Response
override this.GetSecret : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetSecret (secretName As String, context As RequestContext) As Response

参数

secretName

String

机密的名称。

context

RequestContext

请求上下文，它可以基于每个调用替代客户端管道的默认行为。

返回

Response

从服务返回的响应。

例外

ArgumentNullException

secretName 为 null。

ArgumentException

secretName 是一个空字符串，预期为非空。

RequestFailedException

服务返回了不成功状态代码。

示例

此示例演示如何使用所需参数调用 GetSecret 并分析结果。

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

Response response = client.GetSecret("<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 密钥保管库中存储的任何机密。 此操作需要机密/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.
}