commitmentplans

package
v12.5.0-beta+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 12, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package commitmentplans implements the Azure ARM Commitmentplans service API version 2016-05-01-preview.

These APIs allow end users to operate on Azure Machine Learning Commitment Plans resources and their child Commitment Association resources. They support CRUD operations for commitment plans, get and list operations for commitment associations, moving commitment associations between commitment plans, and retrieving commitment plan usage history.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Commitmentplans
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Commitmentplans.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Client

type Client struct {
	BaseClient
}

Client is the these APIs allow end users to operate on Azure Machine Learning Commitment Plans resources and their child Commitment Association resources. They support CRUD operations for commitment plans, get and list operations for commitment associations, moving commitment associations between commitment plans, and retrieving commitment plan usage history.

func NewClient

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client client.

func (Client) CreateOrUpdate

func (client Client) CreateOrUpdate(ctx context.Context, createOrUpdatePayload CommitmentPlan, resourceGroupName string, commitmentPlanName string) (result CommitmentPlan, err error)

CreateOrUpdate create a new Azure ML commitment plan resource or updates an existing one.

createOrUpdatePayload is the payload to create or update the Azure ML commitment plan. resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name.

func (Client) CreateOrUpdatePreparer

func (client Client) CreateOrUpdatePreparer(ctx context.Context, createOrUpdatePayload CommitmentPlan, resourceGroupName string, commitmentPlanName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result CommitmentPlan, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (Client) CreateOrUpdateSender

func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (Client) Get

func (client Client) Get(ctx context.Context, resourceGroupName string, commitmentPlanName string) (result CommitmentPlan, err error)

Get retrieve an Azure ML commitment plan by its subscription, resource group and name.

resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name.

func (Client) GetPreparer

func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder

func (client Client) GetResponder(resp *http.Response) (result CommitmentPlan, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (Client) GetSender

func (client Client) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (Client) List

func (client Client) List(ctx context.Context, skipToken string) (result ListResultPage, err error)

List retrieve all Azure ML commitment plans in a subscription.

skipToken is continuation token for pagination.

func (Client) ListComplete

func (client Client) ListComplete(ctx context.Context, skipToken string) (result ListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListInResourceGroup

func (client Client) ListInResourceGroup(ctx context.Context, resourceGroupName string, skipToken string) (result ListResultPage, err error)

ListInResourceGroup retrieve all Azure ML commitment plans in a resource group.

resourceGroupName is the resource group name. skipToken is continuation token for pagination.

func (Client) ListInResourceGroupComplete

func (client Client) ListInResourceGroupComplete(ctx context.Context, resourceGroupName string, skipToken string) (result ListResultIterator, err error)

ListInResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListInResourceGroupPreparer

func (client Client) ListInResourceGroupPreparer(ctx context.Context, resourceGroupName string, skipToken string) (*http.Request, error)

ListInResourceGroupPreparer prepares the ListInResourceGroup request.

func (Client) ListInResourceGroupResponder

func (client Client) ListInResourceGroupResponder(resp *http.Response) (result ListResult, err error)

ListInResourceGroupResponder handles the response to the ListInResourceGroup request. The method always closes the http.Response Body.

func (Client) ListInResourceGroupSender

func (client Client) ListInResourceGroupSender(req *http.Request) (*http.Response, error)

ListInResourceGroupSender sends the ListInResourceGroup request. The method will close the http.Response Body if it receives an error.

func (Client) ListPreparer

func (client Client) ListPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder

func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (Client) ListSender

func (client Client) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (Client) Patch

func (client Client) Patch(ctx context.Context, patchPayload PatchPayload, resourceGroupName string, commitmentPlanName string) (result CommitmentPlan, err error)

Patch patch an existing Azure ML commitment plan resource.

patchPayload is the payload to use to patch the Azure ML commitment plan. Only tags and SKU may be modified on an existing commitment plan. resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name.

func (Client) PatchPreparer

func (client Client) PatchPreparer(ctx context.Context, patchPayload PatchPayload, resourceGroupName string, commitmentPlanName string) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (Client) PatchResponder

func (client Client) PatchResponder(resp *http.Response) (result CommitmentPlan, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (Client) PatchSender

func (client Client) PatchSender(req *http.Request) (*http.Response, error)

PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.

func (Client) Remove

func (client Client) Remove(ctx context.Context, resourceGroupName string, commitmentPlanName string) (result autorest.Response, err error)

Remove remove an existing Azure ML commitment plan.

resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name.

func (Client) RemovePreparer

func (client Client) RemovePreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (Client) RemoveResponder

func (client Client) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (Client) RemoveSender

func (client Client) RemoveSender(req *http.Request) (*http.Response, error)

RemoveSender sends the Remove request. The method will close the http.Response Body if it receives an error.

type CommitmentAssociation

type CommitmentAssociation struct {
	autorest.Response `json:"-"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - User-defined tags for the resource.
	Tags *map[string]*string `json:"tags,omitempty"`
	// Etag - An entity tag used to enforce optimistic concurrency.
	Etag *string `json:"etag,omitempty"`
	// Properties - The properties of the commitment association resource.
	Properties *CommitmentAssociationProperties `json:"properties,omitempty"`
}

CommitmentAssociation represents the association between a commitment plan and some other resource, such as a Machine Learning web service.

type CommitmentAssociationListResult

type CommitmentAssociationListResult struct {
	autorest.Response `json:"-"`
	// NextLink - A URI to retrieve the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The set of results for this page.
	Value *[]CommitmentAssociation `json:"value,omitempty"`
}

CommitmentAssociationListResult a page of commitment association resources.

func (CommitmentAssociationListResult) IsEmpty

func (calr CommitmentAssociationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CommitmentAssociationListResultIterator

type CommitmentAssociationListResultIterator struct {
	// contains filtered or unexported fields
}

CommitmentAssociationListResultIterator provides access to a complete listing of CommitmentAssociation values.

func (*CommitmentAssociationListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (CommitmentAssociationListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (CommitmentAssociationListResultIterator) Response

Response returns the raw server response from the last page request.

func (CommitmentAssociationListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type CommitmentAssociationListResultPage

type CommitmentAssociationListResultPage struct {
	// contains filtered or unexported fields
}

CommitmentAssociationListResultPage contains a page of CommitmentAssociation values.

func (*CommitmentAssociationListResultPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (CommitmentAssociationListResultPage) NotDone

NotDone returns true if the page enumeration should be started or is not yet complete.

func (CommitmentAssociationListResultPage) Response

Response returns the raw server response from the last page request.

func (CommitmentAssociationListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type CommitmentAssociationProperties

type CommitmentAssociationProperties struct {
	// AssociatedResourceID - The ID of the resource this association points to, such as the ARM ID of an Azure ML web service.
	AssociatedResourceID *string `json:"associatedResourceId,omitempty"`
	// CommitmentPlanID - The ARM ID of the parent Azure ML commitment plan.
	CommitmentPlanID *string `json:"commitmentPlanId,omitempty"`
	// CreationDate - The date at which this commitment association was created, in ISO 8601 format.
	CreationDate *date.Time `json:"creationDate,omitempty"`
}

CommitmentAssociationProperties properties of an Azure ML commitment association.

type CommitmentAssociationsClient

type CommitmentAssociationsClient struct {
	BaseClient
}

CommitmentAssociationsClient is the these APIs allow end users to operate on Azure Machine Learning Commitment Plans resources and their child Commitment Association resources. They support CRUD operations for commitment plans, get and list operations for commitment associations, moving commitment associations between commitment plans, and retrieving commitment plan usage history.

func NewCommitmentAssociationsClient

func NewCommitmentAssociationsClient(subscriptionID string) CommitmentAssociationsClient

NewCommitmentAssociationsClient creates an instance of the CommitmentAssociationsClient client.

func NewCommitmentAssociationsClientWithBaseURI

func NewCommitmentAssociationsClientWithBaseURI(baseURI string, subscriptionID string) CommitmentAssociationsClient

NewCommitmentAssociationsClientWithBaseURI creates an instance of the CommitmentAssociationsClient client.

func (CommitmentAssociationsClient) Get

func (client CommitmentAssociationsClient) Get(ctx context.Context, resourceGroupName string, commitmentPlanName string, commitmentAssociationName string) (result CommitmentAssociation, err error)

Get get a commitment association.

resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name. commitmentAssociationName is the commitment association name.

func (CommitmentAssociationsClient) GetPreparer

func (client CommitmentAssociationsClient) GetPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, commitmentAssociationName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CommitmentAssociationsClient) GetResponder

func (client CommitmentAssociationsClient) GetResponder(resp *http.Response) (result CommitmentAssociation, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (CommitmentAssociationsClient) GetSender

func (client CommitmentAssociationsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (CommitmentAssociationsClient) List

func (client CommitmentAssociationsClient) List(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (result CommitmentAssociationListResultPage, err error)

List get all commitment associations for a parent commitment plan.

resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name. skipToken is continuation token for pagination.

func (CommitmentAssociationsClient) ListComplete

func (client CommitmentAssociationsClient) ListComplete(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (result CommitmentAssociationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (CommitmentAssociationsClient) ListPreparer

func (client CommitmentAssociationsClient) ListPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (CommitmentAssociationsClient) ListResponder

func (client CommitmentAssociationsClient) ListResponder(resp *http.Response) (result CommitmentAssociationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (CommitmentAssociationsClient) ListSender

func (client CommitmentAssociationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (CommitmentAssociationsClient) Move

func (client CommitmentAssociationsClient) Move(ctx context.Context, resourceGroupName string, commitmentPlanName string, commitmentAssociationName string, movePayload MoveCommitmentAssociationRequest) (result CommitmentAssociation, err error)

Move re-parent a commitment association from one commitment plan to another.

resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name. commitmentAssociationName is the commitment association name. movePayload is the move request payload.

func (CommitmentAssociationsClient) MovePreparer

func (client CommitmentAssociationsClient) MovePreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, commitmentAssociationName string, movePayload MoveCommitmentAssociationRequest) (*http.Request, error)

MovePreparer prepares the Move request.

func (CommitmentAssociationsClient) MoveResponder

func (client CommitmentAssociationsClient) MoveResponder(resp *http.Response) (result CommitmentAssociation, err error)

MoveResponder handles the response to the Move request. The method always closes the http.Response Body.

func (CommitmentAssociationsClient) MoveSender

func (client CommitmentAssociationsClient) MoveSender(req *http.Request) (*http.Response, error)

MoveSender sends the Move request. The method will close the http.Response Body if it receives an error.

type CommitmentPlan

type CommitmentPlan struct {
	autorest.Response `json:"-"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - User-defined tags for the resource.
	Tags *map[string]*string `json:"tags,omitempty"`
	// Etag - An entity tag used to enforce optimistic concurrency.
	Etag *string `json:"etag,omitempty"`
	// Properties - The commitment plan properties.
	Properties *Properties `json:"properties,omitempty"`
	// Sku - The commitment plan SKU.
	Sku *ResourceSku `json:"sku,omitempty"`
}

CommitmentPlan an Azure ML commitment plan resource.

type ListResult

type ListResult struct {
	autorest.Response `json:"-"`
	// NextLink - A URI to retrieve the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The set of results for this page.
	Value *[]CommitmentPlan `json:"value,omitempty"`
}

ListResult a page of commitment plan resources.

func (ListResult) IsEmpty

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListResultIterator

type ListResultIterator struct {
	// contains filtered or unexported fields
}

ListResultIterator provides access to a complete listing of CommitmentPlan values.

func (*ListResultIterator) Next

func (iter *ListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ListResultIterator) NotDone

func (iter ListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListResultIterator) Response

func (iter ListResultIterator) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultIterator) Value

func (iter ListResultIterator) Value() CommitmentPlan

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ListResultPage

type ListResultPage struct {
	// contains filtered or unexported fields
}

ListResultPage contains a page of CommitmentPlan values.

func (*ListResultPage) Next

func (page *ListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ListResultPage) NotDone

func (page ListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListResultPage) Response

func (page ListResultPage) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultPage) Values

func (page ListResultPage) Values() []CommitmentPlan

Values returns the slice of values for the current page or nil if there are no values.

type MoveCommitmentAssociationRequest

type MoveCommitmentAssociationRequest struct {
	// DestinationPlanID - The ARM ID of the commitment plan to re-parent the commitment association to.
	DestinationPlanID *string `json:"destinationPlanId,omitempty"`
}

MoveCommitmentAssociationRequest specifies the destination Azure ML commitment plan for a move operation.

type PatchPayload

type PatchPayload struct {
	// Tags - User-defined tags for the commitment plan.
	Tags *map[string]*string `json:"tags,omitempty"`
	// Sku - The commitment plan SKU.
	Sku *ResourceSku `json:"sku,omitempty"`
}

PatchPayload the properties of a commitment plan which may be updated via PATCH.

type PlanQuantity

type PlanQuantity struct {
	// Allowance - The quantity added to the commitment plan at an interval specified by its allowance frequency.
	Allowance *float64 `json:"allowance,omitempty"`
	// Amount - The quantity available to the plan the last time usage was calculated.
	Amount *float64 `json:"amount,omitempty"`
	// IncludedQuantityMeter - The Azure meter for usage against included quantities.
	IncludedQuantityMeter *string `json:"includedQuantityMeter,omitempty"`
	// OverageMeter - The Azure meter for usage which exceeds included quantities.
	OverageMeter *string `json:"overageMeter,omitempty"`
}

PlanQuantity represents the quantity a commitment plan provides of a metered resource.

type PlanUsageHistory

type PlanUsageHistory struct {
	// PlanDeletionOverage - Overage incurred as a result of deleting a commitment plan.
	PlanDeletionOverage *map[string]*float64 `json:"planDeletionOverage,omitempty"`
	// PlanMigrationOverage - Overage incurred as a result of migrating a commitment plan from one SKU to another.
	PlanMigrationOverage *map[string]*float64 `json:"planMigrationOverage,omitempty"`
	// PlanQuantitiesAfterUsage - Included quantities remaining after usage against the commitment plan's associated resources was calculated.
	PlanQuantitiesAfterUsage *map[string]*float64 `json:"planQuantitiesAfterUsage,omitempty"`
	// PlanQuantitiesBeforeUsage - Included quantities remaining before usage against the commitment plan's associated resources was calculated.
	PlanQuantitiesBeforeUsage *map[string]*float64 `json:"planQuantitiesBeforeUsage,omitempty"`
	// PlanUsageOverage - Usage against the commitment plan's associated resources which was not covered by included quantities and is therefore overage.
	PlanUsageOverage *map[string]*float64 `json:"planUsageOverage,omitempty"`
	// Usage - Usage against the commitment plan's associated resources.
	Usage *map[string]*float64 `json:"usage,omitempty"`
	// UsageDate - The date of usage, in ISO 8601 format.
	UsageDate *date.Time `json:"usageDate,omitempty"`
}

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

type PlanUsageHistoryListResult

type PlanUsageHistoryListResult struct {
	autorest.Response `json:"-"`
	// NextLink - A URI to retrieve the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The set of results for this page.
	Value *[]PlanUsageHistory `json:"value,omitempty"`
}

PlanUsageHistoryListResult a page of usage history.

func (PlanUsageHistoryListResult) IsEmpty

func (puhlr PlanUsageHistoryListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PlanUsageHistoryListResultIterator

type PlanUsageHistoryListResultIterator struct {
	// contains filtered or unexported fields
}

PlanUsageHistoryListResultIterator provides access to a complete listing of PlanUsageHistory values.

func (*PlanUsageHistoryListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PlanUsageHistoryListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (PlanUsageHistoryListResultIterator) Response

Response returns the raw server response from the last page request.

func (PlanUsageHistoryListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PlanUsageHistoryListResultPage

type PlanUsageHistoryListResultPage struct {
	// contains filtered or unexported fields
}

PlanUsageHistoryListResultPage contains a page of PlanUsageHistory values.

func (*PlanUsageHistoryListResultPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PlanUsageHistoryListResultPage) NotDone

func (page PlanUsageHistoryListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PlanUsageHistoryListResultPage) Response

Response returns the raw server response from the last page request.

func (PlanUsageHistoryListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type Properties

type Properties struct {
	// ChargeForOverage - Indicates whether usage beyond the commitment plan's included quantities will be charged.
	ChargeForOverage *bool `json:"chargeForOverage,omitempty"`
	// ChargeForPlan - Indicates whether the commitment plan will incur a charge.
	ChargeForPlan *bool `json:"chargeForPlan,omitempty"`
	// CreationDate - The date at which this commitment plan was created, in ISO 8601 format.
	CreationDate *date.Time `json:"creationDate,omitempty"`
	// IncludedQuantities - The included resource quantities this plan gives you.
	IncludedQuantities *map[string]*PlanQuantity `json:"includedQuantities,omitempty"`
	// MaxAssociationLimit - The maximum number of commitment associations that can be children of this commitment plan.
	MaxAssociationLimit *int32 `json:"maxAssociationLimit,omitempty"`
	// MaxCapacityLimit - The maximum scale-out capacity for this commitment plan.
	MaxCapacityLimit *int32 `json:"maxCapacityLimit,omitempty"`
	// MinCapacityLimit - The minimum scale-out capacity for this commitment plan.
	MinCapacityLimit *int32 `json:"minCapacityLimit,omitempty"`
	// PlanMeter - The Azure meter which will be used to charge for this commitment plan.
	PlanMeter *string `json:"planMeter,omitempty"`
	// RefillFrequencyInDays - The frequency at which this commitment plan's included quantities are refilled.
	RefillFrequencyInDays *int32 `json:"refillFrequencyInDays,omitempty"`
	// SuspendPlanOnOverage - Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.
	SuspendPlanOnOverage *bool `json:"suspendPlanOnOverage,omitempty"`
}

Properties properties of an Azure ML commitment plan.

type Resource

type Resource struct {
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - User-defined tags for the resource.
	Tags *map[string]*string `json:"tags,omitempty"`
}

Resource common properties of an ARM resource.

type ResourceSku

type ResourceSku struct {
	// Capacity - 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.
	Capacity *int32 `json:"capacity,omitempty"`
	// Name - The SKU name. Along with tier, uniquely identifies the SKU.
	Name *string `json:"name,omitempty"`
	// Tier - The SKU tier. Along with name, uniquely identifies the SKU.
	Tier *string `json:"tier,omitempty"`
}

ResourceSku the SKU of a resource.

type UsageHistoryClient

type UsageHistoryClient struct {
	BaseClient
}

UsageHistoryClient is the these APIs allow end users to operate on Azure Machine Learning Commitment Plans resources and their child Commitment Association resources. They support CRUD operations for commitment plans, get and list operations for commitment associations, moving commitment associations between commitment plans, and retrieving commitment plan usage history.

func NewUsageHistoryClient

func NewUsageHistoryClient(subscriptionID string) UsageHistoryClient

NewUsageHistoryClient creates an instance of the UsageHistoryClient client.

func NewUsageHistoryClientWithBaseURI

func NewUsageHistoryClientWithBaseURI(baseURI string, subscriptionID string) UsageHistoryClient

NewUsageHistoryClientWithBaseURI creates an instance of the UsageHistoryClient client.

func (UsageHistoryClient) List

func (client UsageHistoryClient) List(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (result PlanUsageHistoryListResultPage, err error)

List retrieve the usage history for an Azure ML commitment plan.

resourceGroupName is the resource group name. commitmentPlanName is the Azure ML commitment plan name. skipToken is continuation token for pagination.

func (UsageHistoryClient) ListComplete

func (client UsageHistoryClient) ListComplete(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (result PlanUsageHistoryListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UsageHistoryClient) ListPreparer

func (client UsageHistoryClient) ListPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (UsageHistoryClient) ListResponder

func (client UsageHistoryClient) ListResponder(resp *http.Response) (result PlanUsageHistoryListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UsageHistoryClient) ListSender

func (client UsageHistoryClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL