Skip to content

DOC: add Example sections to snapshot and list_labels methods in Azur… #47963

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

Open
shoumikchakravarty-dev wants to merge 2 commits into
base: main
Choose a base branch
from
+92 −0
Open

DOC: add Example sections to snapshot and list_labels methods in Azur… #47963

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
c5227c8
DOC: add Example sections to snapshot and list_labels methods in Azur…
shoumikchakravarty-dev Jul 9, 2026
0b02e79
Merge branch 'main' into DOC/add-examples-appconfiguration-snapshot-m…
shoumikchakravarty-dev Jul 9, 2026
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
46 changes: 46 additions & 0 deletions ...iguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,13 @@ def list_labels(
:return: An iterator of labels.
:rtype: ~azure.core.paging.ItemPaged[~azure.appconfiguration.ConfigurationSettingLabel]
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

for label in client.list_labels():
print(label)
"""
if isinstance(accept_datetime, datetime):
accept_datetime = str(accept_datetime)
Expand Down Expand Up @@ -705,6 +712,17 @@ def begin_create_snapshot(
operation to complete and get the created snapshot.
:rtype: ~azure.core.polling.LROPoller[~azure.appconfiguration.ConfigurationSnapshot]
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

from azure.appconfiguration import ConfigurationSettingsFilter

filters = [ConfigurationSettingsFilter(key="my_key", label="my_label")]
response = client.begin_create_snapshot(name="my_snapshot", filters=filters)
created_snapshot = response.result()
print(created_snapshot)
"""
snapshot = ConfigurationSnapshot(
filters=filters,
Expand Down Expand Up @@ -741,6 +759,13 @@ def archive_snapshot(
:return: The ConfigurationSnapshot returned from the service.
:rtype: ~azure.appconfiguration.ConfigurationSnapshot
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

archived_snapshot = client.archive_snapshot(name="my_snapshot")
print(archived_snapshot.status)
"""
generated_snapshot = self._impl._update_snapshot(
name=name,
Expand Down Expand Up @@ -771,6 +796,13 @@ def recover_snapshot(
:return: The ConfigurationSnapshot returned from the service.
:rtype: ~azure.appconfiguration.ConfigurationSnapshot
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

recovered_snapshot = client.recover_snapshot(name="my_snapshot")
print(recovered_snapshot.status)
"""
generated_snapshot = self._impl._update_snapshot(
name=name,
Expand All @@ -795,6 +827,13 @@ def get_snapshot(
:return: The ConfigurationSnapshot returned from the service.
:rtype: ~azure.appconfiguration.ConfigurationSnapshot
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

received_snapshot = client.get_snapshot(name="my_snapshot")
print(received_snapshot)
"""
generated_snapshot = self._impl.get_snapshot(name=name, select=fields, **kwargs)
return ConfigurationSnapshot._from_generated(generated_snapshot)
Expand Down Expand Up @@ -822,6 +861,13 @@ def list_snapshots(
:return: An iterator of :class:`~azure.appconfiguration.ConfigurationSnapshot`
:rtype: ~azure.core.paging.ItemPaged[~azure.appconfiguration.ConfigurationSnapshot]
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

for snapshot in client.list_snapshots():
print(snapshot)
"""
return self._impl.get_snapshots( # type: ignore[return-value]
name=name,
Expand Down
46 changes: 46 additions & 0 deletions ...azure-appconfiguration/azure/appconfiguration/aio/_azure_appconfiguration_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,13 @@ def list_labels(
:return: An async iterator of labels.
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.appconfiguration.ConfigurationSettingLabel]
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

async for label in client.list_labels():
print(label)
"""
if isinstance(accept_datetime, datetime):
accept_datetime = str(accept_datetime)
Expand Down Expand Up @@ -718,6 +725,17 @@ async def begin_create_snapshot(
operation to complete and get the created snapshot.
:rtype: ~azure.core.polling.LROPoller[~azure.appconfiguration.ConfigurationSnapshot]
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

from azure.appconfiguration import ConfigurationSettingsFilter

filters = [ConfigurationSettingsFilter(key="my_key", label="my_label")]
response = await client.begin_create_snapshot(name="my_snapshot", filters=filters)
created_snapshot = await response.result()
print(created_snapshot)
"""
snapshot = ConfigurationSnapshot(
filters=filters,
Expand Down Expand Up @@ -754,6 +772,13 @@ async def archive_snapshot(
:return: The ConfigurationSnapshot returned from the service.
:rtype: ~azure.appconfiguration.ConfigurationSnapshot
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

archived_snapshot = await client.archive_snapshot(name="my_snapshot")
print(archived_snapshot.status)
"""
generated_snapshot = await self._impl._update_snapshot(
name=name,
Expand Down Expand Up @@ -784,6 +809,13 @@ async def recover_snapshot(
:return: The ConfigurationSnapshot returned from the service.
:rtype: ~azure.appconfiguration.ConfigurationSnapshot
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

recovered_snapshot = await client.recover_snapshot(name="my_snapshot")
print(recovered_snapshot.status)
"""
generated_snapshot = await self._impl._update_snapshot(
name=name,
Expand All @@ -808,6 +840,13 @@ async def get_snapshot(
:return: The ConfigurationSnapshot returned from the service.
:rtype: ~azure.appconfiguration.ConfigurationSnapshot
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

received_snapshot = await client.get_snapshot(name="my_snapshot")
print(received_snapshot)
"""
generated_snapshot = await self._impl.get_snapshot(name=name, select=fields, **kwargs)
return ConfigurationSnapshot._from_generated(generated_snapshot)
Expand Down Expand Up @@ -835,6 +874,13 @@ def list_snapshots(
:return: An iterator of :class:`~azure.appconfiguration.ConfigurationSnapshot`
:rtype: ~azure.core.paging.ItemPaged[~azure.appconfiguration.ConfigurationSnapshot]
:raises: :class:`~azure.core.exceptions.HttpResponseError`

Example

.. code-block:: python

async for snapshot in client.list_snapshots():
print(snapshot)
"""
return self._impl.get_snapshots( # type: ignore[return-value]
name=name,
Expand Down
Loading