TemplateClient.GetSecretAsync(String, RequestContext) Méthode

Définition

Espace de noms:

Azure.Template

Assembly:

Azure.Template.dll

Paquet:

Azure.Template v1.0.3-beta.2997675

[Méthode de protocole] Obtenir un secret spécifié à partir d’un coffre de clés donné.

• Cette méthode de protocole permet la création explicite de la demande et le traitement de la réponse pour les scénarios avancés.

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)

Paramètres

secretName

String

Nom du secret.

context

RequestContext

Contexte de demande, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

Task<Response>

Réponse retournée par le service.

Exceptions

ArgumentNullException

secretName a la valeur null.

ArgumentException

secretName est une chaîne vide, et on s’attendait à ce qu’elle ne soit pas vide.

RequestFailedException

Le service a retourné un code de status non réussi.

Exemples

Cet exemple montre comment appeler GetSecretAsync avec les paramètres requis et analyser le résultat.

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

Remarques

L'opération GET s'applique à toute clé secrète stockée dans Azure Key Vault. Cette opération nécessite l’autorisation secrets/obtenir.

Vous trouverez ci-dessous le schéma JSON pour la charge utile de réponse.

Corps de réponse :

Schéma pour 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.
}