Share via

Commitment Plans - List In Resource Group

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

Retrieve all Azure ML commitment plans in a resource group.

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

URI Parameters

Name In Required Type Description
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

CommitmentPlanListResult

OK

Definitions

Name Description
CommitmentPlan

An Azure ML commitment plan resource.
CommitmentPlanListResult

A page of commitment plan resources.
CommitmentPlanProperties

Properties of an Azure ML commitment plan.
PlanQuantity

Represents the quantity a commitment plan provides of a metered resource.
ResourceSku

The SKU of a resource.

CommitmentPlan

Object

An Azure ML commitment plan resource.

Name Type Description
etag

string

An entity tag used to enforce optimistic concurrency.
id

string

Resource Id.
location

string

Resource location.
name

string

Resource name.
properties

CommitmentPlanProperties

The commitment plan properties.
sku

ResourceSku

The commitment plan SKU.
tags

object

User-defined tags for the resource.
type

string

Resource type.

CommitmentPlanListResult

Object

A page of commitment plan resources.

Name Type Description
nextLink

string

A URI to retrieve the next page of results.
value

CommitmentPlan[]

The set of results for this page.

CommitmentPlanProperties

Object

Properties of an Azure ML commitment plan.

Name Type Description
chargeForOverage

boolean

Indicates whether usage beyond the commitment plan's included quantities will be charged.
chargeForPlan

boolean

Indicates whether the commitment plan will incur a charge.
creationDate

string (date-time)

The date at which this commitment plan was created, in ISO 8601 format.
includedQuantities

<string,  PlanQuantity>

The included resource quantities this plan gives you.
maxAssociationLimit

integer (int32)

The maximum number of commitment associations that can be children of this commitment plan.
maxCapacityLimit

integer (int32)

The maximum scale-out capacity for this commitment plan.
minCapacityLimit

integer (int32)

The minimum scale-out capacity for this commitment plan.
planMeter

string

The Azure meter which will be used to charge for this commitment plan.
refillFrequencyInDays

integer (int32)

The frequency at which this commitment plan's included quantities are refilled.
suspendPlanOnOverage

boolean

Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.

PlanQuantity

Object

Represents the quantity a commitment plan provides of a metered resource.

Name Type Description
allowance

number (double)

The quantity added to the commitment plan at an interval specified by its allowance frequency.
amount

number (double)

The quantity available to the plan the last time usage was calculated.
includedQuantityMeter

string

The Azure meter for usage against included quantities.
overageMeter

string

The Azure meter for usage which exceeds included quantities.

ResourceSku

Object

The SKU of a resource.

Name Type Description
capacity

integer (int32)

The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
name

string

The SKU name. Along with tier, uniquely identifies the SKU.
tier

string

The SKU tier. Along with name, uniquely identifies the SKU.