TemplateClient.GetSecret(String, RequestContext) Método

Definição

Namespace:

Azure.Template

Assembly:

Azure.Template.dll

Pacote:

Azure.Template v1.0.3-beta.2997675

[Método protocol] Obtenha um segredo especificado de um determinado cofre de chaves.

• Esse método de protocolo permite a criação explícita da solicitação e o processamento da resposta para cenários avançados.

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

Parâmetros

secretName

String

O nome do segredo.

context

RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Response

A resposta retornada do serviço.

Exceções

ArgumentNullException

secretName é nulo.

ArgumentException

secretName é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar GetSecret com os parâmetros necessários e analisar o resultado.

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());

Comentários

A operação GET se aplica a qualquer segredo armazenado em um Cofre de Chaves do Azure. Essa operação requer a permissão de obtenção/segredos.

Abaixo está o esquema JSON para o conteúdo da resposta.

Corpo da resposta:

Esquema para 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.
}