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.

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

Azconfig docs update before release #19623

Merged
3 commits merged into from
Jul 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 3 additions & 6 deletions sdk/appconfiguration/azure-appconfiguration/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@

## 1.2.0 (2021-07-06)
### Features Added

### Breaking Changes

### Key Bugs Fixed

### Fixed
* Adds `FeatureFlagConfigurationSetting` and `SecretReferenceConfigurationSetting` models
* `AzureAppConfigurationClient` can now be used as a context manager.
* Adds `update_sync_token` to update sync tokens from Event Grid notifications.

## 1.2.0b2 (2021-06-08)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@


class AzureAppConfigurationClient:
"""Represents an client that calls restful API of Azure App Configuration service.
# pylint:disable=line-too-long
"""Represents a client that calls restful API of Azure App Configuration service.

:param str base_url: base url of the service
:param credential: An object which can provide secrets for the app configuration service
:type credential: :class:`~azure.appconfiguration.AppConfigConnectionStringCredential`
or :class:`~azure.core.credentials.TokenCredential`
:type credential: :class:`~azure.appconfiguration.AppConfigConnectionStringCredential` or :class:`~azure.core.credentials.TokenCredential`

"""

Expand Down Expand Up @@ -223,7 +223,7 @@ def get_configuration_setting(

:param key: key of the ConfigurationSetting
:type key: str
:param label: label of the ConfigurationSetting
:param label: label used to identify the ConfigurationSetting. Default is `None`.
:type label: str
:param etag: check if the ConfigurationSetting is changed. Set None to skip checking etag
:type etag: str or None
Expand Down Expand Up @@ -390,7 +390,7 @@ def delete_configuration_setting(self, key, label=None, **kwargs):

:param key: key used to identify the ConfigurationSetting
:type key: str
:param label: label used to identify the ConfigurationSetting
:param label: label used to identify the ConfigurationSetting. Default is `None`.
:type label: str
:keyword str etag: check if the ConfigurationSetting is changed. Set None to skip checking etag
:keyword match_condition: The match condition to use upon the etag
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@


class AzureAppConfigurationClient:
"""Represents an client that calls restful API of Azure App Configuration service.
# pylint:disable=line-too-long
"""Represents a client that calls restful API of Azure App Configuration service.

:param str base_url: base url of the service
:param credential: An object which can provide secrets for the app configuration service
:type credential: :class:`azure.appconfiguration.AppConfigConnectionStringCredential` or
:class:`~azure.core.credentials_async.AsyncTokenCredential`
:type credential: :class:`azure.appconfiguration.AppConfigConnectionStringCredential` or :class:`~azure.core.credentials_async.AsyncTokenCredential`

This is the async version of :class:`azure.appconfiguration.AzureAppConfigurationClient`

Expand Down Expand Up @@ -240,7 +240,7 @@ async def get_configuration_setting(

:param key: key of the ConfigurationSetting
:type key: str
:param label: label of the ConfigurationSetting
:param label: label used to identify the ConfigurationSetting. Default is `None`.
:type label: str
:param etag: check if the ConfigurationSetting is changed. Set None to skip checking etag
:type etag: str or None
Expand Down Expand Up @@ -420,7 +420,7 @@ async def delete_configuration_setting(

:param key: key used to identify the ConfigurationSetting
:type key: str
:param label: label used to identify the ConfigurationSetting
:param label: label used to identify the ConfigurationSetting. Default is `None`.
:type label: str
:keyword str etag: check if the ConfigurationSetting is changed. Set None to skip checking etag
:keyword match_condition: The match condition to use upon the etag
Expand Down