Key Vault keys/secrets/certificates Samples names improvement (Azure#25161)

v-xuto · web-flow · commit 705caa49e4c2 · 2022-07-11T15:08:39.000-07:00
diff --git a/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations_async.py b/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations_async.py
@@ -43,7 +43,7 @@ async def run_sample():
     client = CertificateClient(vault_url=vault_url, credential=credential)
 
     print("\n.. Create Certificate")
-    cert_name = "BackupRestoreCertificate"
+    cert_name = "BackupRestoreCertificateAsync"
 
     # Let's create a certificate for your key vault.
     # if the certificate already exists in the Key Vault, then a new version of the certificate is created.
diff --git a/sdk/keyvault/azure-keyvault-certificates/samples/hello_world_async.py b/sdk/keyvault/azure-keyvault-certificates/samples/hello_world_async.py
@@ -62,7 +62,7 @@ async def run_sample():
         content_type=CertificateContentType.pkcs12,
         validity_in_months=24,
     )
-    cert_name = "HelloWorldCertificate"
+    cert_name = "HelloWorldCertificateAsync"
 
     # Awaiting create_certificate will return the certificate as a KeyVaultCertificate
     # if creation is successful, and the CertificateOperation if not.
diff --git a/sdk/keyvault/azure-keyvault-certificates/samples/import_certificate_async.py b/sdk/keyvault/azure-keyvault-certificates/samples/import_certificate_async.py
@@ -43,7 +43,7 @@ async def run_sample():
     # Assuming you already have a PFX containing your key pair, you can import it into Key Vault.
     # You can do this without setting a policy, but the policy is needed if you want the private key to be exportable
     # or to configure actions when a certificate is close to expiration.
