Skip to content

[Key Vault] Add docstring examples for KeyVaultAccessControlClient and KeyVaultSettingsClient #34790

New issue
New issue
Open
#42196
Open
[Key Vault] Add docstring examples for KeyVaultAccessControlClient and KeyVaultSettingsClient#34790
#42196
Assignees
mccoyp
Labels
ClientThis issue points to a problem in the data-plane of the library.DocsKeyVault
Milestone
2025-09
@mccoyp

Description

@mccoyp
mccoyp
opened on Mar 15, 2024

New tracking issue for #19713.

Similarly to other client methods, our newest azure-keyvault-administration clients should have examples documented in docstrings, referencing either sample code or simple tests that demonstrate the operations clearly. For example, see KeyVaultBackupClient.begin_backup:

azure-sdk-for-python/sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_backup_client.py

Lines 87 to 93 in cda953c

Example:
.. literalinclude:: ../tests/test_examples_administration.py
:start-after: [START begin_backup]
:end-before: [END begin_backup]
:language: python
:caption: Create a vault backup
:dedent: 8

Metadata

Metadata

Assignees

Labels

ClientThis issue points to a problem in the data-plane of the library.DocsKeyVault

Type

No type

Projects

Azure SDK for Key Vault

Status

In PR

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions