Share via

Usage History - List

Service:
ML Studio (classic)
API Version:
2016-05-01-preview

Retrieve the usage history for an Azure ML commitment plan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}/usageHistory?api-version=2016-05-01-preview
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}/usageHistory?$skipToken={$skipToken}&api-version=2016-05-01-preview

URI Parameters

Name In Required Type Description
commitmentPlanName
 path True

string

The Azure ML commitment plan name.
resourceGroupName
 path True

string

The resource group name.
subscriptionId
 path True

string

Azure Subscription ID.
api-version
 query True

string

The version of the Microsoft.MachineLearning resource provider API to use.
$skipToken
 query

string

Continuation token for pagination.

Responses

Name Type Description
200 OK

PlanUsageHistoryListResult

OK

Definitions

Name Description
PlanUsageHistory

Represents historical information about usage of the Azure resources associated with a commitment plan.
PlanUsageHistoryListResult

A page of usage history.

PlanUsageHistory

Object

Represents historical information about usage of the Azure resources associated with a commitment plan.

Name Type Description
planDeletionOverage

object

Overage incurred as a result of deleting a commitment plan.
planMigrationOverage

object

Overage incurred as a result of migrating a commitment plan from one SKU to another.
planQuantitiesAfterUsage

object

Included quantities remaining after usage against the commitment plan's associated resources was calculated.
planQuantitiesBeforeUsage

object

Included quantities remaining before usage against the commitment plan's associated resources was calculated.
planUsageOverage

object

Usage against the commitment plan's associated resources which was not covered by included quantities and is therefore overage.
usage

object

Usage against the commitment plan's associated resources.
usageDate

string (date-time)

The date of usage, in ISO 8601 format.

PlanUsageHistoryListResult

Object

A page of usage history.

Name Type Description
nextLink

string

A URI to retrieve the next page of results.
value

PlanUsageHistory[]

The set of results for this page.