const (
// DefaultBaseURI is the default URI used for the service Commitmentplans
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Commitmentplans.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
CatalogSku details of a commitment plan SKU.
type CatalogSku struct {
// ResourceType - READ-ONLY; Resource type name
ResourceType *string `json:"resourceType,omitempty"`
// Name - READ-ONLY; SKU name
Name *string `json:"name,omitempty"`
// Tier - READ-ONLY; SKU tier
Tier *string `json:"tier,omitempty"`
// Locations - READ-ONLY; Regions where the SKU is available.
Locations *[]string `json:"locations,omitempty"`
// Capacity - READ-ONLY; SKU scaling information
Capacity *SkuCapacity `json:"capacity,omitempty"`
// Capabilities - READ-ONLY; The capability information for the specified SKU.
Capabilities *[]SkuCapability `json:"capabilities,omitempty"`
// Costs - READ-ONLY; The cost information for the specified SKU.
Costs *[]SkuCost `json:"costs,omitempty"`
// Restrictions - READ-ONLY; Restrictions which would prevent a SKU from being used. This is empty if there are no restrictions.
Restrictions *[]SkuRestrictions `json:"restrictions,omitempty"`
}
func (cs CatalogSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CatalogSku.
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.
type Client struct {
BaseClient
}
func NewClient(subscriptionID string) Client
NewClient creates an instance of the Client client.
func NewClientWithBaseURI(baseURI string, subscriptionID string) Client
NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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. Parameters: createOrUpdatePayload - the payload to create or update the Azure ML commitment plan. resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name.
func (client Client) CreateOrUpdatePreparer(ctx context.Context, createOrUpdatePayload CommitmentPlan, resourceGroupName string, commitmentPlanName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 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 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. Parameters: resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name.
func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 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 Client) List(ctx context.Context, skipToken string) (result ListResultPage, err error)
List retrieve all Azure ML commitment plans in a subscription. Parameters: skipToken - continuation token for pagination.
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 Client) ListInResourceGroup(ctx context.Context, resourceGroupName string, skipToken string) (result ListResultPage, err error)
ListInResourceGroup retrieve all Azure ML commitment plans in a resource group. Parameters: resourceGroupName - the resource group name. skipToken - continuation token for pagination.
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 Client) ListInResourceGroupPreparer(ctx context.Context, resourceGroupName string, skipToken string) (*http.Request, error)
ListInResourceGroupPreparer prepares the ListInResourceGroup request.
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 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 Client) ListPreparer(ctx context.Context, skipToken string) (*http.Request, error)
ListPreparer prepares the List request.
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 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 Client) Patch(ctx context.Context, patchPayload PatchPayload, resourceGroupName string, commitmentPlanName string) (result CommitmentPlan, err error)
Patch patch an existing Azure ML commitment plan resource. Parameters: patchPayload - the payload to use to patch the Azure ML commitment plan. Only tags and SKU may be modified on an existing commitment plan. resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name.
func (client Client) PatchPreparer(ctx context.Context, patchPayload PatchPayload, resourceGroupName string, commitmentPlanName string) (*http.Request, error)
PatchPreparer prepares the Patch request.
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 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 Client) Remove(ctx context.Context, resourceGroupName string, commitmentPlanName string) (result autorest.Response, err error)
Remove remove an existing Azure ML commitment plan. Parameters: resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name.
func (client Client) RemovePreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string) (*http.Request, error)
RemovePreparer prepares the Remove request.
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 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.
CommitmentAssociation represents the association between a commitment plan and some other resource, such as a Machine Learning web service.
type CommitmentAssociation struct {
autorest.Response `json:"-"`
// 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"`
// ID - READ-ONLY; Resource Id.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Tags - User-defined tags for the resource.
Tags map[string]*string `json:"tags"`
}
func (ca CommitmentAssociation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommitmentAssociation.
CommitmentAssociationListResult a page of commitment association resources.
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"`
}
func (calr CommitmentAssociationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
CommitmentAssociationListResultIterator provides access to a complete listing of CommitmentAssociation values.
type CommitmentAssociationListResultIterator struct {
// contains filtered or unexported fields
}
func NewCommitmentAssociationListResultIterator(page CommitmentAssociationListResultPage) CommitmentAssociationListResultIterator
Creates a new instance of the CommitmentAssociationListResultIterator type.
func (iter *CommitmentAssociationListResultIterator) 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. Deprecated: Use NextWithContext() instead.
func (iter *CommitmentAssociationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CommitmentAssociationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CommitmentAssociationListResultIterator) Response() CommitmentAssociationListResult
Response returns the raw server response from the last page request.
func (iter CommitmentAssociationListResultIterator) Value() CommitmentAssociation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
CommitmentAssociationListResultPage contains a page of CommitmentAssociation values.
type CommitmentAssociationListResultPage struct {
// contains filtered or unexported fields
}
func NewCommitmentAssociationListResultPage(cur CommitmentAssociationListResult, getNextPage func(context.Context, CommitmentAssociationListResult) (CommitmentAssociationListResult, error)) CommitmentAssociationListResultPage
Creates a new instance of the CommitmentAssociationListResultPage type.
func (page *CommitmentAssociationListResultPage) 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. Deprecated: Use NextWithContext() instead.
func (page *CommitmentAssociationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page CommitmentAssociationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CommitmentAssociationListResultPage) Response() CommitmentAssociationListResult
Response returns the raw server response from the last page request.
func (page CommitmentAssociationListResultPage) Values() []CommitmentAssociation
Values returns the slice of values for the current page or nil if there are no values.
CommitmentAssociationProperties properties of an Azure ML commitment association.
type CommitmentAssociationProperties struct {
// AssociatedResourceID - READ-ONLY; 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 - READ-ONLY; The ARM ID of the parent Azure ML commitment plan.
CommitmentPlanID *string `json:"commitmentPlanId,omitempty"`
// CreationDate - READ-ONLY; The date at which this commitment association was created, in ISO 8601 format.
CreationDate *date.Time `json:"creationDate,omitempty"`
}
func (capVar CommitmentAssociationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommitmentAssociationProperties.
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.
type CommitmentAssociationsClient struct {
BaseClient
}
func NewCommitmentAssociationsClient(subscriptionID string) CommitmentAssociationsClient
NewCommitmentAssociationsClient creates an instance of the CommitmentAssociationsClient client.
func NewCommitmentAssociationsClientWithBaseURI(baseURI string, subscriptionID string) CommitmentAssociationsClient
NewCommitmentAssociationsClientWithBaseURI creates an instance of the CommitmentAssociationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CommitmentAssociationsClient) Get(ctx context.Context, resourceGroupName string, commitmentPlanName string, commitmentAssociationName string) (result CommitmentAssociation, err error)
Get get a commitment association. Parameters: resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name. commitmentAssociationName - the commitment association name.
func (client CommitmentAssociationsClient) GetPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, commitmentAssociationName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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. Parameters: resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name. skipToken - continuation token for pagination.
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 (client CommitmentAssociationsClient) ListPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (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. Parameters: resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name. commitmentAssociationName - the commitment association name. movePayload - the move request payload.
func (client CommitmentAssociationsClient) MovePreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, commitmentAssociationName string, movePayload MoveCommitmentAssociationRequest) (*http.Request, error)
MovePreparer prepares the Move request.
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 (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.
CommitmentPlan an Azure ML commitment plan resource.
type CommitmentPlan struct {
autorest.Response `json:"-"`
// Etag - An entity tag used to enforce optimistic concurrency.
Etag *string `json:"etag,omitempty"`
// Properties - READ-ONLY; The commitment plan properties.
Properties *Properties `json:"properties,omitempty"`
// Sku - The commitment plan SKU.
Sku *ResourceSku `json:"sku,omitempty"`
// ID - READ-ONLY; Resource Id.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Tags - User-defined tags for the resource.
Tags map[string]*string `json:"tags"`
}
func (cp CommitmentPlan) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommitmentPlan.
ListResult a page of commitment plan resources.
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"`
}
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListResultIterator provides access to a complete listing of CommitmentPlan values.
type ListResultIterator struct {
// contains filtered or unexported fields
}
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
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. Deprecated: Use NextWithContext() instead.
func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
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.
ListResultPage contains a page of CommitmentPlan values.
type ListResultPage struct {
// contains filtered or unexported fields
}
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
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. Deprecated: Use NextWithContext() instead.
func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (page ListResultPage) Values() []CommitmentPlan
Values returns the slice of values for the current page or nil if there are no values.
MoveCommitmentAssociationRequest specifies the destination Azure ML commitment plan for a move operation.
type MoveCommitmentAssociationRequest struct {
// DestinationPlanID - The ARM ID of the commitment plan to re-parent the commitment association to.
DestinationPlanID *string `json:"destinationPlanId,omitempty"`
}
OperationDisplayInfo the API operation info.
type OperationDisplayInfo struct {
// Description - READ-ONLY; The description of the operation.
Description *string `json:"description,omitempty"`
// Operation - READ-ONLY; The action that users can perform, based on their permission level.
Operation *string `json:"operation,omitempty"`
// Provider - READ-ONLY; The service provider.
Provider *string `json:"provider,omitempty"`
// Resource - READ-ONLY; The resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
}
func (odi OperationDisplayInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplayInfo.
OperationEntity an API operation.
type OperationEntity struct {
// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}.
Name *string `json:"name,omitempty"`
// Display - The API operation info.
Display *OperationDisplayInfo `json:"display,omitempty"`
}
func (oe OperationEntity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationEntity.
OperationEntityListResult the list of REST API operations.
type OperationEntityListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of operations.
Value *[]OperationEntity `json:"value,omitempty"`
}
func (oelr OperationEntityListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationEntityListResult.
OperationsClient 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.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationEntityListResult, err error)
List lists all of the available Azure Machine Learning Studio Commitment Plan RP REST API operations.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationEntityListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) 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.
PatchPayload the properties of a commitment plan which may be updated via PATCH.
type PatchPayload struct {
// Tags - User-defined tags for the commitment plan.
Tags map[string]*string `json:"tags"`
// Sku - The commitment plan SKU.
Sku *ResourceSku `json:"sku,omitempty"`
}
func (pp PatchPayload) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchPayload.
PlanQuantity represents the quantity a commitment plan provides of a metered resource.
type PlanQuantity struct {
// Allowance - READ-ONLY; The quantity added to the commitment plan at an interval specified by its allowance frequency.
Allowance *float64 `json:"allowance,omitempty"`
// Amount - READ-ONLY; The quantity available to the plan the last time usage was calculated.
Amount *float64 `json:"amount,omitempty"`
// IncludedQuantityMeter - READ-ONLY; The Azure meter for usage against included quantities.
IncludedQuantityMeter *string `json:"includedQuantityMeter,omitempty"`
// OverageMeter - READ-ONLY; The Azure meter for usage which exceeds included quantities.
OverageMeter *string `json:"overageMeter,omitempty"`
}
func (pq PlanQuantity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PlanQuantity.
PlanUsageHistory represents historical information about usage of the Azure resources associated with a commitment plan.
type PlanUsageHistory struct {
// PlanDeletionOverage - Overage incurred as a result of deleting a commitment plan.
PlanDeletionOverage map[string]*float64 `json:"planDeletionOverage"`
// PlanMigrationOverage - Overage incurred as a result of migrating a commitment plan from one SKU to another.
PlanMigrationOverage map[string]*float64 `json:"planMigrationOverage"`
// PlanQuantitiesAfterUsage - Included quantities remaining after usage against the commitment plan's associated resources was calculated.
PlanQuantitiesAfterUsage map[string]*float64 `json:"planQuantitiesAfterUsage"`
// PlanQuantitiesBeforeUsage - Included quantities remaining before usage against the commitment plan's associated resources was calculated.
PlanQuantitiesBeforeUsage map[string]*float64 `json:"planQuantitiesBeforeUsage"`
// 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"`
// Usage - Usage against the commitment plan's associated resources.
Usage map[string]*float64 `json:"usage"`
// UsageDate - The date of usage, in ISO 8601 format.
UsageDate *date.Time `json:"usageDate,omitempty"`
}
func (puh PlanUsageHistory) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PlanUsageHistory.
PlanUsageHistoryListResult a page of usage history.
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"`
}
func (puhlr PlanUsageHistoryListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
PlanUsageHistoryListResultIterator provides access to a complete listing of PlanUsageHistory values.
type PlanUsageHistoryListResultIterator struct {
// contains filtered or unexported fields
}
func NewPlanUsageHistoryListResultIterator(page PlanUsageHistoryListResultPage) PlanUsageHistoryListResultIterator
Creates a new instance of the PlanUsageHistoryListResultIterator type.
func (iter *PlanUsageHistoryListResultIterator) 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. Deprecated: Use NextWithContext() instead.
func (iter *PlanUsageHistoryListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter PlanUsageHistoryListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PlanUsageHistoryListResultIterator) Response() PlanUsageHistoryListResult
Response returns the raw server response from the last page request.
func (iter PlanUsageHistoryListResultIterator) Value() PlanUsageHistory
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PlanUsageHistoryListResultPage contains a page of PlanUsageHistory values.
type PlanUsageHistoryListResultPage struct {
// contains filtered or unexported fields
}
func NewPlanUsageHistoryListResultPage(cur PlanUsageHistoryListResult, getNextPage func(context.Context, PlanUsageHistoryListResult) (PlanUsageHistoryListResult, error)) PlanUsageHistoryListResultPage
Creates a new instance of the PlanUsageHistoryListResultPage type.
func (page *PlanUsageHistoryListResultPage) 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. Deprecated: Use NextWithContext() instead.
func (page *PlanUsageHistoryListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page PlanUsageHistoryListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PlanUsageHistoryListResultPage) Response() PlanUsageHistoryListResult
Response returns the raw server response from the last page request.
func (page PlanUsageHistoryListResultPage) Values() []PlanUsageHistory
Values returns the slice of values for the current page or nil if there are no values.
Properties properties of an Azure ML commitment plan.
type Properties struct {
// ChargeForOverage - READ-ONLY; Indicates whether usage beyond the commitment plan's included quantities will be charged.
ChargeForOverage *bool `json:"chargeForOverage,omitempty"`
// ChargeForPlan - READ-ONLY; Indicates whether the commitment plan will incur a charge.
ChargeForPlan *bool `json:"chargeForPlan,omitempty"`
// CreationDate - READ-ONLY; The date at which this commitment plan was created, in ISO 8601 format.
CreationDate *date.Time `json:"creationDate,omitempty"`
// IncludedQuantities - READ-ONLY; The included resource quantities this plan gives you.
IncludedQuantities map[string]*PlanQuantity `json:"includedQuantities"`
// MaxAssociationLimit - READ-ONLY; The maximum number of commitment associations that can be children of this commitment plan.
MaxAssociationLimit *int32 `json:"maxAssociationLimit,omitempty"`
// MaxCapacityLimit - READ-ONLY; The maximum scale-out capacity for this commitment plan.
MaxCapacityLimit *int32 `json:"maxCapacityLimit,omitempty"`
// MinCapacityLimit - READ-ONLY; The minimum scale-out capacity for this commitment plan.
MinCapacityLimit *int32 `json:"minCapacityLimit,omitempty"`
// PlanMeter - READ-ONLY; The Azure meter which will be used to charge for this commitment plan.
PlanMeter *string `json:"planMeter,omitempty"`
// RefillFrequencyInDays - READ-ONLY; The frequency at which this commitment plan's included quantities are refilled.
RefillFrequencyInDays *int32 `json:"refillFrequencyInDays,omitempty"`
// SuspendPlanOnOverage - READ-ONLY; 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"`
}
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
Resource common properties of an ARM resource.
type Resource struct {
// ID - READ-ONLY; Resource Id.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Tags - User-defined tags for the resource.
Tags map[string]*string `json:"tags"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceSku the SKU of a resource.
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"`
}
ResourceSkuRestrictionsReasonCode enumerates the values for resource sku restrictions reason code.
type ResourceSkuRestrictionsReasonCode string
const (
// NotAvailableForSubscription ...
NotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription"
// QuotaID ...
QuotaID ResourceSkuRestrictionsReasonCode = "QuotaId"
)
func PossibleResourceSkuRestrictionsReasonCodeValues() []ResourceSkuRestrictionsReasonCode
PossibleResourceSkuRestrictionsReasonCodeValues returns an array of possible values for the ResourceSkuRestrictionsReasonCode const type.
ResourceSkuRestrictionsType enumerates the values for resource sku restrictions type.
type ResourceSkuRestrictionsType string
const (
// Location ...
Location ResourceSkuRestrictionsType = "location"
// Zone ...
Zone ResourceSkuRestrictionsType = "zone"
)
func PossibleResourceSkuRestrictionsTypeValues() []ResourceSkuRestrictionsType
PossibleResourceSkuRestrictionsTypeValues returns an array of possible values for the ResourceSkuRestrictionsType const type.
SkuCapability describes The SKU capabilities object.
type SkuCapability struct {
// Name - READ-ONLY; The capability name.
Name *string `json:"name,omitempty"`
// Value - READ-ONLY; The capability value.
Value *string `json:"value,omitempty"`
}
func (sc SkuCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SkuCapability.
SkuCapacity describes scaling information of a SKU.
type SkuCapacity struct {
// Minimum - READ-ONLY; The minimum capacity.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum capacity that can be set.
Maximum *int64 `json:"maximum,omitempty"`
// Default - READ-ONLY; The default capacity.
Default *int64 `json:"default,omitempty"`
// ScaleType - READ-ONLY; The scale type applicable to the sku. Possible values include: 'Automatic', 'Manual', 'None'
ScaleType SkuCapacityScaleType `json:"scaleType,omitempty"`
}
func (sc SkuCapacity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SkuCapacity.
SkuCapacityScaleType enumerates the values for sku capacity scale type.
type SkuCapacityScaleType string
const (
// Automatic ...
Automatic SkuCapacityScaleType = "Automatic"
// Manual ...
Manual SkuCapacityScaleType = "Manual"
// None ...
None SkuCapacityScaleType = "None"
)
func PossibleSkuCapacityScaleTypeValues() []SkuCapacityScaleType
PossibleSkuCapacityScaleTypeValues returns an array of possible values for the SkuCapacityScaleType const type.
SkuCost describes metadata for SKU cost info.
type SkuCost struct {
// MeterID - READ-ONLY; The meter used for this part of a SKU's cost.
MeterID *string `json:"meterID,omitempty"`
// Quantity - READ-ONLY; The multiplier for the meter ID.
Quantity *int64 `json:"quantity,omitempty"`
// ExtendedUnit - READ-ONLY; The overall duration represented by the quantity.
ExtendedUnit *string `json:"extendedUnit,omitempty"`
}
func (sc SkuCost) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SkuCost.
SkuListResult the list of commitment plan SKUs.
type SkuListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY
Value *[]CatalogSku `json:"value,omitempty"`
}
func (slr SkuListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SkuListResult.
SkuRestrictions describes restrictions which would prevent a SKU from being used.
type SkuRestrictions struct {
// Type - READ-ONLY; The type of restrictions. Possible values include: 'Location', 'Zone'
Type ResourceSkuRestrictionsType `json:"type,omitempty"`
// Values - READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
Values *[]string `json:"values,omitempty"`
// ReasonCode - READ-ONLY; The reason for restriction. Possible values include: 'QuotaID', 'NotAvailableForSubscription'
ReasonCode ResourceSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
}
func (sr SkuRestrictions) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SkuRestrictions.
SkusClient 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.
type SkusClient struct {
BaseClient
}
func NewSkusClient(subscriptionID string) SkusClient
NewSkusClient creates an instance of the SkusClient client.
func NewSkusClientWithBaseURI(baseURI string, subscriptionID string) SkusClient
NewSkusClientWithBaseURI creates an instance of the SkusClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client SkusClient) List(ctx context.Context) (result SkuListResult, err error)
List lists the available commitment plan SKUs.
func (client SkusClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client SkusClient) ListResponder(resp *http.Response) (result SkuListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SkusClient) 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.
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.
type UsageHistoryClient struct {
BaseClient
}
func NewUsageHistoryClient(subscriptionID string) UsageHistoryClient
NewUsageHistoryClient creates an instance of the UsageHistoryClient client.
func NewUsageHistoryClientWithBaseURI(baseURI string, subscriptionID string) UsageHistoryClient
NewUsageHistoryClientWithBaseURI creates an instance of the UsageHistoryClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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. Parameters: resourceGroupName - the resource group name. commitmentPlanName - the Azure ML commitment plan name. skipToken - continuation token for pagination.
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 (client UsageHistoryClient) ListPreparer(ctx context.Context, resourceGroupName string, commitmentPlanName string, skipToken string) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
| Name | Synopsis |
|---|---|
| .. | |
| commitmentplansapi | Deprecated: Please note, this package has been deprecated. |