commitmentplans

package
v11.2.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 6, 2017 License: Apache-2.0 Imports: 5 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 CommitmentAssociation 

type CommitmentAssociation struct {
	autorest.Response `json:"-"`
	ID                *string                          `json:"id,omitempty"`
	Name              *string                          `json:"name,omitempty"`
	Location          *string                          `json:"location,omitempty"`
	Type              *string                          `json:"type,omitempty"`
	Tags              *map[string]*string              `json:"tags,omitempty"`
	Etag              *string                          `json:"etag,omitempty"`
	Properties        *CommitmentAssociationProperties `json:"properties,omitempty"`
}

CommitmentAssociation is 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          *string                  `json:"nextLink,omitempty"`
	Value             *[]CommitmentAssociation `json:"value,omitempty"`
}

CommitmentAssociationListResult is a page of commitment association resources.

func (CommitmentAssociationListResult) CommitmentAssociationListResultPreparer 

func (client CommitmentAssociationListResult) CommitmentAssociationListResultPreparer() (*http.Request, error)

CommitmentAssociationListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type CommitmentAssociationProperties 

type CommitmentAssociationProperties struct {
	AssociatedResourceID *string    `json:"associatedResourceId,omitempty"`
	CommitmentPlanID     *string    `json:"commitmentPlanId,omitempty"`
	CreationDate         *date.Time `json:"creationDate,omitempty"`
}

CommitmentAssociationProperties is properties of an Azure ML commitment association.

type CommitmentAssociationsClient 

type CommitmentAssociationsClient struct {
	ManagementClient
}

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(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(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(resourceGroupName string, commitmentPlanName string, skipToken string) (result CommitmentAssociationListResult, 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(resourceGroupName string, commitmentPlanName string, skipToken string, cancel <-chan struct{}) (<-chan CommitmentAssociation, <-chan error)

ListComplete gets all elements from the list without paging.

func (CommitmentAssociationsClient) ListNextResults 

func (client CommitmentAssociationsClient) ListNextResults(lastResults CommitmentAssociationListResult) (result CommitmentAssociationListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (CommitmentAssociationsClient) ListPreparer 

func (client CommitmentAssociationsClient) ListPreparer(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(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(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                *string             `json:"id,omitempty"`
	Name              *string             `json:"name,omitempty"`
	Location          *string             `json:"location,omitempty"`
	Type              *string             `json:"type,omitempty"`
	Tags              *map[string]*string `json:"tags,omitempty"`
	Etag              *string             `json:"etag,omitempty"`
	Properties        *Properties         `json:"properties,omitempty"`
	Sku               *ResourceSku        `json:"sku,omitempty"`
}

CommitmentPlan is an Azure ML commitment plan resource.

type GroupClient 

type GroupClient struct {
	ManagementClient
}

GroupClient 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 NewGroupClient 

func NewGroupClient(subscriptionID string) GroupClient

NewGroupClient creates an instance of the GroupClient client.

func NewGroupClientWithBaseURI 

func NewGroupClientWithBaseURI(baseURI string, subscriptionID string) GroupClient

NewGroupClientWithBaseURI creates an instance of the GroupClient client.

func (GroupClient) CreateOrUpdate 

func (client GroupClient) CreateOrUpdate(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 (GroupClient) CreateOrUpdatePreparer 

func (client GroupClient) CreateOrUpdatePreparer(createOrUpdatePayload CommitmentPlan, resourceGroupName string, commitmentPlanName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupClient) CreateOrUpdateResponder 

func (client GroupClient) 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 (GroupClient) CreateOrUpdateSender 

func (client GroupClient) 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 (GroupClient) Get 

func (client GroupClient) Get(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 (GroupClient) GetPreparer 

func (client GroupClient) GetPreparer(resourceGroupName string, commitmentPlanName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupClient) GetResponder 

func (client GroupClient) 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 (GroupClient) GetSender 

func (client GroupClient) 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 (GroupClient) List 

func (client GroupClient) List(skipToken string) (result ListResult, err error)

List retrieve all Azure ML commitment plans in a subscription.

skipToken is continuation token for pagination.

func (GroupClient) ListComplete 

func (client GroupClient) ListComplete(skipToken string, cancel <-chan struct{}) (<-chan CommitmentPlan, <-chan error)

ListComplete gets all elements from the list without paging.

func (GroupClient) ListInResourceGroup 

func (client GroupClient) ListInResourceGroup(resourceGroupName string, skipToken string) (result ListResult, 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 (GroupClient) ListInResourceGroupComplete 

func (client GroupClient) ListInResourceGroupComplete(resourceGroupName string, skipToken string, cancel <-chan struct{}) (<-chan CommitmentPlan, <-chan error)

ListInResourceGroupComplete gets all elements from the list without paging.

func (GroupClient) ListInResourceGroupNextResults 

func (client GroupClient) ListInResourceGroupNextResults(lastResults ListResult) (result ListResult, err error)

ListInResourceGroupNextResults retrieves the next set of results, if any.

func (GroupClient) ListInResourceGroupPreparer 

func (client GroupClient) ListInResourceGroupPreparer(resourceGroupName string, skipToken string) (*http.Request, error)

ListInResourceGroupPreparer prepares the ListInResourceGroup request.

func (GroupClient) ListInResourceGroupResponder 

func (client GroupClient) 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 (GroupClient) ListInResourceGroupSender 

func (client GroupClient) 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 (GroupClient) ListNextResults 

func (client GroupClient) ListNextResults(lastResults ListResult) (result ListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (GroupClient) ListPreparer 

func (client GroupClient) ListPreparer(skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupClient) ListResponder 

func (client GroupClient) 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 (GroupClient) ListSender 

func (client GroupClient) 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 (GroupClient) Patch 

func (client GroupClient) Patch(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 (GroupClient) PatchPreparer 

func (client GroupClient) PatchPreparer(patchPayload PatchPayload, resourceGroupName string, commitmentPlanName string) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (GroupClient) PatchResponder 

func (client GroupClient) 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 (GroupClient) PatchSender 

func (client GroupClient) 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 (GroupClient) Remove 

func (client GroupClient) Remove(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 (GroupClient) RemovePreparer 

func (client GroupClient) RemovePreparer(resourceGroupName string, commitmentPlanName string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (GroupClient) RemoveResponder 

func (client GroupClient) 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 (GroupClient) RemoveSender 

func (client GroupClient) 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 ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	NextLink          *string           `json:"nextLink,omitempty"`
	Value             *[]CommitmentPlan `json:"value,omitempty"`
}

ListResult is a page of commitment plan resources.

func (ListResult) ListResultPreparer 

func (client ListResult) ListResultPreparer() (*http.Request, error)

ListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ManagementClient 

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

ManagementClient is the base client for Commitmentplans.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type MoveCommitmentAssociationRequest 

type MoveCommitmentAssociationRequest struct {
	DestinationPlanID *string `json:"destinationPlanId,omitempty"`
}

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

type PatchPayload 

type PatchPayload struct {
	Tags *map[string]*string `json:"tags,omitempty"`
	Sku  *ResourceSku        `json:"sku,omitempty"`
}

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

type PlanQuantity 

type PlanQuantity struct {
	Allowance             *float64 `json:"allowance,omitempty"`
	Amount                *float64 `json:"amount,omitempty"`
	IncludedQuantityMeter *string  `json:"includedQuantityMeter,omitempty"`
	OverageMeter          *string  `json:"overageMeter,omitempty"`
}

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

type PlanUsageHistory 

type PlanUsageHistory struct {
	PlanDeletionOverage       *map[string]*float64 `json:"planDeletionOverage,omitempty"`
	PlanMigrationOverage      *map[string]*float64 `json:"planMigrationOverage,omitempty"`
	PlanQuantitiesAfterUsage  *map[string]*float64 `json:"planQuantitiesAfterUsage,omitempty"`
	PlanQuantitiesBeforeUsage *map[string]*float64 `json:"planQuantitiesBeforeUsage,omitempty"`
	PlanUsageOverage          *map[string]*float64 `json:"planUsageOverage,omitempty"`
	Usage                     *map[string]*float64 `json:"usage,omitempty"`
	UsageDate                 *date.Time           `json:"usageDate,omitempty"`
}

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

type PlanUsageHistoryListResult 

type PlanUsageHistoryListResult struct {
	autorest.Response `json:"-"`
	NextLink          *string             `json:"nextLink,omitempty"`
	Value             *[]PlanUsageHistory `json:"value,omitempty"`
}

PlanUsageHistoryListResult is a page of usage history.

func (PlanUsageHistoryListResult) PlanUsageHistoryListResultPreparer 

func (client PlanUsageHistoryListResult) PlanUsageHistoryListResultPreparer() (*http.Request, error)

PlanUsageHistoryListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type Properties 

type Properties struct {
	ChargeForOverage      *bool                     `json:"chargeForOverage,omitempty"`
	ChargeForPlan         *bool                     `json:"chargeForPlan,omitempty"`
	CreationDate          *date.Time                `json:"creationDate,omitempty"`
	IncludedQuantities    *map[string]*PlanQuantity `json:"includedQuantities,omitempty"`
	MaxAssociationLimit   *int32                    `json:"maxAssociationLimit,omitempty"`
	MaxCapacityLimit      *int32                    `json:"maxCapacityLimit,omitempty"`
	MinCapacityLimit      *int32                    `json:"minCapacityLimit,omitempty"`
	PlanMeter             *string                   `json:"planMeter,omitempty"`
	RefillFrequencyInDays *int32                    `json:"refillFrequencyInDays,omitempty"`
	SuspendPlanOnOverage  *bool                     `json:"suspendPlanOnOverage,omitempty"`
}

Properties is properties of an Azure ML commitment plan.

type Resource 

type Resource struct {
	ID       *string             `json:"id,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Location *string             `json:"location,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
}

Resource is common properties of an ARM resource.

type ResourceSku 

type ResourceSku struct {
	Capacity *int32  `json:"capacity,omitempty"`
	Name     *string `json:"name,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

ResourceSku is the SKU of a resource.

type UsageHistoryClient 

type UsageHistoryClient struct {
	ManagementClient
}

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(resourceGroupName string, commitmentPlanName string, skipToken string) (result PlanUsageHistoryListResult, 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(resourceGroupName string, commitmentPlanName string, skipToken string, cancel <-chan struct{}) (<-chan PlanUsageHistory, <-chan error)

ListComplete gets all elements from the list without paging.

func (UsageHistoryClient) ListNextResults 

func (client UsageHistoryClient) ListNextResults(lastResults PlanUsageHistoryListResult) (result PlanUsageHistoryListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (UsageHistoryClient) ListPreparer 

func (client UsageHistoryClient) ListPreparer(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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.