diff --git a/sdk/keyvault/azure-keyvault-certificates/README.md b/sdk/keyvault/azure-keyvault-certificates/README.md index caa6b5b0125d..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] with [pip][pip]: +[azure-identity][azure_identity_pypi] with [pip][pip]: ```Bash pip install azure-keyvault-certificates azure-identity ``` @@ -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]. @@ -380,16 +380,24 @@ 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_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/ [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 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 diff --git a/sdk/keyvault/azure-keyvault-keys/README.md b/sdk/keyvault/azure-keyvault-keys/README.md index f485c09abd7a..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] with [pip][pip]: +[azure-identity][azure_identity_pypi] 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 @@ -403,17 +404,21 @@ 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_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 -[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/ -[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 [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 diff --git a/sdk/keyvault/azure-keyvault-secrets/README.md b/sdk/keyvault/azure-keyvault-secrets/README.md index ab9639f78e8b..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] with [pip][pip]: +[azure-identity][azure_identity_pypi] 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 @@ -381,17 +382,21 @@ 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_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/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 -[keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/ +[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 -[pip]: https://pypi.org/project/pip/ +[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 [secret_client_src]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets