Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

class links with extra text need :class: #7215

Merged
merged 2 commits into from
Sep 12, 2019
Merged

class links with extra text need :class: #7215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7c28cc
class links with extra text need :class:
bryevdv Sep 11, 2019
4a436eb
use explicit syntax in azure-keyvault-certificates
chlowell Sep 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/aio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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(
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading