[Consumption] Doc update

azure-mgmt-consumption/HISTORY.rst

@@ -2,11 +2,18 @@
 
 Release History
 ===============
+
 1.0.0 (2017-11-15)
-++++++++++++
+++++++++++++++++++
+
+**Features**
+
 - Featuring stable api GA version 2017-11-30
 - Supporting EA customers with azure consumption usage details
-- Removing support for calling usage_details.list() with 'invoice_id'. Will feature in future releases
+
+**Breaking changes**
+
+- Removing support for calling usage_details.list() with 'invoice_id'. Will feature in future releases.
 
 0.1.0 (2017-05-18)
 ++++++++++++++++++

azure-mgmt-consumption/azure/mgmt/consumption/consumption_management_client.py

@@ -38,14 +38,12 @@ def __init__(
             raise ValueError("Parameter 'credentials' must not be None.")
         if subscription_id is None:
             raise ValueError("Parameter 'subscription_id' must not be None.")
-        if not isinstance(subscription_id, str):
-            raise TypeError("Parameter 'subscription_id' must be str.")
         if not base_url:
             base_url = 'https://management.azure.com'
 
         super(ConsumptionManagementClientConfiguration, self).__init__(base_url)
 
-        self.add_user_agent('azure-mgmt-consumption/{}'.format(VERSION))
+        self.add_user_agent('consumptionmanagementclient/{}'.format(VERSION))
         self.add_user_agent('Azure-SDK-For-Python')
 
         self.credentials = credentials

azure-mgmt-consumption/azure/mgmt/consumption/models/error_response.py

@@ -18,8 +18,7 @@ class ErrorResponse(Model):
     incoming request. The reason is provided in the error message.
 
     :param error: The details of the error.
-    :type error: :class:`ErrorDetails
-     <azure.mgmt.consumption.models.ErrorDetails>`
+    :type error: ~azure.mgmt.consumption.models.ErrorDetails
     """
 
     _attribute_map = {

azure-mgmt-consumption/azure/mgmt/consumption/models/operation.py

@@ -21,8 +21,7 @@ class Operation(Model):
     :ivar name: Operation name: {provider}/{resource}/{operation}.
     :vartype name: str
     :param display: The object that represents the operation.
-    :type display: :class:`OperationDisplay
-     <azure.mgmt.consumption.models.OperationDisplay>`
+    :type display: ~azure.mgmt.consumption.models.OperationDisplay
     """
 
     _validation = {

azure-mgmt-consumption/azure/mgmt/consumption/models/resource.py

@@ -25,7 +25,7 @@ class Resource(Model):
     :ivar type: Resource type.
     :vartype type: str
     :ivar tags: Resource tags.
-    :vartype tags: dict
+    :vartype tags: dict[str, str]
     """
 
     _validation = {

azure-mgmt-consumption/azure/mgmt/consumption/models/usage_detail.py

@@ -25,7 +25,7 @@ class UsageDetail(Resource):
     :ivar type: Resource type.
     :vartype type: str
     :ivar tags: Resource tags.
-    :vartype tags: dict
+    :vartype tags: dict[str, str]
     :ivar billing_period_id: The id of the billing period resource that the
      usage belongs to.
     :vartype billing_period_id: str
@@ -62,8 +62,7 @@ class UsageDetail(Resource):
     :vartype meter_id: str
     :ivar meter_details: The details about the meter. By default this is not
      populated, unless it's specified in $expand.
-    :vartype meter_details: :class:`MeterDetails
-     <azure.mgmt.consumption.models.MeterDetails>`
+    :vartype meter_details: ~azure.mgmt.consumption.models.MeterDetails
     :ivar subscription_guid: Subscription guid.
     :vartype subscription_guid: str
     :ivar subscription_name: Subscription name.

azure-mgmt-consumption/azure/mgmt/consumption/operations/operations.py

@@ -43,10 +43,9 @@ def list(
          deserialized response
         :param operation_config: :ref:`Operation configuration
          overrides<msrest:optionsforoperations>`.
-        :return: An iterator like instance of :class:`Operation
-         <azure.mgmt.consumption.models.Operation>`
-        :rtype: :class:`OperationPaged
-         <azure.mgmt.consumption.models.OperationPaged>`
+        :return: An iterator like instance of Operation
+        :rtype:
+         ~azure.mgmt.consumption.models.OperationPaged[~azure.mgmt.consumption.models.Operation]
         :raises:
          :class:`ErrorResponseException<azure.mgmt.consumption.models.ErrorResponseException>`
         """

azure-mgmt-consumption/azure/mgmt/consumption/operations/usage_details_operations.py

@@ -44,14 +44,16 @@ def list(
          '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'
          for a billing perdiod.
         :type scope: str
-        :param expand: May be used to expand the additionalProperties or
-         meterDetails property within a list of usage details. By default,
-         these fields are not included when listing usage details.
+        :param expand: May be used to expand the
+         properties/additionalProperties or properties/meterDetails within a
+         list of usage details. By default, these fields are not included when
+         listing usage details.
         :type expand: str
-        :param filter: May be used to filter usageDetails by usageEnd (Utc
-         time), usageStart (Utc time), resourceGroup, instanceName or
-         instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and
-         'and'. It does not currently support 'ne', 'or', or 'not'.
+        :param filter: May be used to filter usageDetails by
+         properties/usageEnd (Utc time), properties/usageStart (Utc time),
+         properties/resourceGroup, properties/instanceName or
+         properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le',
+         'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.
         :type filter: str
         :param skiptoken: Skiptoken is only used if a previous operation
          returned a partial result. If a previous response contains a nextLink
@@ -66,10 +68,9 @@ def list(
          deserialized response
         :param operation_config: :ref:`Operation configuration
          overrides<msrest:optionsforoperations>`.
-        :return: An iterator like instance of :class:`UsageDetail
-         <azure.mgmt.consumption.models.UsageDetail>`
-        :rtype: :class:`UsageDetailPaged
-         <azure.mgmt.consumption.models.UsageDetailPaged>`
+        :return: An iterator like instance of UsageDetail
+        :rtype:
+         ~azure.mgmt.consumption.models.UsageDetailPaged[~azure.mgmt.consumption.models.UsageDetail]
         :raises:
          :class:`ErrorResponseException<azure.mgmt.consumption.models.ErrorResponseException>`
         """

azure-mgmt-consumption/build.json

@@ -0,0 +1,225 @@
+{
+  "autorest": [
+    {
+      "resolvedInfo": null,
+      "packageMetadata": {
+        "name": "@microsoft.azure/autorest-core",
+        "version": "2.0.4168",
+        "engines": {
+          "node": ">=7.10.0"
+        },
+        "dependencies": {},
+        "optionalDependencies": {},
+        "devDependencies": {
+          "@microsoft.azure/async-io": "~1.0.22",
+          "@microsoft.azure/extension": "~1.2.12",
+          "@types/commonmark": "^0.27.0",
+          "@types/jsonpath": "^0.1.29",
+          "@types/node": "^8.0.28",
+          "@types/pify": "0.0.28",
+          "@types/source-map": "^0.5.0",
+          "@types/yargs": "^8.0.2",
+          "commonmark": "^0.27.0",
+          "file-url": "^2.0.2",
+          "get-uri": "^2.0.0",
+          "jsonpath": "^0.2.11",
+          "linq-es2015": "^2.4.25",
+          "mocha": "3.4.2",
+          "mocha-typescript": "1.1.5",
+          "pify": "^3.0.0",
+          "safe-eval": "^0.3.0",
+          "shx": "^0.2.2",
+          "source-map": "^0.5.6",
+          "source-map-support": "^0.4.15",
+          "strip-bom": "^3.0.0",
+          "typescript": "2.5.3",
+          "untildify": "^3.0.2",
+          "urijs": "^1.18.10",
+          "vscode-jsonrpc": "^3.3.1",
+          "yaml-ast-parser": "https://github.com/olydis/yaml-ast-parser/releases/download/0.0.34/yaml-ast-parser-0.0.34.tgz",
+          "yargs": "^8.0.2"
+        },
+        "bundleDependencies": false,
+        "peerDependencies": {},
+        "deprecated": false,
+        "_resolved": "/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core",
+        "_shasum": "33813111fc9bfa488bd600fbba48bc53cc9182c7",
+        "_shrinkwrap": null,
+        "bin": null,
+        "_id": "@microsoft.azure/autorest-core@2.0.4168",
+        "_from": "file:/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core",
+        "_requested": {
+          "type": "directory",
+          "where": "/git-restapi",
+          "raw": "/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core",
+          "rawSpec": "/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core",
+          "saveSpec": "file:/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core",
+          "fetchSpec": "/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core"
+        },
+        "_spec": "/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core",
+        "_where": "/root/.autorest/@microsoft.azure_autorest-core@2.0.4168/node_modules/@microsoft.azure/autorest-core"
+      },
+      "extensionManager": {
+        "installationPath": "/root/.autorest",
+        "dotnetPath": "/root/.dotnet"
+      },
+      "installationPath": "/root/.autorest"
+    },
+    {
+      "resolvedInfo": null,
+      "packageMetadata": {
+        "name": "@microsoft.azure/autorest.modeler",
+        "version": "2.0.21",
+        "dependencies": {
+          "dotnet-2.0.0": "^1.3.2"
+        },
+        "optionalDependencies": {},
+        "devDependencies": {
+          "coffee-script": "^1.11.1",
+          "dotnet-sdk-2.0.0": "^1.1.1",
+          "gulp": "^3.9.1",
+          "gulp-filter": "^5.0.0",
+          "gulp-line-ending-corrector": "^1.0.1",
+          "iced-coffee-script": "^108.0.11",
+          "marked": "^0.3.6",
+          "marked-terminal": "^2.0.0",
+          "moment": "^2.17.1",
+          "run-sequence": "*",
+          "shx": "^0.2.2",
+          "through2-parallel": "^0.1.3",
+          "yargs": "^8.0.2",
+          "yarn": "^1.0.2"
+        },
+        "bundleDependencies": false,
+        "peerDependencies": {},
+        "deprecated": false,
+        "_resolved": "/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler",
+        "_shasum": "3ce7d3939124b31830be15e5de99b9b7768afb90",
+        "_shrinkwrap": null,
+        "bin": null,
+        "_id": "@microsoft.azure/autorest.modeler@2.0.21",
+        "_from": "file:/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler",
+        "_requested": {
+          "type": "directory",
+          "where": "/git-restapi",
+          "raw": "/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler",
+          "rawSpec": "/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler",
+          "saveSpec": "file:/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler",
+          "fetchSpec": "/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler"
+        },
+        "_spec": "/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler",
+        "_where": "/root/.autorest/@microsoft.azure_autorest.modeler@2.0.21/node_modules/@microsoft.azure/autorest.modeler"
+      },
+      "extensionManager": {
+        "installationPath": "/root/.autorest",
+        "dotnetPath": "/root/.dotnet"
+      },
+      "installationPath": "/root/.autorest"
+    },
+    {
+      "resolvedInfo": null,
+      "packageMetadata": {
+        "name": "@microsoft.azure/autorest.modeler",
+        "version": "2.1.22",
+        "dependencies": {
+          "dotnet-2.0.0": "^1.4.4"
+        },
+        "optionalDependencies": {},
+        "devDependencies": {
+          "coffee-script": "^1.11.1",
+          "dotnet-sdk-2.0.0": "^1.4.4",
+          "gulp": "^3.9.1",
+          "gulp-filter": "^5.0.0",
+          "gulp-line-ending-corrector": "^1.0.1",
+          "iced-coffee-script": "^108.0.11",
+          "marked": "^0.3.6",
+          "marked-terminal": "^2.0.0",
+          "moment": "^2.17.1",
+          "run-sequence": "*",
+          "shx": "^0.2.2",
+          "through2-parallel": "^0.1.3",
+          "yargs": "^8.0.2",
+          "yarn": "^1.0.2"
+        },
+        "bundleDependencies": false,
+        "peerDependencies": {},
+        "deprecated": false,
+        "_resolved": "/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler",
+        "_shasum": "ca425289fa38a210d279729048a4a91673f09c67",
+        "_shrinkwrap": null,
+        "bin": null,
+        "_id": "@microsoft.azure/autorest.modeler@2.1.22",
+        "_from": "file:/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler",
+        "_requested": {
+          "type": "directory",
+          "where": "/git-restapi",
+          "raw": "/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler",
+          "rawSpec": "/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler",
+          "saveSpec": "file:/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler",
+          "fetchSpec": "/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler"
+        },
+        "_spec": "/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler",
+        "_where": "/root/.autorest/@microsoft.azure_autorest.modeler@2.1.22/node_modules/@microsoft.azure/autorest.modeler"
+      },
+      "extensionManager": {
+        "installationPath": "/root/.autorest",
+        "dotnetPath": "/root/.dotnet"
+      },
+      "installationPath": "/root/.autorest"
+    },
+    {
+      "resolvedInfo": null,
+      "packageMetadata": {
+        "name": "@microsoft.azure/autorest.python",
+        "version": "2.0.19",
+        "dependencies": {
+          "dotnet-2.0.0": "^1.4.4"
+        },
+        "optionalDependencies": {},
+        "devDependencies": {
+          "@microsoft.azure/autorest.testserver": "^1.9.0",
+          "autorest": "^2.0.0",
+          "coffee-script": "^1.11.1",
+          "dotnet-sdk-2.0.0": "^1.4.4",
+          "gulp": "^3.9.1",
+          "gulp-filter": "^5.0.0",
+          "gulp-line-ending-corrector": "^1.0.1",
+          "iced-coffee-script": "^108.0.11",
+          "marked": "^0.3.6",
+          "marked-terminal": "^2.0.0",
+          "moment": "^2.17.1",
+          "run-sequence": "*",
+          "shx": "^0.2.2",
+          "through2-parallel": "^0.1.3",
+          "yargs": "^8.0.2",
+          "yarn": "^1.0.2"
+        },
+        "bundleDependencies": false,
+        "peerDependencies": {},
+        "deprecated": false,
+        "_resolved": "/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python",
+        "_shasum": "e069166c16fd903c8e1fdf9395b433f3043cb6e3",
+        "_shrinkwrap": null,
+        "bin": null,
+        "_id": "@microsoft.azure/autorest.python@2.0.19",
+        "_from": "file:/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python",
+        "_requested": {
+          "type": "directory",
+          "where": "/git-restapi",
+          "raw": "/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python",
+          "rawSpec": "/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python",
+          "saveSpec": "file:/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python",
+          "fetchSpec": "/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python"
+        },
+        "_spec": "/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python",
+        "_where": "/root/.autorest/@microsoft.azure_autorest.python@2.0.19/node_modules/@microsoft.azure/autorest.python"
+      },
+      "extensionManager": {
+        "installationPath": "/root/.autorest",
+        "dotnetPath": "/root/.dotnet"
+      },
+      "installationPath": "/root/.autorest"
+    }
+  ],
+  "autorest_bootstrap": {}
+}