[AutoPR applicationinsights/resource-manager/operationalinsights/resource-manager] Improve documentation for App Insights purge

azure-mgmt-applicationinsights/HISTORY.rst

@@ -3,6 +3,49 @@
 Release History
 ===============
 
+0.2.0 (2019-04-10)
+++++++++++++++++++
+
+**Features**
+
+- Added operation WebTestsOperations.list_by_component
+- Added operation ComponentsOperations.get_purge_status
+- Added operation ComponentsOperations.purge
+- Added operation group FavoritesOperations
+- Added operation group ComponentFeatureCapabilitiesOperations
+- Added operation group WebTestLocationsOperations
+- Added operation group ComponentAvailableFeaturesOperations
+- Added operation group ProactiveDetectionConfigurationsOperations
+- Added operation group AnnotationsOperations
+- Added operation group WorkItemConfigurationsOperations
+- Added operation group WorkbooksOperations
+- Added operation group AnalyticsItemsOperations
+
+**General Breaking changes**
+
+This version uses a next-generation code generator that *might* introduce breaking changes.
+
+- Model signatures now use only keyword-argument syntax. All positional arguments must be re-written as keyword-arguments.
+  To keep auto-completion in most cases, models are now generated for Python 2 and Python 3. Python 3 uses the "*" syntax for keyword-only arguments.
+- Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to improve the behavior when unrecognized enum values are encountered.
+  While this is not a breaking change, the distinctions are important, and are documented here:
+  https://docs.python.org/3/library/enum.html#others
+  At a glance:
+
+  - "is" should not be used at all.
+  - "format" will return the string value, where "%s" string formatting will return `NameOfEnum.stringvalue`. Format syntax should be prefered.
+
+- New Long Running Operation:
+
+  - Return type changes from `msrestazure.azure_operation.AzureOperationPoller` to `msrest.polling.LROPoller`. External API is the same.
+  - Return type is now **always** a `msrest.polling.LROPoller`, regardless of the optional parameters used.
+  - The behavior has changed when using `raw=True`. Instead of returning the initial call result as `ClientRawResponse`,
+    without polling, now this returns an LROPoller. After polling, the final resource will be returned as a `ClientRawResponse`.
+  - New `polling` parameter. The default behavior is `Polling=True` which will poll using ARM algorithm. When `Polling=False`,
+    the response of the initial call will be returned without polling.
+  - `polling` parameter accepts instances of subclasses of `msrest.polling.PollingMethod`.
+  - `add_done_callback` will no longer raise if called after polling is finished, but will instead execute the callback right away.
+
 0.1.1 (2018-02-12)
 ++++++++++++++++++
 

azure-mgmt-applicationinsights/MANIFEST.in

@@ -1 +1,5 @@
+recursive-include tests *.py *.yaml
 include *.rst
+include azure/__init__.py
+include azure/mgmt/__init__.py
+

azure-mgmt-applicationinsights/README.rst

@@ -14,25 +14,6 @@ For the older Azure Service Management (ASM) libraries, see
 For a more complete set of Azure libraries, see the `azure <https://pypi.python.org/pypi/azure>`__ bundle package.
 
 
-Compatibility
-=============
-
-**IMPORTANT**: If you have an earlier version of the azure package
-(version < 1.0), you should uninstall it before installing this package.
-
-You can check the version using pip:
-
-.. code:: shell
-
-    pip freeze
-
-If you see azure==0.11.0 (or any version below 1.0), uninstall it first:
-
-.. code:: shell
-
-    pip uninstall azure
-
-
 Usage
 =====
 

azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/application_insights_management_client.py

@@ -9,18 +9,26 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
-from msrest.service_client import ServiceClient
+from msrest.service_client import SDKClient
 from msrest import Serializer, Deserializer
 from msrestazure import AzureConfiguration
 from .version import VERSION
 from .operations.operations import Operations
