diff --git a/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/aio/client.py b/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/aio/client.py index d152a66bc4a5..c4b7f5b4ddfd 100644 --- a/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/aio/client.py +++ b/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/aio/client.py @@ -67,7 +67,7 @@ async def create_certificate( :type tags: dict(str, str) :returns: The created CertificateOperation :rtype: coroutine - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -148,7 +148,7 @@ async def get_certificate_with_policy( :param str name: The name of the certificate in the given vault. :returns: An instance of Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -182,7 +182,7 @@ async def get_certificate( :param str version: The version of the certificate. :returns: An instance of Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -212,7 +212,7 @@ async def delete_certificate(self, name: str, **kwargs: "**Any") -> DeletedCerti :param str name: The name of the certificate. :returns: The deleted certificate :rtype: ~azure.keyvault.certificates.models.DeletedCertificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -241,7 +241,7 @@ async def get_deleted_certificate(self, name: str, **kwargs: "**Any") -> Deleted :param str name: The name of the certificate. :return: The deleted certificate :rtype: ~azure.keyvault.certificates.models.DeletedCertificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -270,7 +270,7 @@ async def purge_deleted_certificate(self, name: str, **kwargs: "**Any") -> None: :param str name: The name of the certificate :return: None :rtype: None - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ await self._client.purge_deleted_certificate( vault_base_url=self.vault_url, @@ -291,7 +291,7 @@ async def recover_deleted_certificate(self, name: str, **kwargs: "**Any") -> Cer :param str name: The name of the deleted certificate :return: The recovered certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -340,7 +340,7 @@ async def import_certificate( :type tags: dict[str, str] :returns: The imported Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ if enabled is not None: attributes = self._client.models.CertificateAttributes( @@ -371,7 +371,7 @@ async def get_policy(self, name: str, **kwargs: "**Any") -> CertificatePolicy: :param str name: The name of the certificate in a given key vault. :return: The certificate policy :rtype: ~azure.keyvault.certificates.models.CertificatePolicy - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = await self._client.get_certificate_policy( vault_base_url=self.vault_url, @@ -397,7 +397,7 @@ async def update_policy( :type policy: ~azure.keyvault.certificates.models.CertificatePolicy :return: The certificate policy :rtype: ~azure.keyvault.certificates.models.CertificatePolicy - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = await self._client.update_certificate_policy( vault_base_url=self.vault_url, @@ -429,7 +429,7 @@ async def update_certificate( :type tags: dict(str, str) :returns: The updated Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -467,7 +467,7 @@ async def backup_certificate(self, name: str, **kwargs: "**Any") -> bytes: :param str name: The name of the certificate. :return: the backup blob containing the backed up certificate. :rtype: bytes - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -494,7 +494,7 @@ async def restore_certificate(self, backup: bytes, **kwargs: "**Any") -> Certifi :param bytes backup: The backup blob associated with a certificate bundle. :return: The restored Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -530,7 +530,7 @@ def list_deleted_certificates( :return: An iterator like instance of DeletedCertificate :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.DeletedCertificate] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -566,7 +566,7 @@ def list_certificates( :returns: An iterator like instance of CertificateBase :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.CertificateBase] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -597,7 +597,7 @@ def list_certificate_versions(self, name: str, **kwargs: "**Any") -> AsyncIterab :returns: An iterator like instance of CertificateBase :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.CertificateBase] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -630,7 +630,7 @@ async def create_contacts(self, contacts: Iterable[Contact], **kwargs: "**Any") :type contacts: list[~azure.keyvault.certificates.models.Contact] :returns: The created list of contacts :rtype: list[~azure.keyvault.certificates.models.Contact] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -661,7 +661,7 @@ async def get_contacts(self, **kwargs: "**Any") -> List[Contact]: :return: The certificate contacts for the key vault. :rtype: list[azure.keyvault.certificates.models.Contact] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -687,7 +687,7 @@ async def delete_contacts(self, **kwargs: "**Any") -> List[Contact]: :return: Contacts :rtype: list[~azure.keyvault.certificates.models.Contact] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -710,7 +710,7 @@ async def get_certificate_operation(self, name: str, **kwargs: "**Any") -> Certi :param str name: The name of the certificate. :returns: The created CertificateOperation :rtype: ~azure.keyvault.certificates.models.CertificateOperation - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = await self._client.get_certificate_operation( @@ -731,7 +731,7 @@ async def delete_certificate_operation(self, name: str, **kwargs: "**Any") -> Ce :param str name: The name of the certificate. :return: The deleted CertificateOperation :rtype: ~azure.keyvault.certificates.models.CertificateOperation - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = await self._client.delete_certificate_operation( vault_base_url=self.vault_url, @@ -750,7 +750,7 @@ async def cancel_certificate_operation(self, name: str, **kwargs: "**Any") -> Ce :param str name: The name of the certificate. :returns: The cancelled certificate operation :rtype: ~azure.keyvault.certificates.models.CertificateOperation - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = await self._client.update_certificate_operation( vault_base_url=self.vault_url, @@ -773,7 +773,7 @@ async def get_pending_certificate_signing_request( :type custom_headers: dict[str, str] :return: Base64 encoded pending certificate signing request (PKCS-10). :rtype: str - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ error_map = kwargs.pop("error_map", None) vault_base_url = self.vault_url @@ -846,7 +846,7 @@ async def merge_certificate( :type tags: dict[str, str] :return: The merged certificate operation :rtype: ~azure.keyvault.certificates.models.CertificateOperation - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ if enabled is not None: attributes = self._client.models.CertificateAttributes( @@ -874,7 +874,7 @@ async def get_issuer(self, name: str, **kwargs: "**Any") -> Issuer: :param str name: The name of the issuer. :return: The specified certificate issuer. :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -919,7 +919,7 @@ async def create_issuer( :param bool enabled: Determines whether the object is enabled. :returns: The created Issuer :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -991,7 +991,7 @@ async def update_issuer( :param bool enabled: Determines whether the issuer is enabled. :return: The updated issuer :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ if account_id or password: issuer_credentials = self._client.models.IssuerCredentials(account_id=account_id, password=password) @@ -1038,7 +1038,7 @@ async def delete_issuer(self, name: str, **kwargs: "**Any") -> Issuer: :param str name: The name of the issuer. :return: Issuer :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py @@ -1065,7 +1065,7 @@ def list_issuers(self, **kwargs: "**Any") -> AsyncIterable[IssuerBase]: :return: An iterator like instance of Issuers :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.Issuer] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates_async.py diff --git a/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/client.py b/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/client.py index 69b8f6440061..757b46a85175 100644 --- a/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/client.py +++ b/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/client.py @@ -75,7 +75,7 @@ def create_certificate( :type tags: dict(str, str) :returns: The created CertificateOperation :rtype: ~azure.core.polling.LROPoller - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -154,7 +154,7 @@ def get_certificate_with_policy(self, name, **kwargs): :param str name: The name of the certificate in the given vault. :returns: An instance of Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -184,7 +184,7 @@ def get_certificate(self, name, version, **kwargs): :param str version: The version of the certificate. :returns: An instance of Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -215,7 +215,7 @@ def delete_certificate(self, name, **kwargs): :param str name: The name of the certificate. :returns: The deleted certificate :rtype: ~azure.keyvault.certificates.models.DeletedCertificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -245,7 +245,7 @@ def get_deleted_certificate(self, name, **kwargs): :param str name: The name of the certificate. :return: The deleted certificate :rtype: ~azure.keyvault.certificates.models.DeletedCertificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -275,7 +275,7 @@ def purge_deleted_certificate(self, name, **kwargs): :param str name: The name of the certificate :return: None :rtype: None - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ self._client.purge_deleted_certificate( vault_base_url=self.vault_url, @@ -297,7 +297,7 @@ def recover_deleted_certificate(self, name, **kwargs): :param str name: The name of the deleted certificate :return: The recovered certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -348,7 +348,7 @@ def import_certificate( :type tags: dict[str, str] :returns: The imported Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ if enabled is not None: attributes = self._client.models.CertificateAttributes( @@ -380,7 +380,7 @@ def get_policy(self, name, **kwargs): :param str name: The name of the certificate in a given key vault. :return: The certificate policy :rtype: ~azure.keyvault.certificates.models.CertificatePolicy - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = self._client.get_certificate_policy( vault_base_url=self.vault_url, @@ -402,7 +402,7 @@ def update_policy(self, name, policy, **kwargs): :type policy: ~azure.keyvault.certificates.models.CertificatePolicy :return: The certificate policy :rtype: ~azure.keyvault.certificates.models.CertificatePolicy - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = self._client.update_certificate_policy( vault_base_url=self.vault_url, @@ -436,7 +436,7 @@ def update_certificate( :type tags: dict(str, str) :returns: The updated Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -475,7 +475,7 @@ def backup_certificate(self, name, **kwargs): :param str name: The name of the certificate. :return: the backup blob containing the backed up certificate. :rtype: bytes - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -503,7 +503,7 @@ def restore_certificate(self, backup, **kwargs): :param bytes backup: The backup blob associated with a certificate bundle. :return: The restored Certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -536,7 +536,7 @@ def list_deleted_certificates(self, include_pending=None, **kwargs): :return: An iterator like instance of DeletedCertificate :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.DeletedCertificate] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -572,7 +572,7 @@ def list_certificates(self, include_pending=None, **kwargs): :returns: An iterator like instance of CertificateBase :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.CertificateBase] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -604,7 +604,7 @@ def list_certificate_versions(self, name, **kwargs): :returns: An iterator like instance of CertificateBase :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.CertificateBase] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -634,7 +634,7 @@ def create_contacts(self, contacts, **kwargs): :type contacts: list[~azure.keyvault.certificates.models.Contact] :returns: The created list of contacts :rtype: list[~azure.keyvault.certificates.models.Contact] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -662,7 +662,7 @@ def get_contacts(self, **kwargs): :return: The certificate contacts for the key vault. :rtype: list[~azure.keyvault.certificates.models.Contact] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -685,7 +685,7 @@ def delete_contacts(self, **kwargs): :return: Contacts :rtype: list[~azure.keyvault.certificates.models.Contact] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -709,7 +709,7 @@ def get_certificate_operation(self, name, **kwargs): :param str name: The name of the certificate. :returns: The created CertificateOperation :rtype: ~azure.keyvault.certificates.models.CertificateOperation - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = self._client.get_certificate_operation( @@ -731,7 +731,7 @@ def delete_certificate_operation(self, name, **kwargs): :param str name: The name of the certificate. :return: The deleted CertificateOperation :rtype: ~azure.keyvault.certificates.models.CertificateOperation - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = self._client.delete_certificate_operation( vault_base_url=self.vault_url, @@ -751,7 +751,7 @@ def cancel_certificate_operation(self, name, **kwargs): :param str name: The name of the certificate. :returns: The cancelled certificate operation :rtype: ~azure.keyvault.certificates.models.CertificateOperation - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ bundle = self._client.update_certificate_operation( vault_base_url=self.vault_url, @@ -787,7 +787,7 @@ def merge_certificate( :type tags: dict[str, str] :return: The merged certificate :rtype: ~azure.keyvault.certificates.models.Certificate - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ if enabled is not None: attributes = self._client.models.CertificateAttributes( @@ -819,7 +819,7 @@ def get_pending_certificate_signing_request( :type custom_headers: dict[str, str] :return: Base64 encoded pending certificate signing request (PKCS-10). :rtype: str - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ error_map = kwargs.pop("error_map", None) vault_base_url = self.vault_url @@ -876,7 +876,7 @@ def get_issuer(self, name, **kwargs): :param str name: The name of the issuer. :return: The specified certificate issuer. :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -922,7 +922,7 @@ def create_issuer( :param bool enabled: Determines whether the object is enabled. :returns: The created Issuer :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -995,7 +995,7 @@ def update_issuer( :param bool enabled: Determines whether the issuer is enabled. :return: The updated issuer :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` """ if account_id or password: issuer_credentials = self._client.models.IssuerCredentials(account_id=account_id, password=password) @@ -1043,7 +1043,7 @@ def delete_issuer(self, name, **kwargs): :param str name: The name of the issuer. :return: Issuer :rtype: ~azure.keyvault.certificates.models.Issuer - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py @@ -1071,7 +1071,7 @@ def list_issuers(self, **kwargs): :return: An iterator like instance of Issuers :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.Issuer] - :raises: ~azure.core.exceptions.HttpResponseError + :raises: :class:`~azure.core.exceptions.HttpResponseError` Example: .. literalinclude:: ../tests/test_examples_certificates.py diff --git a/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/client.py b/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/client.py index c54c274be3f5..6a59bcdf9370 100644 --- a/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/client.py +++ b/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/client.py @@ -204,7 +204,7 @@ async def delete_key(self, name: str, **kwargs: "**Any") -> DeletedKey: :param str name: The name of the key to delete. :returns: The deleted key :rtype: ~azure.keyvault.keys.models.DeletedKey - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys_async.py @@ -225,7 +225,7 @@ async def get_key(self, name: str, version: Optional[str] = None, **kwargs: "**A :param str version: (optional) A specific version of the key to get. If not specified, gets the latest version of the key. :rtype: ~azure.keyvault.keys.models.Key - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys_async.py @@ -405,7 +405,7 @@ async def update_key( :param dict tags: (optional) Application specific metadata in the form of key-value pairs :returns: The updated key :rtype: ~azure.keyvault.keys.models.Key - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys_async.py @@ -443,7 +443,7 @@ async def backup_key(self, name: str, **kwargs: "**Any") -> bytes: :param str name: The name of the key :returns: The raw bytes of the key backup :rtype: bytes - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys_async.py @@ -469,7 +469,7 @@ async def restore_key(self, backup: bytes, **kwargs: "**Any") -> Key: :param bytes backup: The raw bytes of the key backup :returns: The restored key :rtype: ~azure.keyvault.keys.models.Key - :raises: ~azure.core.exceptions.ResourceExistsError if the backed up key's name is already in use + :raises: :class:`~azure.core.exceptions.ResourceExistsError` if the backed up key's name is already in use Example: .. literalinclude:: ../tests/test_samples_keys_async.py diff --git a/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/client.py b/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/client.py index 9f47a030da27..0f73ee1b2cfe 100644 --- a/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/client.py +++ b/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/client.py @@ -218,7 +218,7 @@ def delete_key(self, name, **kwargs): :param str name: The name of the key to delete. :returns: The deleted key :rtype: ~azure.keyvault.keys.models.DeletedKey - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys.py @@ -240,7 +240,7 @@ def get_key(self, name, version=None, **kwargs): :param str version: (optional) A specific version of the key to get. If not specified, gets the latest version of the key. :rtype: ~azure.keyvault.keys.models.Key - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys.py @@ -431,7 +431,7 @@ def update_key( :param dict tags: (optional) Application specific metadata in the form of key-value pairs :returns: The updated key :rtype: ~azure.keyvault.keys.models.Key - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys.py @@ -469,7 +469,7 @@ def backup_key(self, name, **kwargs): :param str name: The name of the key :returns: The raw bytes of the key backup :rtype: bytes - :raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist Example: .. literalinclude:: ../tests/test_samples_keys.py @@ -494,7 +494,7 @@ def restore_key(self, backup, **kwargs): :param bytes backup: The raw bytes of the key backup :returns: The restored key :rtype: ~azure.keyvault.keys.models.Key - :raises: ~azure.core.exceptions.ResourceExistsError if the backed up key's name is already in use + :raises: :class:`~azure.core.exceptions.ResourceExistsError` if the backed up key's name is already in use Example: .. literalinclude:: ../tests/test_samples_keys.py diff --git a/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/aio/client.py b/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/aio/client.py index 36c6dc97e2c4..1cc520edb3d0 100644 --- a/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/aio/client.py +++ b/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/aio/client.py @@ -38,7 +38,7 @@ async def get_secret(self, name: str, version: Optional[str] = None, **kwargs: " :param str name: The name of the secret :param str version: (optional) Version of the secret to get. If unspecified, gets the latest version. :rtype: ~azure.keyvault.secrets.models.Secret - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets_async.py @@ -118,7 +118,7 @@ async def update_secret( :param datetime.datetime expires: (optional) Expiry date of the secret in UTC. :param dict(str, str) tags: (optional) Application specific metadata in the form of key-value pairs. :rtype: ~azure.keyvault.secrets.models.SecretAttributes - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets_async.py @@ -201,7 +201,7 @@ async def backup_secret(self, name: str, **kwargs: "**Any") -> bytes: :param str name: Name of the secret :returns: The raw bytes of the secret backup :rtype: bytes - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets_async.py @@ -223,7 +223,7 @@ async def restore_secret(self, backup: bytes, **kwargs: "**Any") -> SecretAttrib :param bytes backup: The raw bytes of the secret backup :returns: The restored secret :rtype: ~azure.keyvault.secrets.models.SecretAttributes - :raises: ~azure.core.exceptions.ResourceExistsError if the secret's name is already in use + :raises: :class:`~azure.core.exceptions.ResourceExistsError` if the secret's name is already in use Example: .. literalinclude:: ../tests/test_samples_secrets_async.py @@ -244,7 +244,7 @@ async def delete_secret(self, name: str, **kwargs: "**Any") -> DeletedSecret: :param str name: Name of the secret :rtype: ~azure.keyvault.secrets.models.DeletedSecret - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets_async.py @@ -266,7 +266,7 @@ async def get_deleted_secret(self, name: str, **kwargs: "**Any") -> DeletedSecre :param str name: Name of the secret :rtype: ~azure.keyvault.secrets.models.DeletedSecret - :raises: ~azure.core.exceptions.ResourceNotFoundError if the deleted secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the deleted secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets_async.py diff --git a/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/client.py b/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/client.py index 0dd383651465..3170d8949e5c 100644 --- a/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/client.py +++ b/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/client.py @@ -46,7 +46,7 @@ def get_secret(self, name, version=None, **kwargs): :param str name: The name of the secret :param str version: (optional) Version of the secret to get. If unspecified, gets the latest version. :rtype: ~azure.keyvault.secrets.models.Secret - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets.py @@ -139,7 +139,7 @@ def update_secret( :param datetime.datetime expires: (optional) Expiry date of the secret in UTC. :param dict tags: (optional) Application specific metadata in the form of key-value pairs :rtype: ~azure.keyvault.secrets.models.SecretAttributes - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets.py @@ -228,7 +228,7 @@ def backup_secret(self, name, **kwargs): :param str name: Name of the secret :returns: The raw bytes of the secret backup :rtype: bytes - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets.py @@ -252,7 +252,7 @@ def restore_secret(self, backup, **kwargs): :param bytes backup: The raw bytes of the secret backup :returns: The restored secret :rtype: ~azure.keyvault.secrets.models.SecretAttributes - :raises: ~azure.core.exceptions.ResourceExistsError if the secret's name is already in use + :raises: :class:`~azure.core.exceptions.ResourceExistsError` if the secret's name is already in use Example: .. literalinclude:: ../tests/test_samples_secrets.py @@ -273,7 +273,7 @@ def delete_secret(self, name, **kwargs): :param str name: Name of the secret :rtype: ~azure.keyvault.secrets.models.DeletedSecret - :raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets.py @@ -295,7 +295,7 @@ def get_deleted_secret(self, name, **kwargs): :param str name: Name of the secret :rtype: ~azure.keyvault.secrets.models.DeletedSecret - :raises: ~azure.core.exceptions.ResourceNotFoundError if the deleted secret doesn't exist + :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the deleted secret doesn't exist Example: .. literalinclude:: ../tests/test_samples_secrets.py