-    pfx_cert_name = "pfxCert"
+    pfx_cert_name = "pfxCertAsync"
     with open(os.environ["PFX_CERT_PATH"], "rb") as f:
         pfx_cert_bytes = f.read()
     imported_pfx_cert = await client.import_certificate(
@@ -54,7 +54,7 @@ async def run_sample():
     # Now let's import a PEM-formatted certificate.
     # To import a PEM-formatted certificate, you must provide a CertificatePolicy that sets the content_type to
     # CertificateContentType.pem or the certificate will fail to import (the default content type is PFX).
-    pem_cert_name = "pemCert"
+    pem_cert_name = "pemCertAsync"
     with open(os.environ["PEM_CERT_PATH"], "rb") as f:
         pem_cert_bytes = f.read()
     pem_cert_policy = CertificatePolicy(issuer_name=WellKnownIssuerNames.self, content_type=CertificateContentType.pem)
diff --git a/sdk/keyvault/azure-keyvault-certificates/samples/list_operations_async.py b/sdk/keyvault/azure-keyvault-certificates/samples/list_operations_async.py
@@ -44,8 +44,8 @@ async def run_sample():
     # Let's create a certificate for holding storage and bank accounts credentials. If the certificate
     # already exists in the Key Vault, then a new version of the certificate is created.
     print("\n.. Create Certificate")
-    bank_cert_name = "BankListCertificate"
-    storage_cert_name = "StorageListCertificate"
+    bank_cert_name = "BankListCertificateAsync"
+    storage_cert_name = "StorageListCertificateAsync"
 
     bank_certificate = await client.create_certificate(
         certificate_name=bank_cert_name, policy=CertificatePolicy.get_default()
diff --git a/sdk/keyvault/azure-keyvault-certificates/samples/parse_certificate_async.py b/sdk/keyvault/azure-keyvault-certificates/samples/parse_certificate_async.py
@@ -57,7 +57,7 @@ async def run_sample():
 
     # Before creating your certificate, let's create the management policy for your certificate.
     # Here we use the default policy.
-    cert_name = "PrivateKeyCertificate"
+    cert_name = "PrivateKeyCertificateAsync"
     cert_policy = CertificatePolicy.get_default()
 
     # Awaiting create_certificate will return the certificate as a KeyVaultCertificate
diff --git a/sdk/keyvault/azure-keyvault-certificates/samples/recover_purge_operations_async.py b/sdk/keyvault/azure-keyvault-certificates/samples/recover_purge_operations_async.py
@@ -43,8 +43,8 @@ async def run_sample():
     # Let's create certificates holding storage and bank accounts credentials. If the certificate
     # already exists in the Key Vault, then a new version of the certificate is created.
     print("\n.. Create Certificates")
-    bank_cert_name = "BankRecoverCertificate"
-    storage_cert_name = "ServerRecoverCertificate"
+    bank_cert_name = "BankRecoverCertificateAsync"
+    storage_cert_name = "ServerRecoverCertificateAsync"
 
     bank_certificate = await client.create_certificate(
         certificate_name=bank_cert_name, policy=CertificatePolicy.get_default()
diff --git a/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations_async.py b/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations_async.py
@@ -45,7 +45,7 @@ async def run_sample():
     # Let's create a Key of type RSA.
     # if the key already exists in the Key Vault, then a new version of the key is created.
     print("\n.. Create Key")
-    key = await client.create_key("keyName", "RSA")
+    key = await client.create_key("keyNameAsync", "RSA")
     print("Key with name '{0}' created with key type '{1}'".format(key.name, key.key_type))
 
     # Backups are good to have, if in case keys gets deleted accidentally.
diff --git a/sdk/keyvault/azure-keyvault-keys/samples/hello_world_async.py b/sdk/keyvault/azure-keyvault-keys/samples/hello_world_async.py
@@ -48,15 +48,15 @@ async def run_sample():
     print("\n.. Create an RSA Key")
     key_size = 2048
     key_ops = ["encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey"]
-    key_name = "rsaKeyName"
+    key_name = "rsaKeyNameAsync"
     rsa_key = await client.create_rsa_key(key_name, size=key_size, key_operations=key_ops)
     print("RSA Key with name '{0}' created of type '{1}'.".format(rsa_key.name, rsa_key.key_type))
 
     # Let's create an Elliptic Curve key with algorithm curve type P-256.
     # if the key already exists in the Key Vault, then a new version of the key is created.
     print("\n.. Create an EC Key")
     key_curve = "P-256"
-    key_name = "ECKeyName"
+    key_name = "ECKeyNameAsync"
     ec_key = await client.create_ec_key(key_name, curve=key_curve)
     print("EC Key with name '{0}' created of type {1}.".format(ec_key.name, ec_key.key_type))
 
diff --git a/sdk/keyvault/azure-keyvault-keys/samples/key_rotation_async.py b/sdk/keyvault/azure-keyvault-keys/samples/key_rotation_async.py
@@ -44,7 +44,7 @@ async def run_sample():
     client = KeyClient(vault_url=VAULT_URL, credential=credential)
 
     # First, create a key
-    key_name = "rotation-sample-key"
+    key_name = "rotation-sample-key-async"
     key = await client.create_rsa_key(key_name)
     print("\nCreated a key; new version is {}".format(key.properties.version))
 
diff --git a/sdk/keyvault/azure-keyvault-keys/samples/list_operations_async.py b/sdk/keyvault/azure-keyvault-keys/samples/list_operations_async.py
@@ -46,8 +46,8 @@ async def run_sample():
     # Let's create keys with RSA and EC type. If the key
     # already exists in the Key Vault, then a new version of the key is created.
     print("\n.. Create Key")
-    rsa_key = await client.create_rsa_key("rsaKeyName")
-    ec_key = await client.create_ec_key("ecKeyName")
+    rsa_key = await client.create_rsa_key("rsaKeyNameAsync")
+    ec_key = await client.create_ec_key("ecKeyNameAsync")
     print("Key with name '{0}' was created of type '{1}'.".format(rsa_key.name, rsa_key.key_type))
     print("Key with name '{0}' was created of type '{1}'.".format(ec_key.name, ec_key.key_type))
 
diff --git a/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations_async.py b/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations_async.py
@@ -40,8 +40,8 @@ async def run_sample():
     client = KeyClient(vault_url=VAULT_URL, credential=credential)
 
     print("\n.. Create keys")
-    rsa_key = await client.create_rsa_key("rsaKeyName")
-    ec_key = await client.create_ec_key("ecKeyName")
+    rsa_key = await client.create_rsa_key("rsaKeyNameAsync")
+    ec_key = await client.create_ec_key("ecKeyNameAsync")
     print("Created key '{0}' of type '{1}'.".format(rsa_key.name, rsa_key.key_type))
     print("Created key '{0}' of type '{1}'.".format(ec_key.name, ec_key.key_type))
 
diff --git a/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations_async.py b/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations_async.py
@@ -43,7 +43,7 @@ async def run_sample():
     # Let's create a secret holding storage account credentials.
     # if the secret already exists in the Key Vault, then a new version of the secret is created.
     print("\n.. Create Secret")
-    secret = await client.set_secret("backupRestoreSecretName", "backupRestoreSecretValue")
+    secret = await client.set_secret("backupRestoreSecretNameAsync", "backupRestoreSecretValue")
     print("Secret with name '{0}' created with value '{1}'".format(secret.name, secret.value))
 
     # Backups are good to have, if in case secrets gets deleted accidentally.
diff --git a/sdk/keyvault/azure-keyvault-secrets/samples/hello_world_async.py b/sdk/keyvault/azure-keyvault-secrets/samples/hello_world_async.py
@@ -43,7 +43,7 @@ async def run_sample():
     # if the secret already exists in the key vault, then a new version of the secret is created.
     print("\n.. Create Secret")
     expires_on = datetime.datetime.utcnow() + datetime.timedelta(days=365)
-    secret = await client.set_secret("helloWorldSecretName", "helloWorldSecretValue", expires_on=expires_on)
+    secret = await client.set_secret("helloWorldSecretNameAsync", "helloWorldSecretValue", expires_on=expires_on)
     print("Secret with name '{0}' created with value '{1}'".format(secret.name, secret.value))
     print("Secret with name '{0}' expires on '{1}'".format(secret.name, secret.properties.expires_on))
 
@@ -72,7 +72,7 @@ async def run_sample():
     # Bank forced a password update for security purposes. Let's change the value of the secret in the key vault.
     # To achieve this, we need to create a new version of the secret in the key vault. The update operation cannot
     # change the value of the secret.
-    new_secret = await client.set_secret(secret.name, "newSecretValue")
+    new_secret = await client.set_secret(secret.name, "newSecretValueAsync")
     print("Secret with name '{0}' created with value '{1}'".format(new_secret.name, new_secret.value))
 
     # The bank account was closed, need to delete its credentials from the Key Vault.
diff --git a/sdk/keyvault/azure-keyvault-secrets/samples/list_operations_async.py b/sdk/keyvault/azure-keyvault-secrets/samples/list_operations_async.py
@@ -44,8 +44,8 @@ async def run_sample():
     # Let's create secrets holding storage and bank accounts credentials. If the secret
     # already exists in the Key Vault, then a new version of the secret is created.
     print("\n.. Create Secret")
-    bank_secret = await client.set_secret("listOpsBankSecretName", "listOpsSecretValue1")
-    storage_secret = await client.set_secret("listOpsStorageSecretName", "listOpsSecretValue2")
+    bank_secret = await client.set_secret("listOpsBankSecretNameAsync", "listOpsSecretValue1")
+    storage_secret = await client.set_secret("listOpsStorageSecretNameAsync", "listOpsSecretValue2")
     print("Secret with name '{0}' was created.".format(bank_secret.name))
     print("Secret with name '{0}' was created.".format(storage_secret.name))
 
diff --git a/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations_async.py b/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations_async.py
@@ -42,8 +42,8 @@ async def run_sample():
     # Let's create secrets holding storage and bank accounts credentials. If the secret
     # already exists in the Key Vault, then a new version of the secret is created.
     print("\n.. Create Secret")
-    bank_secret = await client.set_secret("recoverPurgeBankSecretName", "recoverPurgeSecretValue1")
-    storage_secret = await client.set_secret("recoverPurgeStorageSecretName", "recoverPurgeSecretValue2")
+    bank_secret = await client.set_secret("recoverPurgeBankSecretNameAsync", "recoverPurgeSecretValue1")
+    storage_secret = await client.set_secret("recoverPurgeStorageSecretNameAsync", "recoverPurgeSecretValue2")
     print("Secret with name '{0}' was created.".format(bank_secret.name))
     print("Secret with name '{0}' was created.".format(storage_secret.name))
 

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ async def run_sample():`
`62`	`62`	`content_type=CertificateContentType.pkcs12,`
`63`	`63`	`validity_in_months=24,`
`64`	`64`	`)`
`65`		`- cert_name = "HelloWorldCertificate"`
	`65`	`+ cert_name = "HelloWorldCertificateAsync"`
`66`	`66`
`67`	`67`	`# Awaiting create_certificate will return the certificate as a KeyVaultCertificate`
`68`	`68`	`# if creation is successful, and the CertificateOperation if not.`