consumption

package
v14.1.1+incompatible Latest Latest
Warning

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

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

Documentation

Overview

Package consumption implements the Azure ARM Consumption service API version 2018-01-31.

Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Consumption
	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 Consumption.

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 Budget 

type Budget struct {
	autorest.Response `json:"-"`
	*BudgetProperties `json:"properties,omitempty"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// ETag - eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not.
	ETag *string `json:"eTag,omitempty"`
}

Budget a budget resource.

func (*Budget) UnmarshalJSON 

func (b *Budget) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Budget struct.

type BudgetProperties 

type BudgetProperties struct {
	// Category - The category of the budget, whether the budget tracks cost or usage. Possible values include: 'Cost', 'Usage'
	Category CategoryType `json:"category,omitempty"`
	// Amount - The total amount of cost to track with the budget
	Amount *decimal.Decimal `json:"amount,omitempty"`
	// TimeGrain - The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values include: 'Monthly', 'Quarterly', 'Annually'
	TimeGrain TimeGrainType `json:"timeGrain,omitempty"`
	// TimePeriod - Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should  be selected within the timegrain preiod. There are no restrictions on the end date.
	TimePeriod *BudgetTimePeriod `json:"timePeriod,omitempty"`
	// Filters - May be used to filter budgets by resource group, resource, or meter.
	Filters *Filters `json:"filters,omitempty"`
	// CurrentSpend - The current amount of cost which is being tracked for a budget.
	CurrentSpend *CurrentSpend `json:"currentSpend,omitempty"`
	// Notifications - Dictionary of notifications associated with the budget. Budget can have up to five notifications.
	Notifications map[string]*Notification `json:"notifications"`
}

BudgetProperties the properties of the budget.

func (BudgetProperties) MarshalJSON 

func (bp BudgetProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BudgetProperties.

type BudgetTimePeriod 

type BudgetTimePeriod struct {
	// StartDate - The start date for the budget.
	StartDate *date.Time `json:"startDate,omitempty"`
	// EndDate - The end date for the budget. If not provided, we default this to 10 years from the start date.
	EndDate *date.Time `json:"endDate,omitempty"`
}

BudgetTimePeriod the start and end date for a budget.

type BudgetsClient 

type BudgetsClient struct {
	BaseClient
}

BudgetsClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

func NewBudgetsClient 

func NewBudgetsClient(subscriptionID string) BudgetsClient

NewBudgetsClient creates an instance of the BudgetsClient client.

func NewBudgetsClientWithBaseURI 

func NewBudgetsClientWithBaseURI(baseURI string, subscriptionID string) BudgetsClient

NewBudgetsClientWithBaseURI creates an instance of the BudgetsClient client.

func (BudgetsClient) CreateOrUpdate 

func (client BudgetsClient) CreateOrUpdate(ctx context.Context, budgetName string, parameters Budget) (result Budget, err error)

CreateOrUpdate the operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

budgetName is budget Name. parameters is parameters supplied to the Create Budget operation.

func (BudgetsClient) CreateOrUpdateByResourceGroupName 

func (client BudgetsClient) CreateOrUpdateByResourceGroupName(ctx context.Context, resourceGroupName string, budgetName string, parameters Budget) (result Budget, err error)

CreateOrUpdateByResourceGroupName the operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

resourceGroupName is azure Resource Group Name. budgetName is budget Name. parameters is parameters supplied to the Create Budget operation.

func (BudgetsClient) CreateOrUpdateByResourceGroupNamePreparer 

func (client BudgetsClient) CreateOrUpdateByResourceGroupNamePreparer(ctx context.Context, resourceGroupName string, budgetName string, parameters Budget) (*http.Request, error)

CreateOrUpdateByResourceGroupNamePreparer prepares the CreateOrUpdateByResourceGroupName request.

func (BudgetsClient) CreateOrUpdateByResourceGroupNameResponder 

func (client BudgetsClient) CreateOrUpdateByResourceGroupNameResponder(resp *http.Response) (result Budget, err error)

CreateOrUpdateByResourceGroupNameResponder handles the response to the CreateOrUpdateByResourceGroupName request. The method always closes the http.Response Body.

func (BudgetsClient) CreateOrUpdateByResourceGroupNameSender 

func (client BudgetsClient) CreateOrUpdateByResourceGroupNameSender(req *http.Request) (*http.Response, error)

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

func (BudgetsClient) CreateOrUpdatePreparer 

func (client BudgetsClient) CreateOrUpdatePreparer(ctx context.Context, budgetName string, parameters Budget) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BudgetsClient) CreateOrUpdateResponder 

func (client BudgetsClient) CreateOrUpdateResponder(resp *http.Response) (result Budget, err error)

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

func (BudgetsClient) CreateOrUpdateSender 

func (client BudgetsClient) 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 (BudgetsClient) Delete 

func (client BudgetsClient) Delete(ctx context.Context, budgetName string) (result autorest.Response, err error)

Delete the operation to delete a budget.

budgetName is budget Name.

func (BudgetsClient) DeleteByResourceGroupName 

func (client BudgetsClient) DeleteByResourceGroupName(ctx context.Context, resourceGroupName string, budgetName string) (result autorest.Response, err error)

DeleteByResourceGroupName the operation to delete a budget.

resourceGroupName is azure Resource Group Name. budgetName is budget Name.

func (BudgetsClient) DeleteByResourceGroupNamePreparer 

func (client BudgetsClient) DeleteByResourceGroupNamePreparer(ctx context.Context, resourceGroupName string, budgetName string) (*http.Request, error)

DeleteByResourceGroupNamePreparer prepares the DeleteByResourceGroupName request.

func (BudgetsClient) DeleteByResourceGroupNameResponder 

func (client BudgetsClient) DeleteByResourceGroupNameResponder(resp *http.Response) (result autorest.Response, err error)

DeleteByResourceGroupNameResponder handles the response to the DeleteByResourceGroupName request. The method always closes the http.Response Body.

func (BudgetsClient) DeleteByResourceGroupNameSender 

func (client BudgetsClient) DeleteByResourceGroupNameSender(req *http.Request) (*http.Response, error)

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

func (BudgetsClient) DeletePreparer 

func (client BudgetsClient) DeletePreparer(ctx context.Context, budgetName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BudgetsClient) DeleteResponder 

func (client BudgetsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (BudgetsClient) DeleteSender 

func (client BudgetsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (BudgetsClient) Get 

func (client BudgetsClient) Get(ctx context.Context, budgetName string) (result Budget, err error)

Get gets the budget for a subscription by budget name.

budgetName is budget Name.

func (BudgetsClient) GetByResourceGroupName 

func (client BudgetsClient) GetByResourceGroupName(ctx context.Context, resourceGroupName string, budgetName string) (result Budget, err error)

GetByResourceGroupName gets the budget for a resource group under a subscription by budget name.

resourceGroupName is azure Resource Group Name. budgetName is budget Name.

func (BudgetsClient) GetByResourceGroupNamePreparer 

func (client BudgetsClient) GetByResourceGroupNamePreparer(ctx context.Context, resourceGroupName string, budgetName string) (*http.Request, error)

GetByResourceGroupNamePreparer prepares the GetByResourceGroupName request.

func (BudgetsClient) GetByResourceGroupNameResponder 

func (client BudgetsClient) GetByResourceGroupNameResponder(resp *http.Response) (result Budget, err error)

GetByResourceGroupNameResponder handles the response to the GetByResourceGroupName request. The method always closes the http.Response Body.

func (BudgetsClient) GetByResourceGroupNameSender 

func (client BudgetsClient) GetByResourceGroupNameSender(req *http.Request) (*http.Response, error)

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

func (BudgetsClient) GetPreparer 

func (client BudgetsClient) GetPreparer(ctx context.Context, budgetName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BudgetsClient) GetResponder 

func (client BudgetsClient) GetResponder(resp *http.Response) (result Budget, err error)

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

func (BudgetsClient) GetSender 

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

func (client BudgetsClient) List(ctx context.Context) (result BudgetsListResultPage, err error)

List lists all budgets for a subscription.

func (BudgetsClient) ListByResourceGroupName 

func (client BudgetsClient) ListByResourceGroupName(ctx context.Context, resourceGroupName string) (result BudgetsListResultPage, err error)

ListByResourceGroupName lists all budgets for a resource group under a subscription.

resourceGroupName is azure Resource Group Name.

func (BudgetsClient) ListByResourceGroupNameComplete 

func (client BudgetsClient) ListByResourceGroupNameComplete(ctx context.Context, resourceGroupName string) (result BudgetsListResultIterator, err error)

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

func (BudgetsClient) ListByResourceGroupNamePreparer 

func (client BudgetsClient) ListByResourceGroupNamePreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupNamePreparer prepares the ListByResourceGroupName request.

func (BudgetsClient) ListByResourceGroupNameResponder 

func (client BudgetsClient) ListByResourceGroupNameResponder(resp *http.Response) (result BudgetsListResult, err error)

ListByResourceGroupNameResponder handles the response to the ListByResourceGroupName request. The method always closes the http.Response Body.

func (BudgetsClient) ListByResourceGroupNameSender 

func (client BudgetsClient) ListByResourceGroupNameSender(req *http.Request) (*http.Response, error)

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

func (BudgetsClient) ListComplete 

func (client BudgetsClient) ListComplete(ctx context.Context) (result BudgetsListResultIterator, err error)

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

func (BudgetsClient) ListPreparer 

func (client BudgetsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (BudgetsClient) ListResponder 

func (client BudgetsClient) ListResponder(resp *http.Response) (result BudgetsListResult, err error)

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

func (BudgetsClient) ListSender 

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

type BudgetsListResult 

type BudgetsListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of budgets.
	Value *[]Budget `json:"value,omitempty"`
	// NextLink - The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

BudgetsListResult result of listing budgets. It contains a list of available budgets in the scope provided.

func (BudgetsListResult) IsEmpty 

func (blr BudgetsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BudgetsListResultIterator 

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

BudgetsListResultIterator provides access to a complete listing of Budget values.

func (*BudgetsListResultIterator) Next 

func (iter *BudgetsListResultIterator) 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 (BudgetsListResultIterator) NotDone 

func (iter BudgetsListResultIterator) NotDone() bool

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

func (BudgetsListResultIterator) Response 

func (iter BudgetsListResultIterator) Response() BudgetsListResult

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

func (BudgetsListResultIterator) Value 

func (iter BudgetsListResultIterator) Value() Budget

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

type BudgetsListResultPage 

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

BudgetsListResultPage contains a page of Budget values.

func (*BudgetsListResultPage) Next 

func (page *BudgetsListResultPage) 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 (BudgetsListResultPage) NotDone 

func (page BudgetsListResultPage) NotDone() bool

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

func (BudgetsListResultPage) Response 

func (page BudgetsListResultPage) Response() BudgetsListResult

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

func (BudgetsListResultPage) Values 

func (page BudgetsListResultPage) Values() []Budget

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

type CategoryType 

type CategoryType string

CategoryType enumerates the values for category type. 

const (
	// Cost ...
	Cost CategoryType = "Cost"
	// Usage ...
	Usage CategoryType = "Usage"
)

type CurrentSpend 

type CurrentSpend struct {
	// Amount - The total amount of cost which is being tracked by the budget.
	Amount *decimal.Decimal `json:"amount,omitempty"`
	// Unit - The unit of measure for the budget amount.
	Unit *string `json:"unit,omitempty"`
}

CurrentSpend the current amount of cost which is being tracked for a budget.

type Datagrain 

type Datagrain string

Datagrain enumerates the values for datagrain. 

const (
	// DailyGrain Daily grain of data
	DailyGrain Datagrain = "daily"
	// MonthlyGrain Monthly grain of data
	MonthlyGrain Datagrain = "monthly"
)

type ErrorDetails 

type ErrorDetails struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorDetails the details of the error.

type ErrorResponse 

type ErrorResponse struct {
	// Error - The details of the error.
	Error *ErrorDetails `json:"error,omitempty"`
}

ErrorResponse error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

type Filters 

type Filters struct {
	// ResourceGroups - The list of filters on resource groups, allowed at subscription level only.
	ResourceGroups *[]string `json:"resourceGroups,omitempty"`
	// Resources - The list of filters on resources.
	Resources *[]string `json:"resources,omitempty"`
	// Meters - The list of filters on meters, mandatory for budgets of usage category.
	Meters *[]string `json:"meters,omitempty"`
}

Filters may be used to filter budgets by resource group, resource, or meter.

type Marketplace 

type Marketplace struct {
	*MarketplaceProperties `json:"properties,omitempty"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

Marketplace an marketplace resource.

func (Marketplace) MarshalJSON 

func (mVar Marketplace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Marketplace.

func (*Marketplace) UnmarshalJSON 

func (mVar *Marketplace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Marketplace struct.

type MarketplaceProperties 

type MarketplaceProperties struct {
	// BillingPeriodID - The id of the billing period resource that the usage belongs to.
	BillingPeriodID *string `json:"billingPeriodId,omitempty"`
	// UsageStart - The start of the date time range covered by the usage detail.
	UsageStart *date.Time `json:"usageStart,omitempty"`
	// UsageEnd - The end of the date time range covered by the usage detail.
	UsageEnd *date.Time `json:"usageEnd,omitempty"`
	// ResourceRate - The marketplace resource rate.
	ResourceRate *decimal.Decimal `json:"resourceRate,omitempty"`
	// OfferName - The type of offer.
	OfferName *string `json:"offerName,omitempty"`
	// ResourceGroup - The name of resource group.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
	// OrderNumber - The order number.
	OrderNumber *string `json:"orderNumber,omitempty"`
	// InstanceName - The name of the resource instance that the usage is about.
	InstanceName *string `json:"instanceName,omitempty"`
	// InstanceID - The uri of the resource instance that the usage is about.
	InstanceID *string `json:"instanceId,omitempty"`
	// Currency - The ISO currency in which the meter is charged, for example, USD.
	Currency *string `json:"currency,omitempty"`
	// ConsumedQuantity - The quantity of usage.
	ConsumedQuantity *decimal.Decimal `json:"consumedQuantity,omitempty"`
	// UnitOfMeasure - The unit of measure.
	UnitOfMeasure *string `json:"unitOfMeasure,omitempty"`
	// PretaxCost - The amount of cost before tax.
	PretaxCost *decimal.Decimal `json:"pretaxCost,omitempty"`
	// IsEstimated - The estimated usage is subject to change.
	IsEstimated *bool `json:"isEstimated,omitempty"`
	// MeterID - The meter id.
	MeterID *string `json:"meterId,omitempty"`
	// SubscriptionGUID - Subscription guid.
	SubscriptionGUID *string `json:"subscriptionGuid,omitempty"`
	// SubscriptionName - Subscription name.
	SubscriptionName *string `json:"subscriptionName,omitempty"`
	// AccountName - Account name.
	AccountName *string `json:"accountName,omitempty"`
	// DepartmentName - Department name.
	DepartmentName *string `json:"departmentName,omitempty"`
	// ConsumedService - Consumed service name.
	ConsumedService *string `json:"consumedService,omitempty"`
	// CostCenter - The cost center of this department if it is a department and a costcenter exists
	CostCenter *string `json:"costCenter,omitempty"`
	// AdditionalProperties - Additional details of this usage item. By default this is not populated, unless it's specified in $expand.
	AdditionalProperties *string `json:"additionalProperties,omitempty"`
	// PublisherName - The name of publisher.
	PublisherName *string `json:"publisherName,omitempty"`
	// PlanName - The name of plan.
	PlanName *string `json:"planName,omitempty"`
}

MarketplaceProperties the properties of the marketplace usage detail.

type MarketplacesClient 

type MarketplacesClient struct {
	BaseClient
}

MarketplacesClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

func NewMarketplacesClient 

func NewMarketplacesClient(subscriptionID string) MarketplacesClient

NewMarketplacesClient creates an instance of the MarketplacesClient client.

func NewMarketplacesClientWithBaseURI 

func NewMarketplacesClientWithBaseURI(baseURI string, subscriptionID string) MarketplacesClient

NewMarketplacesClientWithBaseURI creates an instance of the MarketplacesClient client.

func (MarketplacesClient) List 

func (client MarketplacesClient) List(ctx context.Context, filter string, top *int32, skiptoken string) (result MarketplacesListResultPage, err error)

List lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.

filter is may be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. top is may be used to limit the number of results to the most recent N marketplaces. skiptoken is skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

func (MarketplacesClient) ListByBillingPeriod 

func (client MarketplacesClient) ListByBillingPeriod(ctx context.Context, billingPeriodName string, filter string, top *int32, skiptoken string) (result MarketplacesListResultPage, err error)

ListByBillingPeriod lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.

billingPeriodName is billing Period Name. filter is may be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. top is may be used to limit the number of results to the most recent N marketplaces. skiptoken is skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

func (MarketplacesClient) ListByBillingPeriodComplete 

func (client MarketplacesClient) ListByBillingPeriodComplete(ctx context.Context, billingPeriodName string, filter string, top *int32, skiptoken string) (result MarketplacesListResultIterator, err error)

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

func (MarketplacesClient) ListByBillingPeriodPreparer 

func (client MarketplacesClient) ListByBillingPeriodPreparer(ctx context.Context, billingPeriodName string, filter string, top *int32, skiptoken string) (*http.Request, error)

ListByBillingPeriodPreparer prepares the ListByBillingPeriod request.

func (MarketplacesClient) ListByBillingPeriodResponder 

func (client MarketplacesClient) ListByBillingPeriodResponder(resp *http.Response) (result MarketplacesListResult, err error)

ListByBillingPeriodResponder handles the response to the ListByBillingPeriod request. The method always closes the http.Response Body.

func (MarketplacesClient) ListByBillingPeriodSender 

func (client MarketplacesClient) ListByBillingPeriodSender(req *http.Request) (*http.Response, error)

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

func (MarketplacesClient) ListComplete 

func (client MarketplacesClient) ListComplete(ctx context.Context, filter string, top *int32, skiptoken string) (result MarketplacesListResultIterator, err error)

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

func (MarketplacesClient) ListPreparer 

func (client MarketplacesClient) ListPreparer(ctx context.Context, filter string, top *int32, skiptoken string) (*http.Request, error)

ListPreparer prepares the List request.

func (MarketplacesClient) ListResponder 

func (client MarketplacesClient) ListResponder(resp *http.Response) (result MarketplacesListResult, err error)

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

func (MarketplacesClient) ListSender 

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

type MarketplacesListResult 

type MarketplacesListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of marketplaces.
	Value *[]Marketplace `json:"value,omitempty"`
	// NextLink - The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

MarketplacesListResult result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.

func (MarketplacesListResult) IsEmpty 

func (mlr MarketplacesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type MarketplacesListResultIterator 

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

MarketplacesListResultIterator provides access to a complete listing of Marketplace values.

func (*MarketplacesListResultIterator) Next 

func (iter *MarketplacesListResultIterator) 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 (MarketplacesListResultIterator) NotDone 

func (iter MarketplacesListResultIterator) NotDone() bool

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

func (MarketplacesListResultIterator) Response 

func (iter MarketplacesListResultIterator) Response() MarketplacesListResult

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

func (MarketplacesListResultIterator) Value 

func (iter MarketplacesListResultIterator) Value() Marketplace

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

type MarketplacesListResultPage 

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

MarketplacesListResultPage contains a page of Marketplace values.

func (*MarketplacesListResultPage) Next 

func (page *MarketplacesListResultPage) 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 (MarketplacesListResultPage) NotDone 

func (page MarketplacesListResultPage) NotDone() bool

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

func (MarketplacesListResultPage) Response 

func (page MarketplacesListResultPage) Response() MarketplacesListResult

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

func (MarketplacesListResultPage) Values 

func (page MarketplacesListResultPage) Values() []Marketplace

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

type MeterDetails 

type MeterDetails struct {
	// MeterName - The name of the meter, within the given meter category
	MeterName *string `json:"meterName,omitempty"`
	// MeterCategory - The category of the meter, for example, 'Cloud services', 'Networking', etc..
	MeterCategory *string `json:"meterCategory,omitempty"`
	// MeterSubCategory - The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..
	MeterSubCategory *string `json:"meterSubCategory,omitempty"`
	// Unit - The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.
	Unit *string `json:"unit,omitempty"`
	// MeterLocation - The location in which the Azure service is available.
	MeterLocation *string `json:"meterLocation,omitempty"`
	// TotalIncludedQuantity - The total included quantity associated with the offer.
	TotalIncludedQuantity *decimal.Decimal `json:"totalIncludedQuantity,omitempty"`
	// PretaxStandardRate - The pretax listing price.
	PretaxStandardRate *decimal.Decimal `json:"pretaxStandardRate,omitempty"`
}

MeterDetails the properties of the meter detail.

type Notification 

type Notification struct {
	// Enabled - The notification is enabled or not.
	Enabled *bool `json:"enabled,omitempty"`
	// Operator - The comparison operator. Possible values include: 'EqualTo', 'GreaterThan', 'GreaterThanOrEqualTo'
	Operator OperatorType `json:"operator,omitempty"`
	// Threshold - Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
	Threshold *decimal.Decimal `json:"threshold,omitempty"`
	// ContactEmails - Email addresses to send the budget notification to when the threshold is exceeded.
	ContactEmails *[]string `json:"contactEmails,omitempty"`
	// ContactRoles - Contact roles to send the budget notification to when the threshold is exceeded.
	ContactRoles *[]string `json:"contactRoles,omitempty"`
	// ContactGroups - Action groups to send the budget notification to when the threshold is exceeded.
	ContactGroups *[]string `json:"contactGroups,omitempty"`
}

Notification the notification associated with a budget.

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation a Consumption REST API operation.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.Consumption.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed: UsageDetail, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of consumption operations supported by the Microsoft.Consumption resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) 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 (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) 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 (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available consumption REST API operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

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.

type OperatorType 

type OperatorType string

OperatorType enumerates the values for operator type. 

const (
	// EqualTo ...
	EqualTo OperatorType = "EqualTo"
	// GreaterThan ...
	GreaterThan OperatorType = "GreaterThan"
	// GreaterThanOrEqualTo ...
	GreaterThanOrEqualTo OperatorType = "GreaterThanOrEqualTo"
)

type PriceSheetClient 

type PriceSheetClient struct {
	BaseClient
}

PriceSheetClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

func NewPriceSheetClient 

func NewPriceSheetClient(subscriptionID string) PriceSheetClient

NewPriceSheetClient creates an instance of the PriceSheetClient client.

func NewPriceSheetClientWithBaseURI 

func NewPriceSheetClientWithBaseURI(baseURI string, subscriptionID string) PriceSheetClient

NewPriceSheetClientWithBaseURI creates an instance of the PriceSheetClient client.

func (PriceSheetClient) Get 

func (client PriceSheetClient) Get(ctx context.Context, expand string, skiptoken string) (result PriceSheetResult, err error)

Get gets the price sheet for a scope by subscriptionId. Price sheet is available via this API only for May 1, 2014 or later.

expand is may be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. skiptoken is skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

func (PriceSheetClient) GetByBillingPeriod 

func (client PriceSheetClient) GetByBillingPeriod(ctx context.Context, billingPeriodName string, expand string, skiptoken string) (result PriceSheetResult, err error)

GetByBillingPeriod get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.

billingPeriodName is billing Period Name. expand is may be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. skiptoken is skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

func (PriceSheetClient) GetByBillingPeriodPreparer 

func (client PriceSheetClient) GetByBillingPeriodPreparer(ctx context.Context, billingPeriodName string, expand string, skiptoken string) (*http.Request, error)

GetByBillingPeriodPreparer prepares the GetByBillingPeriod request.

func (PriceSheetClient) GetByBillingPeriodResponder 

func (client PriceSheetClient) GetByBillingPeriodResponder(resp *http.Response) (result PriceSheetResult, err error)

GetByBillingPeriodResponder handles the response to the GetByBillingPeriod request. The method always closes the http.Response Body.

func (PriceSheetClient) GetByBillingPeriodSender 

func (client PriceSheetClient) GetByBillingPeriodSender(req *http.Request) (*http.Response, error)

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

func (PriceSheetClient) GetPreparer 

func (client PriceSheetClient) GetPreparer(ctx context.Context, expand string, skiptoken string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PriceSheetClient) GetResponder 

func (client PriceSheetClient) GetResponder(resp *http.Response) (result PriceSheetResult, err error)

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

func (PriceSheetClient) GetSender 

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

type PriceSheetModel 

type PriceSheetModel struct {
	// Pricesheets - Price sheet
	Pricesheets *[]PriceSheetProperties `json:"pricesheets,omitempty"`
	// NextLink - The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

PriceSheetModel price sheet result. It contains the pricesheet associated with billing period

type PriceSheetProperties 

type PriceSheetProperties struct {
	// BillingPeriodID - The id of the billing period resource that the usage belongs to.
	BillingPeriodID *string `json:"billingPeriodId,omitempty"`
	// MeterID - The meter id
	MeterID *string `json:"meterId,omitempty"`
	// MeterDetails - The details about the meter. By default this is not populated, unless it's specified in $expand.
	MeterDetails *MeterDetails `json:"meterDetails,omitempty"`
	// UnitOfMeasure - Unit of measure
	UnitOfMeasure *string `json:"unitOfMeasure,omitempty"`
	// IncludedQuantity - Included quality for an offer
	IncludedQuantity *decimal.Decimal `json:"includedQuantity,omitempty"`
	// PartNumber - Part Number
	PartNumber *string `json:"partNumber,omitempty"`
	// UnitPrice - Unit Price
	UnitPrice *decimal.Decimal `json:"unitPrice,omitempty"`
	// CurrencyCode - Currency Code
	CurrencyCode *string `json:"currencyCode,omitempty"`
}

PriceSheetProperties the properties of the price sheet.

type PriceSheetResult 

type PriceSheetResult struct {
	autorest.Response `json:"-"`
	*PriceSheetModel  `json:"properties,omitempty"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

PriceSheetResult an pricesheet resource.

func (PriceSheetResult) MarshalJSON 

func (psr PriceSheetResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PriceSheetResult.

func (*PriceSheetResult) UnmarshalJSON 

func (psr *PriceSheetResult) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PriceSheetResult struct.

type ProxyResource 

type ProxyResource struct {
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// ETag - eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not.
	ETag *string `json:"eTag,omitempty"`
}

ProxyResource the Resource model definition.

type ReservationDetails 

type ReservationDetails struct {
	*ReservationDetailsProperties `json:"properties,omitempty"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

ReservationDetails reservation details resource.

func (ReservationDetails) MarshalJSON 

func (rd ReservationDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationDetails.

func (*ReservationDetails) UnmarshalJSON 

func (rd *ReservationDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ReservationDetails struct.

type ReservationDetailsListResult 

type ReservationDetailsListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of reservation details.
	Value *[]ReservationDetails `json:"value,omitempty"`
	// NextLink - The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ReservationDetailsListResult result of listing reservation details.

func (ReservationDetailsListResult) IsEmpty 

func (rdlr ReservationDetailsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ReservationDetailsListResultIterator 

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

ReservationDetailsListResultIterator provides access to a complete listing of ReservationDetails values.

func (*ReservationDetailsListResultIterator) Next 

func (iter *ReservationDetailsListResultIterator) 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 (ReservationDetailsListResultIterator) NotDone 

func (iter ReservationDetailsListResultIterator) NotDone() bool

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

func (ReservationDetailsListResultIterator) Response 

func (iter ReservationDetailsListResultIterator) Response() ReservationDetailsListResult

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

func (ReservationDetailsListResultIterator) Value 

func (iter ReservationDetailsListResultIterator) Value() ReservationDetails

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

type ReservationDetailsListResultPage 

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

ReservationDetailsListResultPage contains a page of ReservationDetails values.

func (*ReservationDetailsListResultPage) Next 

func (page *ReservationDetailsListResultPage) 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 (ReservationDetailsListResultPage) NotDone 

func (page ReservationDetailsListResultPage) NotDone() bool

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

func (ReservationDetailsListResultPage) Response 

func (page ReservationDetailsListResultPage) Response() ReservationDetailsListResult

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

func (ReservationDetailsListResultPage) Values 

func (page ReservationDetailsListResultPage) Values() []ReservationDetails

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

type ReservationDetailsProperties 

type ReservationDetailsProperties struct {
	// ReservationOrderID - The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.
	ReservationOrderID *string `json:"reservationOrderId,omitempty"`
	// ReservationID - The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.
	ReservationID *string `json:"reservationId,omitempty"`
	// SkuName - This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.
	SkuName *string `json:"skuName,omitempty"`
	// ReservedHours - This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.
	ReservedHours *decimal.Decimal `json:"reservedHours,omitempty"`
	// UsageDate - The date on which consumption occurred.
	UsageDate *date.Time `json:"usageDate,omitempty"`
	// UsedHours - This is the total hours used by the instance.
	UsedHours *decimal.Decimal `json:"usedHours,omitempty"`
	// InstanceID - This identifier is the name of the resource or the fully qualified Resource ID.
	InstanceID *string `json:"instanceId,omitempty"`
	// TotalReservedQuantity - This is the total count of instances that are reserved for the reservationid.
	TotalReservedQuantity *decimal.Decimal `json:"totalReservedQuantity,omitempty"`
}

ReservationDetailsProperties the properties of the reservation details.

type ReservationSummaries 

type ReservationSummaries struct {
	*ReservationSummariesProperties `json:"properties,omitempty"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

ReservationSummaries reservation summaries resource.

func (ReservationSummaries) MarshalJSON 

func (rs ReservationSummaries) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationSummaries.

func (*ReservationSummaries) UnmarshalJSON 

func (rs *ReservationSummaries) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ReservationSummaries struct.

type ReservationSummariesListResult 

type ReservationSummariesListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of reservation summaries.
	Value *[]ReservationSummaries `json:"value,omitempty"`
	// NextLink - The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ReservationSummariesListResult result of listing reservation summaries.

func (ReservationSummariesListResult) IsEmpty 

func (rslr ReservationSummariesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ReservationSummariesListResultIterator 

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

ReservationSummariesListResultIterator provides access to a complete listing of ReservationSummaries values.

func (*ReservationSummariesListResultIterator) Next 

func (iter *ReservationSummariesListResultIterator) 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 (ReservationSummariesListResultIterator) NotDone 

func (iter ReservationSummariesListResultIterator) NotDone() bool

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

func (ReservationSummariesListResultIterator) Response 

func (iter ReservationSummariesListResultIterator) Response() ReservationSummariesListResult

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

func (ReservationSummariesListResultIterator) Value 

func (iter ReservationSummariesListResultIterator) Value() ReservationSummaries

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

type ReservationSummariesListResultPage 

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

ReservationSummariesListResultPage contains a page of ReservationSummaries values.

func (*ReservationSummariesListResultPage) Next 

func (page *ReservationSummariesListResultPage) 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 (ReservationSummariesListResultPage) NotDone 

func (page ReservationSummariesListResultPage) NotDone() bool

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

func (ReservationSummariesListResultPage) Response 

func (page ReservationSummariesListResultPage) Response() ReservationSummariesListResult

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

func (ReservationSummariesListResultPage) Values 

func (page ReservationSummariesListResultPage) Values() []ReservationSummaries

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

type ReservationSummariesProperties 

type ReservationSummariesProperties struct {
	// ReservationOrderID - The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.
	ReservationOrderID *string `json:"reservationOrderId,omitempty"`
	// ReservationID - The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.
	ReservationID *string `json:"reservationId,omitempty"`
	// SkuName - This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.
	SkuName *string `json:"skuName,omitempty"`
	// ReservedHours - This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days
	ReservedHours *decimal.Decimal `json:"reservedHours,omitempty"`
	// UsageDate - Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.
	UsageDate *date.Time `json:"usageDate,omitempty"`
	// UsedHours - Total used hours by the reservation
	UsedHours *decimal.Decimal `json:"usedHours,omitempty"`
	// MinUtilizationPercentage - This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day
	MinUtilizationPercentage *decimal.Decimal `json:"minUtilizationPercentage,omitempty"`
	// AvgUtilizationPercentage - This is average utilization for the entire time range. (day or month depending on the grain)
	AvgUtilizationPercentage *decimal.Decimal `json:"avgUtilizationPercentage,omitempty"`
	// MaxUtilizationPercentage - This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.
	MaxUtilizationPercentage *decimal.Decimal `json:"maxUtilizationPercentage,omitempty"`
}

ReservationSummariesProperties the properties of the reservation summaries.

type ReservationsDetailsClient 

type ReservationsDetailsClient struct {
	BaseClient
}

ReservationsDetailsClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

func NewReservationsDetailsClient 

func NewReservationsDetailsClient(subscriptionID string) ReservationsDetailsClient

NewReservationsDetailsClient creates an instance of the ReservationsDetailsClient client.

func NewReservationsDetailsClientWithBaseURI 

func NewReservationsDetailsClientWithBaseURI(baseURI string, subscriptionID string) ReservationsDetailsClient

NewReservationsDetailsClientWithBaseURI creates an instance of the ReservationsDetailsClient client.

func (ReservationsDetailsClient) ListByReservationOrder 

func (client ReservationsDetailsClient) ListByReservationOrder(ctx context.Context, reservationOrderID string, filter string) (result ReservationDetailsListResultPage, err error)

ListByReservationOrder lists the reservations details for provided date range.

reservationOrderID is order Id of the reservation filter is filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsDetailsClient) ListByReservationOrderAndReservation 

func (client ReservationsDetailsClient) ListByReservationOrderAndReservation(ctx context.Context, reservationOrderID string, reservationID string, filter string) (result ReservationDetailsListResultPage, err error)

ListByReservationOrderAndReservation lists the reservations details for provided date range.

reservationOrderID is order Id of the reservation reservationID is id of the reservation filter is filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsDetailsClient) ListByReservationOrderAndReservationComplete 

func (client ReservationsDetailsClient) ListByReservationOrderAndReservationComplete(ctx context.Context, reservationOrderID string, reservationID string, filter string) (result ReservationDetailsListResultIterator, err error)

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

func (ReservationsDetailsClient) ListByReservationOrderAndReservationPreparer 

func (client ReservationsDetailsClient) ListByReservationOrderAndReservationPreparer(ctx context.Context, reservationOrderID string, reservationID string, filter string) (*http.Request, error)

ListByReservationOrderAndReservationPreparer prepares the ListByReservationOrderAndReservation request.

func (ReservationsDetailsClient) ListByReservationOrderAndReservationResponder 

func (client ReservationsDetailsClient) ListByReservationOrderAndReservationResponder(resp *http.Response) (result ReservationDetailsListResult, err error)

ListByReservationOrderAndReservationResponder handles the response to the ListByReservationOrderAndReservation request. The method always closes the http.Response Body.

func (ReservationsDetailsClient) ListByReservationOrderAndReservationSender 

func (client ReservationsDetailsClient) ListByReservationOrderAndReservationSender(req *http.Request) (*http.Response, error)

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

func (ReservationsDetailsClient) ListByReservationOrderComplete 

func (client ReservationsDetailsClient) ListByReservationOrderComplete(ctx context.Context, reservationOrderID string, filter string) (result ReservationDetailsListResultIterator, err error)

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

func (ReservationsDetailsClient) ListByReservationOrderPreparer 

func (client ReservationsDetailsClient) ListByReservationOrderPreparer(ctx context.Context, reservationOrderID string, filter string) (*http.Request, error)

ListByReservationOrderPreparer prepares the ListByReservationOrder request.

func (ReservationsDetailsClient) ListByReservationOrderResponder 

func (client ReservationsDetailsClient) ListByReservationOrderResponder(resp *http.Response) (result ReservationDetailsListResult, err error)

ListByReservationOrderResponder handles the response to the ListByReservationOrder request. The method always closes the http.Response Body.

func (ReservationsDetailsClient) ListByReservationOrderSender 

func (client ReservationsDetailsClient) ListByReservationOrderSender(req *http.Request) (*http.Response, error)

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

type ReservationsSummariesClient 

type ReservationsSummariesClient struct {
	BaseClient
}

ReservationsSummariesClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

func NewReservationsSummariesClient 

func NewReservationsSummariesClient(subscriptionID string) ReservationsSummariesClient

NewReservationsSummariesClient creates an instance of the ReservationsSummariesClient client.

func NewReservationsSummariesClientWithBaseURI 

func NewReservationsSummariesClientWithBaseURI(baseURI string, subscriptionID string) ReservationsSummariesClient

NewReservationsSummariesClientWithBaseURI creates an instance of the ReservationsSummariesClient client.

func (ReservationsSummariesClient) ListByReservationOrder 

func (client ReservationsSummariesClient) ListByReservationOrder(ctx context.Context, reservationOrderID string, grain Datagrain, filter string) (result ReservationSummariesListResultPage, err error)

ListByReservationOrder lists the reservations summaries for daily or monthly grain.

reservationOrderID is order Id of the reservation grain is can be daily or monthly filter is required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsSummariesClient) ListByReservationOrderAndReservation 

func (client ReservationsSummariesClient) ListByReservationOrderAndReservation(ctx context.Context, reservationOrderID string, reservationID string, grain Datagrain, filter string) (result ReservationSummariesListResultPage, err error)

ListByReservationOrderAndReservation lists the reservations summaries for daily or monthly grain.

reservationOrderID is order Id of the reservation reservationID is id of the reservation grain is can be daily or monthly filter is required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsSummariesClient) ListByReservationOrderAndReservationComplete 

func (client ReservationsSummariesClient) ListByReservationOrderAndReservationComplete(ctx context.Context, reservationOrderID string, reservationID string, grain Datagrain, filter string) (result ReservationSummariesListResultIterator, err error)

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

func (ReservationsSummariesClient) ListByReservationOrderAndReservationPreparer 

func (client ReservationsSummariesClient) ListByReservationOrderAndReservationPreparer(ctx context.Context, reservationOrderID string, reservationID string, grain Datagrain, filter string) (*http.Request, error)

ListByReservationOrderAndReservationPreparer prepares the ListByReservationOrderAndReservation request.

func (ReservationsSummariesClient) ListByReservationOrderAndReservationResponder 

func (client ReservationsSummariesClient) ListByReservationOrderAndReservationResponder(resp *http.Response) (result ReservationSummariesListResult, err error)

ListByReservationOrderAndReservationResponder handles the response to the ListByReservationOrderAndReservation request. The method always closes the http.Response Body.

func (ReservationsSummariesClient) ListByReservationOrderAndReservationSender 

func (client ReservationsSummariesClient) ListByReservationOrderAndReservationSender(req *http.Request) (*http.Response, error)

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

func (ReservationsSummariesClient) ListByReservationOrderComplete 

func (client ReservationsSummariesClient) ListByReservationOrderComplete(ctx context.Context, reservationOrderID string, grain Datagrain, filter string) (result ReservationSummariesListResultIterator, err error)

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

func (ReservationsSummariesClient) ListByReservationOrderPreparer 

func (client ReservationsSummariesClient) ListByReservationOrderPreparer(ctx context.Context, reservationOrderID string, grain Datagrain, filter string) (*http.Request, error)

ListByReservationOrderPreparer prepares the ListByReservationOrder request.

func (ReservationsSummariesClient) ListByReservationOrderResponder 

func (client ReservationsSummariesClient) ListByReservationOrderResponder(resp *http.Response) (result ReservationSummariesListResult, err error)

ListByReservationOrderResponder handles the response to the ListByReservationOrder request. The method always closes the http.Response Body.

func (ReservationsSummariesClient) ListByReservationOrderSender 

func (client ReservationsSummariesClient) ListByReservationOrderSender(req *http.Request) (*http.Response, error)

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

type Resource 

type Resource struct {
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

Resource the Resource model definition.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type TimeGrainType 

type TimeGrainType string

TimeGrainType enumerates the values for time grain type. 

const (
	// Annually ...
	Annually TimeGrainType = "Annually"
	// Monthly ...
	Monthly TimeGrainType = "Monthly"
	// Quarterly ...
	Quarterly TimeGrainType = "Quarterly"
)

type UsageDetail 

type UsageDetail struct {
	*UsageDetailProperties `json:"properties,omitempty"`
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

UsageDetail an usage detail resource.

func (UsageDetail) MarshalJSON 

func (ud UsageDetail) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UsageDetail.

func (*UsageDetail) UnmarshalJSON 

func (ud *UsageDetail) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UsageDetail struct.

type UsageDetailProperties 

type UsageDetailProperties struct {
	// BillingPeriodID - The id of the billing period resource that the usage belongs to.
	BillingPeriodID *string `json:"billingPeriodId,omitempty"`
	// InvoiceID - The id of the invoice resource that the usage belongs to.
	InvoiceID *string `json:"invoiceId,omitempty"`
	// UsageStart - The start of the date time range covered by the usage detail.
	UsageStart *date.Time `json:"usageStart,omitempty"`
	// UsageEnd - The end of the date time range covered by the usage detail.
	UsageEnd *date.Time `json:"usageEnd,omitempty"`
	// InstanceName - The name of the resource instance that the usage is about.
	InstanceName *string `json:"instanceName,omitempty"`
	// InstanceID - The uri of the resource instance that the usage is about.
	InstanceID *string `json:"instanceId,omitempty"`
	// InstanceLocation - The location of the resource instance that the usage is about.
	InstanceLocation *string `json:"instanceLocation,omitempty"`
	// Currency - The ISO currency in which the meter is charged, for example, USD.
	Currency *string `json:"currency,omitempty"`
	// UsageQuantity - The quantity of usage.
	UsageQuantity *decimal.Decimal `json:"usageQuantity,omitempty"`
	// BillableQuantity - The billable usage quantity.
	BillableQuantity *decimal.Decimal `json:"billableQuantity,omitempty"`
	// PretaxCost - The amount of cost before tax.
	PretaxCost *decimal.Decimal `json:"pretaxCost,omitempty"`
	// IsEstimated - The estimated usage is subject to change.
	IsEstimated *bool `json:"isEstimated,omitempty"`
	// MeterID - The meter id.
	MeterID *string `json:"meterId,omitempty"`
	// MeterDetails - The details about the meter. By default this is not populated, unless it's specified in $expand.
	MeterDetails *MeterDetails `json:"meterDetails,omitempty"`
	// SubscriptionGUID - Subscription guid.
	SubscriptionGUID *string `json:"subscriptionGuid,omitempty"`
	// SubscriptionName - Subscription name.
	SubscriptionName *string `json:"subscriptionName,omitempty"`
	// AccountName - Account name.
	AccountName *string `json:"accountName,omitempty"`
	// DepartmentName - Department name.
	DepartmentName *string `json:"departmentName,omitempty"`
	// Product - Product name.
	Product *string `json:"product,omitempty"`
	// ConsumedService - Consumed service name.
	ConsumedService *string `json:"consumedService,omitempty"`
	// CostCenter - The cost center of this department if it is a department and a costcenter exists
	CostCenter *string `json:"costCenter,omitempty"`
	// AdditionalProperties - Additional details of this usage item. By default this is not populated, unless it's specified in $expand.
	AdditionalProperties *string `json:"additionalProperties,omitempty"`
}

UsageDetailProperties the properties of the usage detail.

type UsageDetailsClient 

type UsageDetailsClient struct {
	BaseClient
}

UsageDetailsClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

func NewUsageDetailsClient 

func NewUsageDetailsClient(subscriptionID string) UsageDetailsClient

NewUsageDetailsClient creates an instance of the UsageDetailsClient client.

func NewUsageDetailsClientWithBaseURI 

func NewUsageDetailsClientWithBaseURI(baseURI string, subscriptionID string) UsageDetailsClient

NewUsageDetailsClientWithBaseURI creates an instance of the UsageDetailsClient client.

func (UsageDetailsClient) List 

func (client UsageDetailsClient) List(ctx context.Context, expand string, filter string, skiptoken string, top *int32) (result UsageDetailsListResultPage, err error)

List lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.

expand is may be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. filter is may be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. skiptoken is skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. top is may be used to limit the number of results to the most recent N usageDetails.

func (UsageDetailsClient) ListByBillingPeriod 

func (client UsageDetailsClient) ListByBillingPeriod(ctx context.Context, billingPeriodName string, expand string, filter string, skiptoken string, top *int32) (result UsageDetailsListResultPage, err error)

ListByBillingPeriod lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.

billingPeriodName is billing Period Name. expand is may be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. filter is may be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. skiptoken is skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. top is may be used to limit the number of results to the most recent N usageDetails.

func (UsageDetailsClient) ListByBillingPeriodComplete 

func (client UsageDetailsClient) ListByBillingPeriodComplete(ctx context.Context, billingPeriodName string, expand string, filter string, skiptoken string, top *int32) (result UsageDetailsListResultIterator, err error)

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

func (UsageDetailsClient) ListByBillingPeriodPreparer 

func (client UsageDetailsClient) ListByBillingPeriodPreparer(ctx context.Context, billingPeriodName string, expand string, filter string, skiptoken string, top *int32) (*http.Request, error)

ListByBillingPeriodPreparer prepares the ListByBillingPeriod request.

func (UsageDetailsClient) ListByBillingPeriodResponder 

func (client UsageDetailsClient) ListByBillingPeriodResponder(resp *http.Response) (result UsageDetailsListResult, err error)

ListByBillingPeriodResponder handles the response to the ListByBillingPeriod request. The method always closes the http.Response Body.

func (UsageDetailsClient) ListByBillingPeriodSender 

func (client UsageDetailsClient) ListByBillingPeriodSender(req *http.Request) (*http.Response, error)

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

func (UsageDetailsClient) ListComplete 

func (client UsageDetailsClient) ListComplete(ctx context.Context, expand string, filter string, skiptoken string, top *int32) (result UsageDetailsListResultIterator, err error)

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

func (UsageDetailsClient) ListPreparer 

func (client UsageDetailsClient) ListPreparer(ctx context.Context, expand string, filter string, skiptoken string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (UsageDetailsClient) ListResponder 

func (client UsageDetailsClient) ListResponder(resp *http.Response) (result UsageDetailsListResult, err error)

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

func (UsageDetailsClient) ListSender 

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

type UsageDetailsListResult 

type UsageDetailsListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of usage details.
	Value *[]UsageDetail `json:"value,omitempty"`
	// NextLink - The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

UsageDetailsListResult result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.

func (UsageDetailsListResult) IsEmpty 

func (udlr UsageDetailsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UsageDetailsListResultIterator 

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

UsageDetailsListResultIterator provides access to a complete listing of UsageDetail values.

func (*UsageDetailsListResultIterator) Next 

func (iter *UsageDetailsListResultIterator) 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 (UsageDetailsListResultIterator) NotDone 

func (iter UsageDetailsListResultIterator) NotDone() bool

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

func (UsageDetailsListResultIterator) Response 

func (iter UsageDetailsListResultIterator) Response() UsageDetailsListResult

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

func (UsageDetailsListResultIterator) Value 

func (iter UsageDetailsListResultIterator) Value() UsageDetail

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

type UsageDetailsListResultPage 

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

UsageDetailsListResultPage contains a page of UsageDetail values.

func (*UsageDetailsListResultPage) Next 

func (page *UsageDetailsListResultPage) 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 (UsageDetailsListResultPage) NotDone 

func (page UsageDetailsListResultPage) NotDone() bool

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

func (UsageDetailsListResultPage) Response 

func (page UsageDetailsListResultPage) Response() UsageDetailsListResult

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

func (UsageDetailsListResultPage) Values 

func (page UsageDetailsListResultPage) Values() []UsageDetail

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

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.