-from .operations.components_operations import ComponentsOperations
-from .operations.web_tests_operations import WebTestsOperations
+from .operations.annotations_operations import AnnotationsOperations
+from .operations.api_keys_operations import APIKeysOperations
 from .operations.export_configurations_operations import ExportConfigurationsOperations
-from .operations.proactive_detection_configurations_operations import ProactiveDetectionConfigurationsOperations
 from .operations.component_current_billing_features_operations import ComponentCurrentBillingFeaturesOperations
 from .operations.component_quota_status_operations import ComponentQuotaStatusOperations
-from .operations.api_keys_operations import APIKeysOperations
+from .operations.component_feature_capabilities_operations import ComponentFeatureCapabilitiesOperations
+from .operations.component_available_features_operations import ComponentAvailableFeaturesOperations
+from .operations.proactive_detection_configurations_operations import ProactiveDetectionConfigurationsOperations
+from .operations.components_operations import ComponentsOperations
+from .operations.work_item_configurations_operations import WorkItemConfigurationsOperations
+from .operations.favorites_operations import FavoritesOperations
+from .operations.web_test_locations_operations import WebTestLocationsOperations
+from .operations.web_tests_operations import WebTestsOperations
+from .operations.analytics_items_operations import AnalyticsItemsOperations
+from .operations.workbooks_operations import WorkbooksOperations
 from . import models
 
 
@@ -32,7 +40,7 @@ class ApplicationInsightsManagementClientConfiguration(AzureConfiguration):
     :param credentials: Credentials needed for the client to connect to Azure.
     :type credentials: :mod:`A msrestazure Credentials
      object<msrestazure.azure_active_directory>`
-    :param subscription_id: The Azure subscription ID.
+    :param subscription_id: The ID of the target subscription.
     :type subscription_id: str
     :param str base_url: Service URL
     """
@@ -56,33 +64,49 @@ def __init__(
         self.subscription_id = subscription_id
 
 
-class ApplicationInsightsManagementClient(object):
+class ApplicationInsightsManagementClient(SDKClient):
     """Composite Swagger for Application Insights Management Client
 
     :ivar config: Configuration for client.
     :vartype config: ApplicationInsightsManagementClientConfiguration
 
     :ivar operations: Operations operations
     :vartype operations: azure.mgmt.applicationinsights.operations.Operations
-    :ivar components: Components operations
-    :vartype components: azure.mgmt.applicationinsights.operations.ComponentsOperations
-    :ivar web_tests: WebTests operations
-    :vartype web_tests: azure.mgmt.applicationinsights.operations.WebTestsOperations
+    :ivar annotations: Annotations operations
+    :vartype annotations: azure.mgmt.applicationinsights.operations.AnnotationsOperations
+    :ivar api_keys: APIKeys operations
+    :vartype api_keys: azure.mgmt.applicationinsights.operations.APIKeysOperations
     :ivar export_configurations: ExportConfigurations operations
     :vartype export_configurations: azure.mgmt.applicationinsights.operations.ExportConfigurationsOperations
-    :ivar proactive_detection_configurations: ProactiveDetectionConfigurations operations
-    :vartype proactive_detection_configurations: azure.mgmt.applicationinsights.operations.ProactiveDetectionConfigurationsOperations
     :ivar component_current_billing_features: ComponentCurrentBillingFeatures operations
     :vartype component_current_billing_features: azure.mgmt.applicationinsights.operations.ComponentCurrentBillingFeaturesOperations
     :ivar component_quota_status: ComponentQuotaStatus operations
     :vartype component_quota_status: azure.mgmt.applicationinsights.operations.ComponentQuotaStatusOperations
