From e877e016858aa8c4dae4a3623bb5cc5d2cc3deaf Mon Sep 17 00:00:00 2001 From: Isabella Cai Date: Wed, 8 Jan 2020 11:27:01 -0800 Subject: [PATCH 1/7] fixed issues in readme from docs meeting --- .../azure-keyvault-certificates/README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/sdk/keyvault/azure-keyvault-certificates/README.md b/sdk/keyvault/azure-keyvault-certificates/README.md index caa6b5b0125d..190ee68152c9 100644 --- a/sdk/keyvault/azure-keyvault-certificates/README.md +++ b/sdk/keyvault/azure-keyvault-certificates/README.md @@ -128,13 +128,12 @@ certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azu ``` ## Key concepts +### Certificate Client With a [CertificateClient][certificate_client_docs] you can get certificates from the vault, create new certificates and new versions of existing certificates, update certificate metadata, and delete certificates. You can also manage certificate issuers, contacts, and management policies of certificates. This is illustrated in the [examples](#examples) below. -### Certificate Client: - ## Examples This section contains code snippets covering common tasks: * [Create a Certificate](#create-a-certificate "Create a Certificate") @@ -351,12 +350,13 @@ certificate = certificate_client.get_certificate(certificate_name="cert-name", l ## Next steps Several samples are available in the Azure SDK for Python GitHub repository. These samples provide example code for additional Key Vault scenarios: -* [test_examples_certificates.py][test_example_certificates] and -[test_examples_certificates_async.py][test_example_certificates_async] - code snippets from -the library's documentation * [hello_world.py][hello_world_sample] and [hello_world_async.py][hello_world_async_sample] - create/get/update/delete certificates * [backup_restore_operations.py][backup_operations_sample] and [backup_restore_operations_async.py][backup_operations_async_sample] - backup and recover certificates +* [list_operations.py][list_operations_sample] and [list_operations_async.py][list_operations_async_sample] - list certificates +* [recover_purge_operations.py][recover_purge_operations_sample] and [recover_purge_operations_async.py][recover_purge_operations_async_sample] - recover and purge certificates +* [issuers.py][issuers_sample] and [issuers_async.py][issuers_async_sample] - manage certificate issuers +* [contacts.py][contacts_sample] and [contacts_async.py][contacts_async_sample] - manage certificate contacts ### Additional Documentation For more extensive documentation on Azure Key Vault, see the [API reference documentation][reference_docs]. @@ -390,6 +390,13 @@ additional questions or comments. [hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/hello_world_async.py [keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ [list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/list_operations.py +[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/list_operations_async.py +[recover_purge_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/recover_purge_operations.py +[recover_purge_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/recover_purge_operations_async.py +[contacts_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/contacts.py +[contacts_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/contacts_async.py +[issuers_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/issuers.py +[issuers_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/issuers_async.py [pip]: https://pypi.org/project/pip/ [pypi_package_certificates]: https://pypi.org/project/azure-keyvault-certificates/ [certificate_client_docs]: https://aka.ms/azsdk-python-keyvault-certificates-certificateclient-ref From 70bdf6baf6696b32c4662303013223c14093b97f Mon Sep 17 00:00:00 2001 From: Isabella Cai Date: Wed, 8 Jan 2020 11:30:21 -0800 Subject: [PATCH 2/7] added samples readme --- .../samples/README.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 sdk/keyvault/azure-keyvault-certificates/samples/README.md diff --git a/sdk/keyvault/azure-keyvault-certificates/samples/README.md b/sdk/keyvault/azure-keyvault-certificates/samples/README.md new file mode 100644 index 000000000000..b9176098e14b --- /dev/null +++ b/sdk/keyvault/azure-keyvault-certificates/samples/README.md @@ -0,0 +1,35 @@ +--- +page_type: sample +languages: + - python +products: + - azure + - azure-key-vault +urlFragment: keyvault-certificates-samples +--- + +# Azure Key Vault Certificates Client Library Python Samples + +These code snippets highlight this SDK's common use cases. + +* [hello_world.py][hello_world_sample] and [hello_world_async.py][hello_world_async_sample] - create/get/update/delete certificates +* [backup_restore_operations.py][backup_operations_sample] and [backup_restore_operations_async.py][backup_operations_async_sample] - backup and +recover certificates +* [list_operations.py][list_operations_sample] and [list_operations_async.py][list_operations_async_sample] - list certificates +* [recover_purge_operations.py][recover_purge_operations_sample] and [recover_purge_operations_async.py][recover_purge_operations_async_sample] - recover and purge certificates +* [issuers.py][issuers_sample] and [issuers_async.py][issuers_async_sample] - manage certificate issuers +* [contacts.py][contacts_sample] and [contacts_async.py][contacts_async_sample] - manage certificate contacts + +[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations.py +[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations_async.py +[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/hello_world.py +[hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/hello_world_async.py +[keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ +[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/list_operations.py +[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/list_operations_async.py +[recover_purge_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/recover_purge_operations.py +[recover_purge_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/recover_purge_operations_async.py +[contacts_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/contacts.py +[contacts_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/contacts_async.py +[issuers_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/issuers.py +[issuers_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/issuers_async.py \ No newline at end of file From 9c6a42b3f91417cec5e99c68044b1535d85e7545 Mon Sep 17 00:00:00 2001 From: Isabella Cai Date: Wed, 8 Jan 2020 11:41:47 -0800 Subject: [PATCH 3/7] updated secrets readme --- sdk/keyvault/azure-keyvault-secrets/README.md | 29 +++++++++++-------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/sdk/keyvault/azure-keyvault-secrets/README.md b/sdk/keyvault/azure-keyvault-secrets/README.md index ab9639f78e8b..1ddccb386f78 100644 --- a/sdk/keyvault/azure-keyvault-secrets/README.md +++ b/sdk/keyvault/azure-keyvault-secrets/README.md @@ -15,7 +15,7 @@ create, manage, and deploy public and private SSL/TLS certificates ## Getting started ### Install packages Install [azure-keyvault-secrets][pypi_package_secrets] and -[azure-identity][azure_identity] with [pip][pip]: +[azure-identity][azure_identity_pip] with [pip][pip]: ```Bash pip install azure-keyvault-secrets azure-identity ``` @@ -351,14 +351,15 @@ secret_client.get_secret("my-secret", logging_enable=True) ## Next steps Several samples are available in the Azure SDK for Python GitHub repository. These provide example code for additional Key Vault scenarios: -* [test_samples_secrets.py][test_examples_secrets] and -[test_samples_secrets_async.py][test_example_secrets_async] - code snippets -from the library's documentation * [hello_world.py][hello_world_sample] and -[hello_world_async.py][hello_world_async_sample] - create/get/update/delete -secrets +[hello_world_async.py][hello_world_async_sample] - create/get/update/delete secrets * [list_operations.py][list_operations_sample] and -[list_operations_async.py][list_operations_async_sample] - list secrets +[list_operations_async.py][list_operations_async_sample] - basic list operations for secrets +* [backup_restore_operations.py][backup_operations_sample] and +[backup_restore_operations_async.py][backup_operations_async_sample] - backup and +restore secrets +* [recover_purge_operations.py][recover_purge_sample] and +[recover_purge_operations_async.py][recover_purge_async_sample] - recovering and purging secrets ### Additional Documentation For more extensive documentation on Azure Key Vault, see the @@ -383,15 +384,19 @@ additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash [azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity +[azure_identity_pip]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ [default_cred_ref]: https://aka.ms/azsdk-python-identity-default-cred-ref -[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world.py -[hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world_async.py +[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world.py +[hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world_async.py +[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations.py +[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations_async.py +[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations.py +[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations_async.py +[recover_purge_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations.py +[recover_purge_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations_async.py [keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ -[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations.py -[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations_async.py -[pip]: https://pypi.org/project/pip/ [pypi_package_secrets]: https://pypi.org/project/azure-keyvault-secrets/ [reference_docs]: https://aka.ms/azsdk-python-keyvault-secrets-ref [secret_client_src]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets From 78d90a1508f1895190fa723546f02f2d74c84d2b Mon Sep 17 00:00:00 2001 From: Isabella Cai Date: Wed, 8 Jan 2020 11:42:58 -0800 Subject: [PATCH 4/7] updated keys readme --- sdk/keyvault/azure-keyvault-keys/README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/sdk/keyvault/azure-keyvault-keys/README.md b/sdk/keyvault/azure-keyvault-keys/README.md index f485c09abd7a..f85f507d1881 100644 --- a/sdk/keyvault/azure-keyvault-keys/README.md +++ b/sdk/keyvault/azure-keyvault-keys/README.md @@ -15,7 +15,7 @@ create, manage, and deploy public and private SSL/TLS certificates ## Getting started ### Install packages Install [azure-keyvault-keys][pypi_package_keys] and -[azure-identity][azure_identity] with [pip][pip]: +[azure-identity][azure_identity_pip] with [pip][pip]: ```Bash pip install azure-keyvault-keys azure-identity ``` @@ -373,14 +373,15 @@ client.get_key("my-key", logging_enable=True) ## Next steps Several samples are available in the Azure SDK for Python GitHub repository. These provide example code for additional Key Vault scenarios: -* [test_samples_keys.py][test_examples_keys] and -[test_samples_keys_async.py][test_example_keys_async] - code snippets from -the library's documentation * [hello_world.py][hello_world_sample] and [hello_world_async.py][hello_world_async_sample] - create/get/update/delete keys +* [list_operations.py][list_operations_sample] and +[list_operations_async.py][list_operations_async_sample] - basic list operations for keys * [backup_restore_operations.py][backup_operations_sample] and [backup_restore_operations_async.py][backup_operations_async_sample] - backup and -restore keys +recover keys +* [recover_purge_operations.py][recover_purge_sample] and +[recover_purge_operations_async.py][recover_purge_async_sample] - recovering and purging keys ### Additional Documentation For more extensive documentation on Azure Key Vault, see the @@ -405,15 +406,20 @@ additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash [azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity +[azure_identity_pip]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ [default_cred_ref]: https://aka.ms/azsdk-python-identity-default-cred-ref [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ [hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/hello_world.py [hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/hello_world_async.py -[JWK]: https://tools.ietf.org/html/rfc7517 -[keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ [backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations.py [backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations_async.py +[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/list_operations.py +[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/list_operations_async.py +[recover_purge_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations.py +[recover_purge_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations_async.py +[JWK]: https://tools.ietf.org/html/rfc7517 +[keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ [pip]: https://pypi.org/project/pip/ [pypi_package_keys]: https://pypi.org/project/azure-keyvault-keys/ [reference_docs]: https://aka.ms/azsdk-python-keyvault-keys-docs From 5dff04e79ffd3d814df167529e172969454becb7 Mon Sep 17 00:00:00 2001 From: Isabella Cai Date: Wed, 8 Jan 2020 11:43:12 -0800 Subject: [PATCH 5/7] updated identity pip link in certs readme --- sdk/keyvault/azure-keyvault-certificates/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sdk/keyvault/azure-keyvault-certificates/README.md b/sdk/keyvault/azure-keyvault-certificates/README.md index 190ee68152c9..f3cdec3e24e9 100644 --- a/sdk/keyvault/azure-keyvault-certificates/README.md +++ b/sdk/keyvault/azure-keyvault-certificates/README.md @@ -13,7 +13,7 @@ and other secrets ## Getting started ### Install the package Install [azure-keyvault-certificates][pypi_package_certificates] and -[azure-identity][azure_identity] with [pip][pip]: +[azure-identity][azure_identity_pip] with [pip][pip]: ```Bash pip install azure-keyvault-certificates azure-identity ``` @@ -382,6 +382,7 @@ additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash [azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity +[azure_identity_pip]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ [backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations.py From a44f767fff0c79628fe6682037c987fee9e8f035 Mon Sep 17 00:00:00 2001 From: Isabella Cai Date: Wed, 8 Jan 2020 13:37:14 -0800 Subject: [PATCH 6/7] updated link to azure core exceptions --- sdk/keyvault/azure-keyvault-certificates/README.md | 2 +- sdk/keyvault/azure-keyvault-keys/README.md | 2 +- sdk/keyvault/azure-keyvault-secrets/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/sdk/keyvault/azure-keyvault-certificates/README.md b/sdk/keyvault/azure-keyvault-certificates/README.md index f3cdec3e24e9..0feb656757e8 100644 --- a/sdk/keyvault/azure-keyvault-certificates/README.md +++ b/sdk/keyvault/azure-keyvault-certificates/README.md @@ -380,7 +380,7 @@ additional questions or comments. [asyncio_package]: https://docs.python.org/3/library/asyncio.html [default_cred_ref]: https://aka.ms/azsdk-python-identity-default-cred-ref [azure_cloud_shell]: https://shell.azure.com/bash -[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md +[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/core/azure-core#azure-core-library-exceptions [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity [azure_identity_pip]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ diff --git a/sdk/keyvault/azure-keyvault-keys/README.md b/sdk/keyvault/azure-keyvault-keys/README.md index f85f507d1881..b98aaa4aa022 100644 --- a/sdk/keyvault/azure-keyvault-keys/README.md +++ b/sdk/keyvault/azure-keyvault-keys/README.md @@ -404,7 +404,7 @@ see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash -[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md +[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/core/azure-core#azure-core-library-exceptions [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity [azure_identity_pip]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ diff --git a/sdk/keyvault/azure-keyvault-secrets/README.md b/sdk/keyvault/azure-keyvault-secrets/README.md index 1ddccb386f78..a01e4d9e67b7 100644 --- a/sdk/keyvault/azure-keyvault-secrets/README.md +++ b/sdk/keyvault/azure-keyvault-secrets/README.md @@ -382,7 +382,7 @@ see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash -[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md +[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/core/azure-core#azure-core-library-exceptions [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity [azure_identity_pip]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ From 627b5189f63962fb057d39e9e695ad565a274650 Mon Sep 17 00:00:00 2001 From: Isabella Cai Date: Wed, 8 Jan 2020 15:03:10 -0800 Subject: [PATCH 7/7] implemented Charles' comments --- .../azure-keyvault-certificates/README.md | 8 +++---- sdk/keyvault/azure-keyvault-keys/README.md | 21 +++++++++---------- sdk/keyvault/azure-keyvault-secrets/README.md | 20 +++++++++--------- 3 files changed, 24 insertions(+), 25 deletions(-) diff --git a/sdk/keyvault/azure-keyvault-certificates/README.md b/sdk/keyvault/azure-keyvault-certificates/README.md index 0feb656757e8..352770cb4386 100644 --- a/sdk/keyvault/azure-keyvault-certificates/README.md +++ b/sdk/keyvault/azure-keyvault-certificates/README.md @@ -13,7 +13,7 @@ and other secrets ## Getting started ### Install the package Install [azure-keyvault-certificates][pypi_package_certificates] and -[azure-identity][azure_identity_pip] with [pip][pip]: +[azure-identity][azure_identity_pypi] with [pip][pip]: ```Bash pip install azure-keyvault-certificates azure-identity ``` @@ -382,11 +382,11 @@ additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash [azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/core/azure-core#azure-core-library-exceptions [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity -[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[azure_identity_pypi]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ -[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations.py -[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations_async.py +[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations.py +[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations_async.py [hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/hello_world.py [hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/hello_world_async.py [keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ diff --git a/sdk/keyvault/azure-keyvault-keys/README.md b/sdk/keyvault/azure-keyvault-keys/README.md index b98aaa4aa022..cbe111714817 100644 --- a/sdk/keyvault/azure-keyvault-keys/README.md +++ b/sdk/keyvault/azure-keyvault-keys/README.md @@ -15,7 +15,7 @@ create, manage, and deploy public and private SSL/TLS certificates ## Getting started ### Install packages Install [azure-keyvault-keys][pypi_package_keys] and -[azure-identity][azure_identity_pip] with [pip][pip]: +[azure-identity][azure_identity_pypi] with [pip][pip]: ```Bash pip install azure-keyvault-keys azure-identity ``` @@ -406,19 +406,18 @@ additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash [azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/core/azure-core#azure-core-library-exceptions [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity -[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[azure_identity_pypi]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ [default_cred_ref]: https://aka.ms/azsdk-python-identity-default-cred-ref [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ -[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/hello_world.py -[hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/hello_world_async.py -[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations.py -[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations_async.py -[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/list_operations.py -[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/list_operations_async.py -[recover_purge_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations.py -[recover_purge_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations_async.py -[JWK]: https://tools.ietf.org/html/rfc7517 +[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/hello_world.py +[hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/hello_world_async.py +[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations.py +[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/backup_restore_operations_async.py +[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/list_operations.py +[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/list_operations_async.py +[recover_purge_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations.py +[recover_purge_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-keys/samples/recover_purge_operations_async.py [keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ [pip]: https://pypi.org/project/pip/ [pypi_package_keys]: https://pypi.org/project/azure-keyvault-keys/ diff --git a/sdk/keyvault/azure-keyvault-secrets/README.md b/sdk/keyvault/azure-keyvault-secrets/README.md index a01e4d9e67b7..5b7b7d06a47c 100644 --- a/sdk/keyvault/azure-keyvault-secrets/README.md +++ b/sdk/keyvault/azure-keyvault-secrets/README.md @@ -15,7 +15,7 @@ create, manage, and deploy public and private SSL/TLS certificates ## Getting started ### Install packages Install [azure-keyvault-secrets][pypi_package_secrets] and -[azure-identity][azure_identity_pip] with [pip][pip]: +[azure-identity][azure_identity_pypi] with [pip][pip]: ```Bash pip install azure-keyvault-secrets azure-identity ``` @@ -384,18 +384,18 @@ additional questions or comments. [azure_cloud_shell]: https://shell.azure.com/bash [azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/core/azure-core#azure-core-library-exceptions [azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity -[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[azure_identity_pypi]: https://pypi.org/project/azure-identity/ [azure_sub]: https://azure.microsoft.com/free/ [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ [default_cred_ref]: https://aka.ms/azsdk-python-identity-default-cred-ref -[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world.py -[hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world_async.py -[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations.py -[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations_async.py -[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations.py -[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations_async.py -[recover_purge_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations.py -[recover_purge_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations_async.py +[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world.py +[hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world_async.py +[backup_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations.py +[backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/backup_restore_operations_async.py +[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations.py +[list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations_async.py +[recover_purge_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations.py +[recover_purge_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/recover_purge_operations_async.py [keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ [pypi_package_secrets]: https://pypi.org/project/azure-keyvault-secrets/ [reference_docs]: https://aka.ms/azsdk-python-keyvault-secrets-ref