[Appconfig] consistency check

sdk/appconfiguration/azure-appconfiguration/CHANGELOG.md

@@ -1,7 +1,13 @@
 # Release History
 
 ## 1.2.0 (2021-07-06)
+### Features Added
 
+### Breaking Changes
+
+### Key Bugs Fixed
+
+### Fixed
 
 ## 1.2.0b2 (2021-06-08)
 

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/__init__.py

@@ -10,7 +10,7 @@
 # --------------------------------------------------------------------------
 
 from ._azure_appconfiguration_client import AzureAppConfigurationClient
-from ._constants import PERCENTAGE, TARGETING, TIME_WINDOW
+from ._constants import FILTER_PERCENTAGE, FILTER_TARGETING, FILTER_TIME_WINDOW
 from ._models import (
     ConfigurationSetting,
     FeatureFlagConfigurationSetting,
@@ -26,7 +26,7 @@
     "ResourceReadOnlyError",
     "FeatureFlagConfigurationSetting",
     "SecretReferenceConfigurationSetting",
-    "PERCENTAGE",
-    "TARGETING",
-    "TIME_WINDOW",
+    "FILTER_PERCENTAGE",
+    "FILTER_TARGETING",
+    "FILTER_TIME_WINDOW",
 ]

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py

@@ -4,7 +4,7 @@
 # license information.
 # -------------------------------------------------------------------------
 import binascii
-from typing import Optional, Any, Mapping, Union
+from typing import Optional, Any, Union, Mapping, TYPE_CHECKING
 from requests.structures import CaseInsensitiveDict
 from azure.core import MatchConditions
 from azure.core.pipeline import Pipeline
@@ -39,13 +39,9 @@
 from ._sync_token import SyncTokenPolicy
 from ._user_agent import USER_AGENT
 
-try:
-    from typing import TYPE_CHECKING
-except ImportError:
-    TYPE_CHECKING = False
-
 if TYPE_CHECKING:
     from azure.core.paging import ItemPaged
+    from azure.core.credentials import TokenCredential
 
 
 class AzureAppConfigurationClient:
@@ -54,16 +50,14 @@ class AzureAppConfigurationClient:
     :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`
-    :keyword Pipeline pipeline: If omitted, the standard pipeline is used.
-    :keyword HttpTransport transport: If omitted, the standard pipeline is used.
-    :keyword list[HTTPPolicy] policies: If omitted, the standard pipeline is used.
+        or :class:`~azure.core.credentials.TokenCredential`
 
     """
 
     # pylint:disable=protected-access
 
     def __init__(self, base_url, credential, **kwargs):
-        # type: (str, Any, **Any) -> None
+        # type: (str, Union[AppConfigConnectionStringCredential, TokenCredential], **Any) -> None
         try:
             if not base_url.lower().startswith("http"):
                 base_url = "https://" + base_url
@@ -76,7 +70,7 @@ def __init__(self, base_url, credential, **kwargs):
         self._credential_scopes = base_url.strip("/") + "/.default"
 
         self._config = AzureAppConfigurationConfiguration(
-            credential, base_url, credential_scopes=self._credential_scopes, **kwargs
+            credential, base_url, credential_scopes=self._credential_scopes, **kwargs  # type: ignore
         )
         self._config.user_agent_policy = UserAgentPolicy(
             base_user_agent=USER_AGENT, **kwargs
@@ -92,7 +86,7 @@ def __init__(self, base_url, credential, **kwargs):
             )
 
         self._impl = AzureAppConfiguration(
-            credential, base_url, pipeline=pipeline, credential_scopes=self._credential_scopes
+            credential, base_url, pipeline=pipeline, credential_scopes=self._credential_scopes  # type: ignore
         )
 
     @classmethod
@@ -172,7 +166,6 @@ def list_configuration_settings(
         :type label_filter: str
         :keyword datetime accept_datetime: filter out ConfigurationSetting created after this datetime
         :keyword list[str] fields: specify which fields to include in the results. Leave None to include all fields
-        :keyword dict headers: if "headers" exists, its value (a dict) will be added to the http request header
         :return: An iterator of :class:`ConfigurationSetting`
         :rtype: ~azure.core.paging.ItemPaged[ConfigurationSetting]
         :raises: :class:`HttpResponseError`, :class:`ClientAuthenticationError`
@@ -226,7 +219,6 @@ def get_configuration_setting(
         match_condition=MatchConditions.Unconditionally,  # type: Optional[MatchConditions]
         **kwargs  # type: Any
     ):  # type: (...) -> Union[None, ConfigurationSetting]
-
         """Get the matched ConfigurationSetting from Azure App Configuration service
 
         :param key: key of the ConfigurationSetting
@@ -238,7 +230,6 @@ def get_configuration_setting(
         :param match_condition: The match condition to use upon the etag
         :type match_condition: :class:`~azure.core.MatchConditions`
         :keyword datetime accept_datetime: the retrieved ConfigurationSetting that created no later than this datetime
-        :keyword dict headers: if "headers" exists, its value (a dict) will be added to the http request header
         :return: The matched ConfigurationSetting object
         :rtype: :class:`~azure.appconfiguration.ConfigurationSetting`
         :raises: :class:`HttpResponseError`, :class:`ClientAuthenticationError`, \
@@ -288,7 +279,6 @@ def add_configuration_setting(self, configuration_setting, **kwargs):
 
         :param configuration_setting: the ConfigurationSetting object to be added
         :type configuration_setting: :class:`~azure.appconfiguration.ConfigurationSetting`
-        :keyword dict headers: if "headers" exists, its value (a dict) will be added to the http request header
         :return: The ConfigurationSetting object returned from the App Configuration service
         :rtype: :class:`~azure.appconfiguration.ConfigurationSetting`
         :raises: :class:`HttpResponseError`, :class:`ClientAuthenticationError`, :class:`ResourceExistsError`
@@ -342,7 +332,7 @@ def set_configuration_setting(
         :type configuration_setting: :class:`ConfigurationSetting`
         :param match_condition: The match condition to use upon the etag
         :type match_condition: :class:`~azure.core.MatchConditions`
-        :keyword dict headers: if "headers" exists, its value (a dict) will be added to the http request header
+        :keyword str etag: check if the ConfigurationSetting is changed. Set None to skip checking etag
         :return: The ConfigurationSetting returned from the service
         :rtype: :class:`~azure.appconfiguration.ConfigurationSetting`
         :raises: :class:`HttpResponseError`, :class:`ClientAuthenticationError`, \
@@ -396,7 +386,6 @@ def set_configuration_setting(
     @distributed_trace
     def delete_configuration_setting(self, key, label=None, **kwargs):
         # type: (str, Optional[str], **Any) -> ConfigurationSetting
-
         """Delete a ConfigurationSetting if it exists
 
         :param key: key used to identify the ConfigurationSetting
@@ -406,7 +395,6 @@ def delete_configuration_setting(self, key, label=None, **kwargs):
         :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
         :paramtype match_condition: :class:`~azure.core.MatchConditions`
-        :keyword dict headers: if "headers" exists, its value (a dict) will be added to the http request
         :return: The deleted ConfigurationSetting returned from the service, or None if it doesn't exist.
         :rtype: :class:`~azure.appconfiguration.ConfigurationSetting`
         :raises: :class:`HttpResponseError`, :class:`ClientAuthenticationError`, \
@@ -464,7 +452,6 @@ def list_revisions(self, key_filter=None, label_filter=None, **kwargs):
         :type label_filter: str
         :keyword datetime accept_datetime: filter out ConfigurationSetting created after this datetime
         :keyword list[str] fields: specify which fields to include in the results. Leave None to include all fields
-        :keyword dict headers: if "headers" exists, its value (a dict) will be added to the http request header
         :return: An iterator of :class:`ConfigurationSetting`
         :rtype: ~azure.core.paging.ItemPaged[ConfigurationSetting]
         :raises: :class:`HttpResponseError`, :class:`ClientAuthenticationError`
@@ -521,7 +508,7 @@ def set_read_only(self, configuration_setting, read_only=True, **kwargs):
         :type read_only: bool
         :keyword match_condition: The match condition to use upon the etag
         :paramtype match_condition: :class:`~azure.core.MatchConditions`
-        :keyword dict headers: if "headers" exists, its value (a dict) will be added to the http request header
+        :keyword str etag: check if the ConfigurationSetting is changed. Set None to skip checking etag
         :return: The ConfigurationSetting returned from the service
         :rtype: :class:`~azure.appconfiguration.ConfigurationSetting`
         :raises: :class:`HttpResponseError`, :class:`ClientAuthenticationError`, :class:`ResourceNotFoundError`

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_constants.py

@@ -4,8 +4,8 @@
 # license information.
 # --------------------------------------------------------------------------
 
-TIME_WINDOW = u"Microsoft.TimeWindow"
+FILTER_TIME_WINDOW = u"Microsoft.TimeWindow"
 
-PERCENTAGE = u"Microsoft.Percentage"
+FILTER_PERCENTAGE = u"Microsoft.Percentage"
 
-TARGETING = u"Microsoft.Targeting"
+FILTER_TARGETING = u"Microsoft.Targeting"