-    :ivar api_keys: APIKeys operations
-    :vartype api_keys: azure.mgmt.applicationinsights.operations.APIKeysOperations
+    :ivar component_feature_capabilities: ComponentFeatureCapabilities operations
+    :vartype component_feature_capabilities: azure.mgmt.applicationinsights.operations.ComponentFeatureCapabilitiesOperations
+    :ivar component_available_features: ComponentAvailableFeatures operations
+    :vartype component_available_features: azure.mgmt.applicationinsights.operations.ComponentAvailableFeaturesOperations
+    :ivar proactive_detection_configurations: ProactiveDetectionConfigurations operations
+    :vartype proactive_detection_configurations: azure.mgmt.applicationinsights.operations.ProactiveDetectionConfigurationsOperations
+    :ivar components: Components operations
+    :vartype components: azure.mgmt.applicationinsights.operations.ComponentsOperations
+    :ivar work_item_configurations: WorkItemConfigurations operations
+    :vartype work_item_configurations: azure.mgmt.applicationinsights.operations.WorkItemConfigurationsOperations
+    :ivar favorites: Favorites operations
+    :vartype favorites: azure.mgmt.applicationinsights.operations.FavoritesOperations
+    :ivar web_test_locations: WebTestLocations operations
+    :vartype web_test_locations: azure.mgmt.applicationinsights.operations.WebTestLocationsOperations
+    :ivar web_tests: WebTests operations
+    :vartype web_tests: azure.mgmt.applicationinsights.operations.WebTestsOperations
+    :ivar analytics_items: AnalyticsItems operations
+    :vartype analytics_items: azure.mgmt.applicationinsights.operations.AnalyticsItemsOperations
+    :ivar workbooks: Workbooks operations
+    :vartype workbooks: azure.mgmt.applicationinsights.operations.WorkbooksOperations
 
     :param credentials: Credentials needed for the client to connect to Azure.
     :type credentials: :mod:`A msrestazure Credentials
      object<msrestazure.azure_active_directory>`
-    :param subscription_id: The Azure subscription ID.
+    :param subscription_id: The ID of the target subscription.
     :type subscription_id: str
     :param str base_url: Service URL
     """
@@ -91,7 +115,7 @@ def __init__(
             self, credentials, subscription_id, base_url=None):
 
         self.config = ApplicationInsightsManagementClientConfiguration(credentials, subscription_id, base_url)
-        self._client = ServiceClient(self.config.credentials, self.config)
+        super(ApplicationInsightsManagementClient, self).__init__(self.config.credentials, self.config)
 
         client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
         self.api_version = '2015-05-01'
@@ -100,17 +124,33 @@ def __init__(
 
         self.operations = Operations(
             self._client, self.config, self._serialize, self._deserialize)
-        self.components = ComponentsOperations(
+        self.annotations = AnnotationsOperations(
             self._client, self.config, self._serialize, self._deserialize)
-        self.web_tests = WebTestsOperations(
+        self.api_keys = APIKeysOperations(
             self._client, self.config, self._serialize, self._deserialize)
         self.export_configurations = ExportConfigurationsOperations(
             self._client, self.config, self._serialize, self._deserialize)
-        self.proactive_detection_configurations = ProactiveDetectionConfigurationsOperations(
-            self._client, self.config, self._serialize, self._deserialize)
         self.component_current_billing_features = ComponentCurrentBillingFeaturesOperations(
             self._client, self.config, self._serialize, self._deserialize)
         self.component_quota_status = ComponentQuotaStatusOperations(
             self._client, self.config, self._serialize, self._deserialize)
-        self.api_keys = APIKeysOperations(
+        self.component_feature_capabilities = ComponentFeatureCapabilitiesOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.component_available_features = ComponentAvailableFeaturesOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.proactive_detection_configurations = ProactiveDetectionConfigurationsOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.components = ComponentsOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.work_item_configurations = WorkItemConfigurationsOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.favorites = FavoritesOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.web_test_locations = WebTestLocationsOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.web_tests = WebTestsOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.analytics_items = AnalyticsItemsOperations(
+            self._client, self.config, self._serialize, self._deserialize)
+        self.workbooks = WorkbooksOperations(
             self._client, self.config, self._serialize, self._deserialize)