Key Vault secret - add comment to sample (#20200)

Azure · Feb 3, 2022 · 1535c63 · 1535c63
1 parent 1a8a7c4
commit 1535c63
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/sdk/keyvault/keyvault-secrets/samples-dev/helloWorld.ts b/sdk/keyvault/keyvault-secrets/samples-dev/helloWorld.ts
@@ -24,6 +24,9 @@ export async function main(): Promise<void> {
   const client = new SecretClient(url, credential);
 
   // Create a secret
+  // The secret can be a string of any kind. For example,
+  // a multiline text block such as an RSA private key with newline characters,
+  // or a stringified JSON object, like `JSON.stringify({ mySecret: 'MySecretValue'})`.
   const uniqueString = new Date().getTime();
   const secretName = `secret${uniqueString}`;
   const result = await client.setSecret(secretName, "MySecretValue");

diff --git a/sdk/keyvault/keyvault-secrets/samples/v4/javascript/helloWorld.js b/sdk/keyvault/keyvault-secrets/samples/v4/javascript/helloWorld.js
@@ -24,6 +24,9 @@ async function main() {
   const client = new SecretClient(url, credential);
 
   // Create a secret
+  // The secret can be a string of any kind. For example,
+  // a multiline text block such as an RSA private key with newline characters,
+  // or a stringified JSON object, like `JSON.stringify({ mySecret: 'MySecretValue'})`.
   const uniqueString = new Date().getTime();
   const secretName = `secret${uniqueString}`;
   const result = await client.setSecret(secretName, "MySecretValue");

diff --git a/sdk/keyvault/keyvault-secrets/samples/v4/typescript/src/helloWorld.ts b/sdk/keyvault/keyvault-secrets/samples/v4/typescript/src/helloWorld.ts
@@ -24,6 +24,9 @@ export async function main(): Promise<void> {
   const client = new SecretClient(url, credential);
 
   // Create a secret
+  // The secret can be a string of any kind. For example,
+  // a multiline text block such as an RSA private key with newline characters,
+  // or a stringified JSON object, like `JSON.stringify({ mySecret: 'MySecretValue'})`.
   const uniqueString = new Date().getTime();
   const secretName = `secret${uniqueString}`;
   const result = await client.setSecret(secretName, "MySecretValue");