dedent examples

sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/_client.py

@@ -20,6 +20,7 @@ class KeyClient(_KeyVaultClientBase):
  :end-before: [END create_key_client]
  :language: python
  :caption: Creates a new instance of the Key client
+ :dedent: 4
  """
 
  # pylint:disable=protected-access
@@ -79,6 +80,7 @@ def create_key(
  :end-before: [END create_key]
  :language: python
  :caption: Creates a key in the key vault
+ :dedent: 8
  """
  if enabled is not None or not_before is not None or expires is not None:
  attributes = self._client.models.KeyAttributes(enabled=enabled, not_before=not_before, expires=expires)
@@ -146,6 +148,7 @@ def create_rsa_key(
  :end-before: [END create_rsa_key]
  :language: python
  :caption: Creates a RSA key in the key vault
+ :dedent: 8
  """
  key_type = "RSA-HSM" if hsm else "RSA"
 
@@ -211,6 +214,7 @@ def create_ec_key(
  :end-before: [END create_ec_key]
  :language: python
  :caption: Creates an EC key in the key vault
+ :dedent: 8
  """
 
  key_type = "EC-HSM" if hsm else "EC"
@@ -249,6 +253,7 @@ def delete_key(self, name, **kwargs):
  :end-before: [END delete_key]
  :language: python
  :caption: Deletes a key in the key vault
+ :dedent: 8
  """
  bundle = self._client.delete_key(self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs)
  return DeletedKey._from_deleted_key_bundle(bundle)
@@ -276,6 +281,7 @@ def get_key(self, name, version=None, **kwargs):
  :end-before: [END get_key]
  :language: python
  :caption: Retrieves a key from the key vault
+ :dedent: 8
  """
  bundle = self._client.get_key(
  self.vault_url, name, key_version=version or "", error_map={404: ResourceNotFoundError}, **kwargs
@@ -302,6 +308,7 @@ def get_deleted_key(self, name, **kwargs):
  :end-before: [END get_deleted_key]
  :language: python
  :caption: Retrieves a deleted key from the key vault
+ :dedent: 8
  """
  bundle = self._client.get_deleted_key(self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs)
  return DeletedKey._from_deleted_key_bundle(bundle)
@@ -328,6 +335,7 @@ def list_deleted_keys(self, **kwargs):
  :end-before: [END list_deleted_keys]
  :language: python
  :caption: List all the deleted keys in the vault
+ :dedent: 8
  """
  max_page_size = kwargs.get("max_page_size", None)
  pages = self._client.get_deleted_keys(self._vault_url, maxresults=max_page_size, **kwargs)
@@ -354,6 +362,7 @@ def list_keys(self, **kwargs):
  :end-before: [END list_keys]
  :language: python
  :caption: List all keys in the vault
+ :dedent: 8
  """
  max_page_size = kwargs.get("max_page_size", None)
  pages = self._client.get_keys(self._vault_url, maxresults=max_page_size, **kwargs)
@@ -378,6 +387,7 @@ def list_key_versions(self, name, **kwargs):
  :end-before: [END list_key_versions]
  :language: python
  :caption: List all versions of the specified key
+ :dedent: 8
  """
  max_page_size = kwargs.get("max_page_size", None)
  pages = self._client.get_key_versions(self._vault_url, name, maxresults=max_page_size, **kwargs)
@@ -429,6 +439,7 @@ def recover_deleted_key(self, name, **kwargs):
  :end-before: [END recover_deleted_key]
  :language: python
  :caption: Recovers the specified soft-deleted key
+ :dedent: 8
  """
  bundle = self._client.recover_deleted_key(self.vault_url, name, kwargs)
  return Key._from_key_bundle(bundle)
@@ -472,6 +483,7 @@ def update_key(
  :end-before: [END update_key]
  :language: python
  :caption: Updates a key in the key vault
+ :dedent: 8
  """
  if enabled is not None or not_before is not None or expires is not None:
  attributes = self._client.models.KeyAttributes(enabled=enabled, not_before=not_before, expires=expires)
@@ -521,6 +533,7 @@ def backup_key(self, name, **kwargs):
  :end-before: [END backup_key]
  :language: python
  :caption: Backs up the specified key to the key vault
+ :dedent: 8
  """
  backup_result = self._client.backup_key(self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs)
  return backup_result.value
@@ -556,6 +569,7 @@ def restore_key(self, backup, **kwargs):
  :end-before: [END restore_key]
  :language: python
  :caption: Restores a backed up key to the vault
+ :dedent: 8
  """
  bundle = self._client.restore_key(self.vault_url, backup, error_map={409: ResourceExistsError}, **kwargs)
  return Key._from_key_bundle(bundle)

sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/_client.py

@@ -20,6 +20,7 @@ class KeyClient(_AsyncKeyVaultClientBase):
  :end-before: [END create_key_client]
  :language: python
  :caption: Creates a new instance of the Key client
+ :dedent: 4
  """
 
  # pylint:disable=protected-access
@@ -46,6 +47,7 @@ async def get_key(self, name: str, version: Optional[str] = None, **kwargs: Mapp
  :end-before: [END get_key]
  :language: python
  :caption: Retrieves a key from the key vault
+ :dedent: 8
  """
  if version is None:
  version = ""
@@ -109,6 +111,7 @@ async def create_key(
  :end-before: [END create_key]
  :language: python
  :caption: Creates a key in the key vault
+ :dedent: 8
  """
  if enabled is not None or not_before is not None or expires is not None:
  attributes = self._client.models.KeyAttributes(enabled=enabled, not_before=not_before, expires=expires)
@@ -175,6 +178,7 @@ async def create_rsa_key(
  :end-before: [END create_rsa_key]
  :language: python
  :caption: Creates an RSA key in the key vault
+ :dedent: 8
  """
  key_type = "RSA-HSM" if hsm else "RSA"
 
@@ -239,6 +243,7 @@ async def create_ec_key(
  :end-before: [END create_ec_key]
  :language: python
  :caption: Creates an EC key in the key vault
+ :dedent: 8
  """
  key_type = "EC-HSM" if hsm else "EC"
 
@@ -300,6 +305,7 @@ async def update_key(
  :end-before: [END update_key]
  :language: python
  :caption: Updates a key in the key vault
+ :dedent: 8
  """
  if enabled is not None or not_before is not None or expires is not None:
  attributes = self._client.models.KeyAttributes(enabled=enabled, not_before=not_before, expires=expires)
@@ -338,6 +344,7 @@ def list_keys(self, **kwargs: Mapping[str, Any]) -> AsyncIterable[KeyBase]:
  :end-before: [END list_keys]
  :language: python
  :caption: List all keys in the vault
+ :dedent: 8
  """
  max_results = kwargs.get("max_page_size")
  pages = self._client.get_keys(self.vault_url, maxresults=max_results, **kwargs)
@@ -362,6 +369,7 @@ def list_key_versions(self, name: str, **kwargs: Mapping[str, Any]) -> AsyncIter
  :end-before: [END list_key_versions]
  :language: python
  :caption: List all versions of the specified key
+ :dedent: 8
  """
  max_results = kwargs.get("max_page_size")
  pages = self._client.get_key_versions(self.vault_url, name, maxresults=max_results, **kwargs)
@@ -398,6 +406,7 @@ async def backup_key(self, name: str, **kwargs: Mapping[str, Any]) -> bytes:
  :end-before: [END backup_key]
  :language: python
  :caption: Backs up the specified key to the key vault
+ :dedent: 8
  """
  backup_result = await self._client.backup_key(
  self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs
@@ -434,6 +443,7 @@ async def restore_key(self, backup: bytes, **kwargs: Mapping[str, Any]) -> Key:
  :end-before: [END restore_key]
  :language: python
  :caption: Restores a backed up key to the vault
+ :dedent: 8
  """
  bundle = await self._client.restore_key(self.vault_url, backup, error_map={409: ResourceExistsError}, **kwargs)
  return Key._from_key_bundle(bundle)
@@ -459,6 +469,7 @@ async def delete_key(self, name: str, **kwargs: Mapping[str, Any]) -> DeletedKey
  :end-before: [END delete_key]
  :language: python
  :caption: Deletes a key in the key vault
+ :dedent: 8
  """
  bundle = await self._client.delete_key(self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs)
  return DeletedKey._from_deleted_key_bundle(bundle)
@@ -483,6 +494,7 @@ async def get_deleted_key(self, name: str, **kwargs: Mapping[str, Any]) -> Delet
  :end-before: [END get_deleted_key]
  :language: python
  :caption: Retrieves a deleted key from the key vault
+ :dedent: 8
  """
  bundle = await self._client.get_deleted_key(
  self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs
@@ -510,6 +522,7 @@ def list_deleted_keys(self, **kwargs: Mapping[str, Any]) -> AsyncIterable[Delete
  :end-before: [END list_deleted_keys]
  :language: python
  :caption: List all the deleted keys in the vault
+ :dedent: 8
  """
  max_results = kwargs.get("max_page_size")
  pages = self._client.get_deleted_keys(self.vault_url, maxresults=max_results, **kwargs)
@@ -560,6 +573,7 @@ async def recover_deleted_key(self, name: str, **kwargs: Mapping[str, Any]) -> K
  :end-before: [END recover_deleted_key]
  :language: python
  :caption: Recovers the specified soft-deleted key
+ :dedent: 8
  """
  bundle = await self._client.recover_deleted_key(self.vault_url, name, **kwargs)
  return Key._from_key_bundle(bundle)

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_client.py

@@ -20,6 +20,7 @@ class SecretClient(_KeyVaultClientBase):
  :end-before: [END create_secret_client]
  :language: python
  :caption: Creates a new instance of the Secret client
+ :dedent: 4
  """
 
  # pylint:disable=protected-access
@@ -44,6 +45,7 @@ def get_secret(self, name, version=None, **kwargs):
  :end-before: [END get_secret]
  :language: python
  :caption: Get secret from the key vault
+ :dedent: 8
  """
  bundle = self._client.get_secret(
  self._vault_url, name, version or "", error_map={404: ResourceNotFoundError}, **kwargs
@@ -80,6 +82,7 @@ def set_secret(
  :end-before: [END set_secret]
  :language: python
  :caption: Set a secret in the key vault
+ :dedent: 8
 
  """
  if enabled is not None or not_before is not None or expires is not None:
@@ -122,6 +125,7 @@ def update_secret(
  :end-before: [END update_secret]
  :language: python
  :caption: Updates the attributes associated with a specified secret in the key vault
+ :dedent: 8
 
  """
  if enabled is not None or not_before is not None or expires is not None:
@@ -159,6 +163,7 @@ def list_secrets(self, **kwargs):
  :end-before: [END list_secrets]
  :language: python
  :caption: Lists all the secrets in the vault
+ :dedent: 8
 
  """
  max_page_size = kwargs.get("max_page_size", None)
@@ -184,6 +189,7 @@ def list_secret_versions(self, name, **kwargs):
  :end-before: [END list_secret_versions]
  :language: python
  :caption: List all versions of the specified secret
+ :dedent: 8
 
  """
  max_page_size = kwargs.get("max_page_size", None)
@@ -209,6 +215,7 @@ def backup_secret(self, name, **kwargs):
  :end-before: [END backup_secret]
  :language: python
  :caption: Backs up the specified secret
+ :dedent: 8
 
  """
  backup_result = self._client.backup_secret(
@@ -234,6 +241,7 @@ def restore_secret(self, backup, **kwargs):
  :end-before: [END restore_secret]
  :language: python
  :caption: Restores a backed up secret to the vault
+ :dedent: 8
 
  """
  bundle = self._client.restore_secret(self.vault_url, backup, error_map={409: ResourceExistsError}, **kwargs)
@@ -258,6 +266,7 @@ def delete_secret(self, name, **kwargs):
  :end-before: [END delete_secret]
  :language: python
  :caption: Deletes a secret
+ :dedent: 8
 
  """
  bundle = self._client.delete_secret(self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs)
@@ -281,6 +290,7 @@ def get_deleted_secret(self, name, **kwargs):
  :end-before: [END get_deleted_secret]
  :language: python
  :caption: Gets the deleted secret
+ :dedent: 8
 
  """
  bundle = self._client.get_deleted_secret(self.vault_url, name, error_map={404: ResourceNotFoundError}, **kwargs)
@@ -304,6 +314,7 @@ def list_deleted_secrets(self, **kwargs):
  :end-before: [END list_deleted_secrets]
  :language: python
  :caption: Lists the deleted secrets of the vault
+ :dedent: 8
 
  """
  max_page_size = kwargs.get("max_page_size", None)
@@ -351,6 +362,7 @@ def recover_deleted_secret(self, name, **kwargs):
  :end-before: [END recover_deleted_secret]
  :language: python
  :caption: Restores a backed up secret to the vault
+ :dedent: 8
 
  """
  bundle = self._client.recover_deleted_secret(self.vault_url, name, **kwargs)