consumption

package
v58.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 14, 2021 License: MIT Imports: 12 Imported by: 204

Documentation

Overview

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

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 AggregatedCostClient 

type AggregatedCostClient struct {
	BaseClient
}

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

func NewAggregatedCostClient 

func NewAggregatedCostClient(subscriptionID string) AggregatedCostClient

NewAggregatedCostClient creates an instance of the AggregatedCostClient client.

func NewAggregatedCostClientWithBaseURI 

func NewAggregatedCostClientWithBaseURI(baseURI string, subscriptionID string) AggregatedCostClient

NewAggregatedCostClientWithBaseURI creates an instance of the AggregatedCostClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AggregatedCostClient) GetByManagementGroup 

func (client AggregatedCostClient) GetByManagementGroup(ctx context.Context, managementGroupID string, filter string) (result ManagementGroupAggregatedCostResult, err error)

GetByManagementGroup provides the aggregate cost of a management group and all child management groups by current billing period. Parameters: managementGroupID - azure Management Group ID. filter - may be used to filter aggregated cost by properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

func (AggregatedCostClient) GetByManagementGroupPreparer 

func (client AggregatedCostClient) GetByManagementGroupPreparer(ctx context.Context, managementGroupID string, filter string) (*http.Request, error)

GetByManagementGroupPreparer prepares the GetByManagementGroup request.

func (AggregatedCostClient) GetByManagementGroupResponder 

func (client AggregatedCostClient) GetByManagementGroupResponder(resp *http.Response) (result ManagementGroupAggregatedCostResult, err error)

GetByManagementGroupResponder handles the response to the GetByManagementGroup request. The method always closes the http.Response Body.

func (AggregatedCostClient) GetByManagementGroupSender 

func (client AggregatedCostClient) GetByManagementGroupSender(req *http.Request) (*http.Response, error)

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

func (AggregatedCostClient) GetForBillingPeriodByManagementGroup 

func (client AggregatedCostClient) GetForBillingPeriodByManagementGroup(ctx context.Context, managementGroupID string, billingPeriodName string) (result ManagementGroupAggregatedCostResult, err error)

GetForBillingPeriodByManagementGroup provides the aggregate cost of a management group and all child management groups by specified billing period Parameters: managementGroupID - azure Management Group ID. billingPeriodName - billing Period Name.

func (AggregatedCostClient) GetForBillingPeriodByManagementGroupPreparer 

func (client AggregatedCostClient) GetForBillingPeriodByManagementGroupPreparer(ctx context.Context, managementGroupID string, billingPeriodName string) (*http.Request, error)

GetForBillingPeriodByManagementGroupPreparer prepares the GetForBillingPeriodByManagementGroup request.

func (AggregatedCostClient) GetForBillingPeriodByManagementGroupResponder 

func (client AggregatedCostClient) GetForBillingPeriodByManagementGroupResponder(resp *http.Response) (result ManagementGroupAggregatedCostResult, err error)

GetForBillingPeriodByManagementGroupResponder handles the response to the GetForBillingPeriodByManagementGroup request. The method always closes the http.Response Body.

func (AggregatedCostClient) GetForBillingPeriodByManagementGroupSender 

func (client AggregatedCostClient) GetForBillingPeriodByManagementGroupSender(req *http.Request) (*http.Response, error)

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

type Balance 

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

Balance a balance resource.

func (Balance) MarshalJSON 

func (b Balance) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Balance.

func (*Balance) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for Balance struct.

type BalanceProperties 

type BalanceProperties struct {
	// Currency - READ-ONLY; The ISO currency in which the meter is charged, for example, USD.
	Currency *string `json:"currency,omitempty"`
	// BeginningBalance - READ-ONLY; The beginning balance for the billing period.
	BeginningBalance *decimal.Decimal `json:"beginningBalance,omitempty"`
	// EndingBalance - READ-ONLY; The ending balance for the billing period (for open periods this will be updated daily).
	EndingBalance *decimal.Decimal `json:"endingBalance,omitempty"`
	// NewPurchases - READ-ONLY; Total new purchase amount.
	NewPurchases *decimal.Decimal `json:"newPurchases,omitempty"`
	// Adjustments - READ-ONLY; Total adjustment amount.
	Adjustments *decimal.Decimal `json:"adjustments,omitempty"`
	// Utilized - READ-ONLY; Total Commitment usage.
	Utilized *decimal.Decimal `json:"utilized,omitempty"`
	// ServiceOverage - READ-ONLY; Overage for Azure services.
	ServiceOverage *decimal.Decimal `json:"serviceOverage,omitempty"`
	// ChargesBilledSeparately - READ-ONLY; Charges Billed separately.
	ChargesBilledSeparately *decimal.Decimal `json:"chargesBilledSeparately,omitempty"`
	// TotalOverage - READ-ONLY; serviceOverage + chargesBilledSeparately.
	TotalOverage *decimal.Decimal `json:"totalOverage,omitempty"`
	// TotalUsage - READ-ONLY; Azure service commitment + total Overage.
	TotalUsage *decimal.Decimal `json:"totalUsage,omitempty"`
	// AzureMarketplaceServiceCharges - READ-ONLY; Total charges for Azure Marketplace.
	AzureMarketplaceServiceCharges *decimal.Decimal `json:"azureMarketplaceServiceCharges,omitempty"`
	// BillingFrequency - The billing frequency. Possible values include: 'Month', 'Quarter', 'Year'
	BillingFrequency BillingFrequency `json:"billingFrequency,omitempty"`
	// PriceHidden - READ-ONLY; Price is hidden or not.
	PriceHidden *bool `json:"priceHidden,omitempty"`
	// NewPurchasesDetails - READ-ONLY; List of new purchases.
	NewPurchasesDetails *[]BalancePropertiesNewPurchasesDetailsItem `json:"newPurchasesDetails,omitempty"`
	// AdjustmentDetails - READ-ONLY; List of Adjustments (Promo credit, SIE credit etc.).
	AdjustmentDetails *[]BalancePropertiesAdjustmentDetailsItem `json:"adjustmentDetails,omitempty"`
}

BalanceProperties the properties of the balance.

func (BalanceProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for BalanceProperties.

type BalancePropertiesAdjustmentDetailsItem 

type BalancePropertiesAdjustmentDetailsItem struct {
	// Name - READ-ONLY; the name of new adjustment.
	Name *string `json:"name,omitempty"`
	// Value - READ-ONLY; the value of new adjustment.
	Value *decimal.Decimal `json:"value,omitempty"`
}

BalancePropertiesAdjustmentDetailsItem ...

func (BalancePropertiesAdjustmentDetailsItem) MarshalJSON 

func (bpDi BalancePropertiesAdjustmentDetailsItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BalancePropertiesAdjustmentDetailsItem.

type BalancePropertiesNewPurchasesDetailsItem 

type BalancePropertiesNewPurchasesDetailsItem struct {
	// Name - READ-ONLY; the name of new purchase.
	Name *string `json:"name,omitempty"`
	// Value - READ-ONLY; the value of new purchase.
	Value *decimal.Decimal `json:"value,omitempty"`
}

BalancePropertiesNewPurchasesDetailsItem ...

func (BalancePropertiesNewPurchasesDetailsItem) MarshalJSON 

func (bpPdi BalancePropertiesNewPurchasesDetailsItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BalancePropertiesNewPurchasesDetailsItem.

type BalancesClient 

type BalancesClient struct {
	BaseClient
}

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

func NewBalancesClient 

func NewBalancesClient(subscriptionID string) BalancesClient

NewBalancesClient creates an instance of the BalancesClient client.

func NewBalancesClientWithBaseURI 

func NewBalancesClientWithBaseURI(baseURI string, subscriptionID string) BalancesClient

NewBalancesClientWithBaseURI creates an instance of the BalancesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BalancesClient) GetByBillingAccount 

func (client BalancesClient) GetByBillingAccount(ctx context.Context, billingAccountID string) (result Balance, err error)

GetByBillingAccount gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later. Parameters: billingAccountID - billingAccount ID

func (BalancesClient) GetByBillingAccountPreparer 

func (client BalancesClient) GetByBillingAccountPreparer(ctx context.Context, billingAccountID string) (*http.Request, error)

GetByBillingAccountPreparer prepares the GetByBillingAccount request.

func (BalancesClient) GetByBillingAccountResponder 

func (client BalancesClient) GetByBillingAccountResponder(resp *http.Response) (result Balance, err error)

GetByBillingAccountResponder handles the response to the GetByBillingAccount request. The method always closes the http.Response Body.

func (BalancesClient) GetByBillingAccountSender 

func (client BalancesClient) GetByBillingAccountSender(req *http.Request) (*http.Response, error)

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

func (BalancesClient) GetForBillingPeriodByBillingAccount 

func (client BalancesClient) GetForBillingPeriodByBillingAccount(ctx context.Context, billingAccountID string, billingPeriodName string) (result Balance, err error)

GetForBillingPeriodByBillingAccount gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later. Parameters: billingAccountID - billingAccount ID billingPeriodName - billing Period Name.

func (BalancesClient) GetForBillingPeriodByBillingAccountPreparer 

func (client BalancesClient) GetForBillingPeriodByBillingAccountPreparer(ctx context.Context, billingAccountID string, billingPeriodName string) (*http.Request, error)

GetForBillingPeriodByBillingAccountPreparer prepares the GetForBillingPeriodByBillingAccount request.

func (BalancesClient) GetForBillingPeriodByBillingAccountResponder 

func (client BalancesClient) GetForBillingPeriodByBillingAccountResponder(resp *http.Response) (result Balance, err error)

GetForBillingPeriodByBillingAccountResponder handles the response to the GetForBillingPeriodByBillingAccount request. The method always closes the http.Response Body.

func (BalancesClient) GetForBillingPeriodByBillingAccountSender 

func (client BalancesClient) GetForBillingPeriodByBillingAccountSender(req *http.Request) (*http.Response, error)

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

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BillingFrequency 

type BillingFrequency string

BillingFrequency enumerates the values for billing frequency. 

const (
	// Month ...
	Month BillingFrequency = "Month"
	// Quarter ...
	Quarter BillingFrequency = "Quarter"
	// Year ...
	Year BillingFrequency = "Year"
)

func PossibleBillingFrequencyValues 

func PossibleBillingFrequencyValues() []BillingFrequency

PossibleBillingFrequencyValues returns an array of possible values for the BillingFrequency const type.

type Bound 

type Bound string

Bound enumerates the values for bound. 

const (
	// Lower ...
	Lower Bound = "Lower"
	// Upper ...
	Upper Bound = "Upper"
)

func PossibleBoundValues 

func PossibleBoundValues() []Bound

PossibleBoundValues returns an array of possible values for the Bound const type.

type Budget 

type Budget struct {
	autorest.Response `json:"-"`
	*BudgetProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// ETag - eTag of the resource. To handle concurrent update scenario, 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) MarshalJSON 

func (b Budget) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Budget.

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: 'TimeGrainTypeMonthly', 'TimeGrainTypeQuarterly', 'TimeGrainTypeAnnually', 'TimeGrainTypeBillingMonth', 'TimeGrainTypeBillingQuarter', 'TimeGrainTypeBillingAnnual'
	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 period. 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 - READ-ONLY; 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BudgetsClient) CreateOrUpdate 

func (client BudgetsClient) CreateOrUpdate(ctx context.Context, scope string, 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. Parameters: scope - the scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. budgetName - budget Name. parameters - parameters supplied to the Create Budget operation.

func (BudgetsClient) CreateOrUpdatePreparer 

func (client BudgetsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, 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, scope string, budgetName string) (result autorest.Response, err error)

Delete the operation to delete a budget. Parameters: scope - the scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. budgetName - budget Name.

func (BudgetsClient) DeletePreparer 

func (client BudgetsClient) DeletePreparer(ctx context.Context, scope string, 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, scope string, budgetName string) (result Budget, err error)

Get gets the budget for the scope by budget name. Parameters: scope - the scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. budgetName - budget Name.

func (BudgetsClient) GetPreparer 

func (client BudgetsClient) GetPreparer(ctx context.Context, scope string, 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, scope string) (result BudgetsListResultPage, err error)

List lists all budgets for the defined scope. Parameters: scope - the scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

func (BudgetsClient) ListComplete 

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

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

func (BudgetsClient) ListPreparer 

func (client BudgetsClient) ListPreparer(ctx context.Context, scope string) (*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 - READ-ONLY; The list of budgets.
	Value *[]Budget `json:"value,omitempty"`
	// NextLink - READ-ONLY; 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.

func (BudgetsListResult) MarshalJSON 

func (blr BudgetsListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BudgetsListResult.

type BudgetsListResultIterator 

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

BudgetsListResultIterator provides access to a complete listing of Budget values.

func NewBudgetsListResultIterator 

func NewBudgetsListResultIterator(page BudgetsListResultPage) BudgetsListResultIterator

Creates a new instance of the BudgetsListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*BudgetsListResultIterator) NextWithContext 

func (iter *BudgetsListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (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 NewBudgetsListResultPage 

func NewBudgetsListResultPage(cur BudgetsListResult, getNextPage func(context.Context, BudgetsListResult) (BudgetsListResult, error)) BudgetsListResultPage

Creates a new instance of the BudgetsListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*BudgetsListResultPage) NextWithContext 

func (page *BudgetsListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (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"
)

func PossibleCategoryTypeValues 

func PossibleCategoryTypeValues() []CategoryType

PossibleCategoryTypeValues returns an array of possible values for the CategoryType const type.

type ChargeSummary 

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

ChargeSummary a charge summary resource.

func (ChargeSummary) MarshalJSON 

func (cs ChargeSummary) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ChargeSummary.

func (*ChargeSummary) UnmarshalJSON 

func (cs *ChargeSummary) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ChargeSummary struct.

type ChargeSummaryProperties 

type ChargeSummaryProperties struct {
	// BillingPeriodID - READ-ONLY; The id of the billing period resource that the charge belongs to.
	BillingPeriodID *string `json:"billingPeriodId,omitempty"`
	// UsageStart - READ-ONLY; Usage start date.
	UsageStart *string `json:"usageStart,omitempty"`
	// UsageEnd - READ-ONLY;  Usage end date.
	UsageEnd *string `json:"usageEnd,omitempty"`
	// AzureCharges - READ-ONLY; Azure Charges.
	AzureCharges *decimal.Decimal `json:"azureCharges,omitempty"`
	// ChargesBilledSeparately - READ-ONLY; Charges Billed separately.
	ChargesBilledSeparately *decimal.Decimal `json:"chargesBilledSeparately,omitempty"`
	// MarketplaceCharges - READ-ONLY; Marketplace Charges.
	MarketplaceCharges *decimal.Decimal `json:"marketplaceCharges,omitempty"`
	// Currency - READ-ONLY; Currency Code
	Currency *string `json:"currency,omitempty"`
}

ChargeSummaryProperties the properties of the charge summary.

func (ChargeSummaryProperties) MarshalJSON 

func (csp ChargeSummaryProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ChargeSummaryProperties.

type ChargeType 

type ChargeType string

ChargeType enumerates the values for charge type. 

const (
	// ChargeTypeActual ...
	ChargeTypeActual ChargeType = "Actual"
	// ChargeTypeForecast ...
	ChargeTypeForecast ChargeType = "Forecast"
)

func PossibleChargeTypeValues 

func PossibleChargeTypeValues() []ChargeType

PossibleChargeTypeValues returns an array of possible values for the ChargeType const type.

type ChargesClient 

type ChargesClient struct {
	BaseClient
}

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

func NewChargesClient 

func NewChargesClient(subscriptionID string) ChargesClient

NewChargesClient creates an instance of the ChargesClient client.

func NewChargesClientWithBaseURI 

func NewChargesClientWithBaseURI(baseURI string, subscriptionID string) ChargesClient

NewChargesClientWithBaseURI creates an instance of the ChargesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ChargesClient) ListByScope 

func (client ChargesClient) ListByScope(ctx context.Context, scope string, filter string) (result ChargeSummary, err error)

ListByScope lists the charges based for the defined scope. Parameters: scope - the scope associated with usage details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. For department and enrollment accounts, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' filter - may be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

func (ChargesClient) ListByScopePreparer 

func (client ChargesClient) ListByScopePreparer(ctx context.Context, scope string, filter string) (*http.Request, error)

ListByScopePreparer prepares the ListByScope request.

func (ChargesClient) ListByScopeResponder 

func (client ChargesClient) ListByScopeResponder(resp *http.Response) (result ChargeSummary, err error)

ListByScopeResponder handles the response to the ListByScope request. The method always closes the http.Response Body.

func (ChargesClient) ListByScopeSender 

func (client ChargesClient) ListByScopeSender(req *http.Request) (*http.Response, error)

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

type ChargesListResult 

type ChargesListResult struct {
	// Value - READ-ONLY; The list of charge summary
	Value *[]ChargeSummary `json:"value,omitempty"`
}

ChargesListResult result of listing charge summary.

func (ChargesListResult) MarshalJSON 

func (clr ChargesListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ChargesListResult.

type CurrentSpend 

type CurrentSpend struct {
	// Amount - READ-ONLY; The total amount of cost which is being tracked by the budget.
	Amount *decimal.Decimal `json:"amount,omitempty"`
	// Unit - READ-ONLY; 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.

func (CurrentSpend) MarshalJSON 

func (cs CurrentSpend) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CurrentSpend.

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"
)

func PossibleDatagrainValues 

func PossibleDatagrainValues() []Datagrain

PossibleDatagrainValues returns an array of possible values for the Datagrain const type.

type ErrorDetails 

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

ErrorDetails the details of the error.

func (ErrorDetails) MarshalJSON 

func (ed ErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDetails.

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 (GUID), mandatory for budgets of usage category.
	Meters *[]uuid.UUID `json:"meters,omitempty"`
	// Tags - The dictionary of filters on tags.
	Tags map[string][]string `json:"tags"`
}

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

func (Filters) MarshalJSON 

func (f Filters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Filters.

type Forecast 

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

Forecast a forecast resource.

func (Forecast) MarshalJSON 

func (f Forecast) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Forecast.

func (*Forecast) UnmarshalJSON 

func (f *Forecast) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Forecast struct.

type ForecastProperties 

type ForecastProperties struct {
	// UsageDate - READ-ONLY; The usage date of the forecast.
	UsageDate *string `json:"usageDate,omitempty"`
	// Grain - The granularity of forecast. Possible values include: 'Daily', 'Monthly', 'Yearly'
	Grain Grain `json:"grain,omitempty"`
	// Charge - READ-ONLY; The amount of charge
	Charge *decimal.Decimal `json:"charge,omitempty"`
	// Currency - READ-ONLY; The ISO currency in which the meter is charged, for example, USD.
	Currency *string `json:"currency,omitempty"`
	// ChargeType - The type of the charge. Could be actual or forecast. Possible values include: 'ChargeTypeActual', 'ChargeTypeForecast'
	ChargeType ChargeType `json:"chargeType,omitempty"`
	// ConfidenceLevels - READ-ONLY; The details about the forecast confidence levels. This is populated only when chargeType is Forecast.
	ConfidenceLevels *[]ForecastPropertiesConfidenceLevelsItem `json:"confidenceLevels,omitempty"`
}

ForecastProperties the properties of the forecast charge.

func (ForecastProperties) MarshalJSON 

func (fp ForecastProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ForecastProperties.

type ForecastPropertiesConfidenceLevelsItem 

type ForecastPropertiesConfidenceLevelsItem struct {
	// Percentage - READ-ONLY; The percentage level of the confidence
	Percentage *decimal.Decimal `json:"percentage,omitempty"`
	// Bound - The boundary of the percentage, values could be 'Upper' or 'Lower'. Possible values include: 'Upper', 'Lower'
	Bound Bound `json:"bound,omitempty"`
	// Value - READ-ONLY; The amount of forecast within the percentage level
	Value *decimal.Decimal `json:"value,omitempty"`
}

ForecastPropertiesConfidenceLevelsItem ...

func (ForecastPropertiesConfidenceLevelsItem) MarshalJSON 

func (fpLi ForecastPropertiesConfidenceLevelsItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ForecastPropertiesConfidenceLevelsItem.

type ForecastsClient 

type ForecastsClient struct {
	BaseClient
}

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

func NewForecastsClient 

func NewForecastsClient(subscriptionID string) ForecastsClient

NewForecastsClient creates an instance of the ForecastsClient client.

func NewForecastsClientWithBaseURI 

func NewForecastsClientWithBaseURI(baseURI string, subscriptionID string) ForecastsClient

NewForecastsClientWithBaseURI creates an instance of the ForecastsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ForecastsClient) List 

func (client ForecastsClient) List(ctx context.Context, filter string) (result ForecastsListResult, err error)

List lists the forecast charges by subscriptionId. Parameters: filter - may be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.

func (ForecastsClient) ListPreparer 

func (client ForecastsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (ForecastsClient) ListResponder 

func (client ForecastsClient) ListResponder(resp *http.Response) (result ForecastsListResult, err error)

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

func (ForecastsClient) ListSender 

func (client ForecastsClient) 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 ForecastsListResult 

type ForecastsListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of forecasts.
	Value *[]Forecast `json:"value,omitempty"`
}

ForecastsListResult result of listing forecasts. It contains a list of available forecasts.

func (ForecastsListResult) MarshalJSON 

func (flr ForecastsListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ForecastsListResult.

type Grain 

type Grain string

Grain enumerates the values for grain. 

const (
	// Daily ...
	Daily Grain = "Daily"
	// Monthly ...
	Monthly Grain = "Monthly"
	// Yearly ...
	Yearly Grain = "Yearly"
)

func PossibleGrainValues 

func PossibleGrainValues() []Grain

PossibleGrainValues returns an array of possible values for the Grain const type.

type ManagementGroupAggregatedCostProperties 

type ManagementGroupAggregatedCostProperties struct {
	// BillingPeriodID - READ-ONLY; The id of the billing period resource that the aggregated cost belongs to.
	BillingPeriodID *string `json:"billingPeriodId,omitempty"`
	// UsageStart - READ-ONLY; The start of the date time range covered by aggregated cost.
	UsageStart *date.Time `json:"usageStart,omitempty"`
	// UsageEnd - READ-ONLY; The end of the date time range covered by the aggregated cost.
	UsageEnd *date.Time `json:"usageEnd,omitempty"`
	// AzureCharges - READ-ONLY; Azure Charges.
	AzureCharges *decimal.Decimal `json:"azureCharges,omitempty"`
	// MarketplaceCharges - READ-ONLY; Marketplace Charges.
	MarketplaceCharges *decimal.Decimal `json:"marketplaceCharges,omitempty"`
	// ChargesBilledSeparately - READ-ONLY; Charges Billed Separately.
	ChargesBilledSeparately *decimal.Decimal `json:"chargesBilledSeparately,omitempty"`
	// Currency - READ-ONLY; The ISO currency in which the meter is charged, for example, USD.
	Currency *string `json:"currency,omitempty"`
	// Children - Children of a management group
	Children *[]ManagementGroupAggregatedCostResult `json:"children,omitempty"`
	// IncludedSubscriptions - List of subscription Guids included in the calculation of aggregated cost
	IncludedSubscriptions *[]string `json:"includedSubscriptions,omitempty"`
	// ExcludedSubscriptions - List of subscription Guids excluded from the calculation of aggregated cost
	ExcludedSubscriptions *[]string `json:"excludedSubscriptions,omitempty"`
}

ManagementGroupAggregatedCostProperties the properties of the Management Group Aggregated Cost.

func (ManagementGroupAggregatedCostProperties) MarshalJSON 

func (mgacp ManagementGroupAggregatedCostProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagementGroupAggregatedCostProperties.

type ManagementGroupAggregatedCostResult 

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

ManagementGroupAggregatedCostResult a management group aggregated cost resource.

func (ManagementGroupAggregatedCostResult) MarshalJSON 

func (mgacr ManagementGroupAggregatedCostResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagementGroupAggregatedCostResult.

func (*ManagementGroupAggregatedCostResult) UnmarshalJSON 

func (mgacr *ManagementGroupAggregatedCostResult) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ManagementGroupAggregatedCostResult struct.

type Marketplace 

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

MarketplaceProperties the properties of the marketplace usage detail.

func (MarketplaceProperties) MarshalJSON 

func (mp MarketplaceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MarketplaceProperties.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (MarketplacesClient) List 

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

List lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later. Parameters: scope - the scope associated with marketplace operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' filter - 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 - may be used to limit the number of results to the most recent N marketplaces. skiptoken - 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) ListComplete 

func (client MarketplacesClient) ListComplete(ctx context.Context, scope string, 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, scope string, 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 - READ-ONLY; The list of marketplaces.
	Value *[]Marketplace `json:"value,omitempty"`
	// NextLink - READ-ONLY; 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.

func (MarketplacesListResult) MarshalJSON 

func (mlr MarketplacesListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MarketplacesListResult.

type MarketplacesListResultIterator 

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

MarketplacesListResultIterator provides access to a complete listing of Marketplace values.

func NewMarketplacesListResultIterator 

func NewMarketplacesListResultIterator(page MarketplacesListResultPage) MarketplacesListResultIterator

Creates a new instance of the MarketplacesListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*MarketplacesListResultIterator) NextWithContext 

func (iter *MarketplacesListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (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 NewMarketplacesListResultPage 

func NewMarketplacesListResultPage(cur MarketplacesListResult, getNextPage func(context.Context, MarketplacesListResult) (MarketplacesListResult, error)) MarketplacesListResultPage

Creates a new instance of the MarketplacesListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*MarketplacesListResultPage) NextWithContext 

func (page *MarketplacesListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (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 - READ-ONLY; The name of the meter, within the given meter category
	MeterName *string `json:"meterName,omitempty"`
	// MeterCategory - READ-ONLY; The category of the meter, for example, 'Cloud services', 'Networking', etc..
	MeterCategory *string `json:"meterCategory,omitempty"`
	// MeterSubCategory - READ-ONLY; The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..
	MeterSubCategory *string `json:"meterSubCategory,omitempty"`
	// Unit - READ-ONLY; The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.
	Unit *string `json:"unit,omitempty"`
	// MeterLocation - READ-ONLY; The location in which the Azure service is available.
	MeterLocation *string `json:"meterLocation,omitempty"`
	// TotalIncludedQuantity - READ-ONLY; The total included quantity associated with the offer.
	TotalIncludedQuantity *decimal.Decimal `json:"totalIncludedQuantity,omitempty"`
	// PretaxStandardRate - READ-ONLY; The pretax listing price.
	PretaxStandardRate *decimal.Decimal `json:"pretaxStandardRate,omitempty"`
	// ServiceName - READ-ONLY; The name of the service.
	ServiceName *string `json:"serviceName,omitempty"`
	// ServiceTier - READ-ONLY; The service tier.
	ServiceTier *string `json:"serviceTier,omitempty"`
}

MeterDetails the properties of the meter detail.

func (MeterDetails) MarshalJSON 

func (md MeterDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MeterDetails.

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 - READ-ONLY; 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.

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay 

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

OperationDisplay the object that represents the operation.

func (OperationDisplay) MarshalJSON 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of consumption operations supported by the Microsoft.Consumption resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; 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.

func (OperationListResult) MarshalJSON 

func (olr OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (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 NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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"
)

func PossibleOperatorTypeValues 

func PossibleOperatorTypeValues() []OperatorType

PossibleOperatorTypeValues returns an array of possible values for the OperatorType const type.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PriceSheetClient) Get 

func (client PriceSheetClient) Get(ctx context.Context, expand string, skiptoken string, top *int32) (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. Parameters: expand - may be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. skiptoken - 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 - may be used to limit the number of results to the top N results.

func (PriceSheetClient) GetByBillingPeriod 

func (client PriceSheetClient) GetByBillingPeriod(ctx context.Context, billingPeriodName string, expand string, skiptoken string, top *int32) (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. Parameters: billingPeriodName - billing Period Name. expand - may be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. skiptoken - 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 - may be used to limit the number of results to the top N results.

func (PriceSheetClient) GetByBillingPeriodPreparer 

func (client PriceSheetClient) GetByBillingPeriodPreparer(ctx context.Context, billingPeriodName string, expand string, skiptoken string, top *int32) (*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, top *int32) (*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 - READ-ONLY; Price sheet
	Pricesheets *[]PriceSheetProperties `json:"pricesheets,omitempty"`
	// NextLink - READ-ONLY; 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

func (PriceSheetModel) MarshalJSON 

func (psm PriceSheetModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PriceSheetModel.

type PriceSheetProperties 

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

PriceSheetProperties the properties of the price sheet.

func (PriceSheetProperties) MarshalJSON 

func (psp PriceSheetProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PriceSheetProperties.

type PriceSheetResult 

type PriceSheetResult struct {
	autorest.Response `json:"-"`
	*PriceSheetModel  `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - READ-ONLY; 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 - READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// ETag - eTag of the resource. To handle concurrent update scenario, 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.

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type ReservationDetail 

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

ReservationDetail reservation detail resource.

func (ReservationDetail) MarshalJSON 

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

MarshalJSON is the custom marshaler for ReservationDetail.

func (*ReservationDetail) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ReservationDetail struct.

type ReservationDetailProperties 

type ReservationDetailProperties struct {
	// ReservationOrderID - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.
	SkuName *string `json:"skuName,omitempty"`
	// ReservedHours - READ-ONLY; 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 - READ-ONLY; The date on which consumption occurred.
	UsageDate *date.Time `json:"usageDate,omitempty"`
	// UsedHours - READ-ONLY; This is the total hours used by the instance.
	UsedHours *decimal.Decimal `json:"usedHours,omitempty"`
	// InstanceID - READ-ONLY; This identifier is the name of the resource or the fully qualified Resource ID.
	InstanceID *string `json:"instanceId,omitempty"`
	// TotalReservedQuantity - READ-ONLY; This is the total count of instances that are reserved for the reservationId.
	TotalReservedQuantity *decimal.Decimal `json:"totalReservedQuantity,omitempty"`
}

ReservationDetailProperties the properties of the reservation detail.

func (ReservationDetailProperties) MarshalJSON 

func (rdp ReservationDetailProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationDetailProperties.

type ReservationDetailsListResult 

type ReservationDetailsListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of reservation details.
	Value *[]ReservationDetail `json:"value,omitempty"`
	// NextLink - READ-ONLY; 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.

func (ReservationDetailsListResult) MarshalJSON 

func (rdlr ReservationDetailsListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationDetailsListResult.

type ReservationDetailsListResultIterator 

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

ReservationDetailsListResultIterator provides access to a complete listing of ReservationDetail values.

func NewReservationDetailsListResultIterator 

func NewReservationDetailsListResultIterator(page ReservationDetailsListResultPage) ReservationDetailsListResultIterator

Creates a new instance of the ReservationDetailsListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*ReservationDetailsListResultIterator) NextWithContext 

func (iter *ReservationDetailsListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (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() ReservationDetail

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 ReservationDetail values.

func NewReservationDetailsListResultPage 

func NewReservationDetailsListResultPage(cur ReservationDetailsListResult, getNextPage func(context.Context, ReservationDetailsListResult) (ReservationDetailsListResult, error)) ReservationDetailsListResultPage

Creates a new instance of the ReservationDetailsListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*ReservationDetailsListResultPage) NextWithContext 

func (page *ReservationDetailsListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (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() []ReservationDetail

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

type ReservationRecommendation 

type ReservationRecommendation struct {
	// ID - READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - READ-ONLY; Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - READ-ONLY; Resource location
	Location *string `json:"location,omitempty"`
	// Sku - READ-ONLY; Resource sku
	Sku                                  *string `json:"sku,omitempty"`
	*ReservationRecommendationProperties `json:"properties,omitempty"`
}

ReservationRecommendation reservation recommendation resource.

func (ReservationRecommendation) MarshalJSON 

func (rr ReservationRecommendation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationRecommendation.

func (*ReservationRecommendation) UnmarshalJSON 

func (rr *ReservationRecommendation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ReservationRecommendation struct.

type ReservationRecommendationProperties 

type ReservationRecommendationProperties struct {
	// LookBackPeriod - READ-ONLY; The number of days of usage to look back for recommendation.
	LookBackPeriod *string `json:"lookBackPeriod,omitempty"`
	// MeterID - READ-ONLY; The meter id (GUID)
	MeterID *uuid.UUID `json:"meterId,omitempty"`
	// Term - READ-ONLY; RI recommendations in one or three year terms.
	Term *string `json:"term,omitempty"`
	// CostWithNoReservedInstances - READ-ONLY; The total amount of cost without reserved instances.
	CostWithNoReservedInstances *decimal.Decimal `json:"costWithNoReservedInstances,omitempty"`
	// RecommendedQuantity - READ-ONLY; Recommended quality for reserved instances.
	RecommendedQuantity *decimal.Decimal `json:"recommendedQuantity,omitempty"`
	// TotalCostWithReservedInstances - READ-ONLY; The total amount of cost with reserved instances.
	TotalCostWithReservedInstances *decimal.Decimal `json:"totalCostWithReservedInstances,omitempty"`
	// NetSavings - READ-ONLY; Total estimated savings with reserved instances.
	NetSavings *decimal.Decimal `json:"netSavings,omitempty"`
	// FirstUsageDate - READ-ONLY; The usage date for looking back.
	FirstUsageDate *date.Time `json:"firstUsageDate,omitempty"`
	// Scope - READ-ONLY; Shared or single recommendation.
	Scope *string `json:"scope,omitempty"`
}

ReservationRecommendationProperties the properties of the reservation recommendation.

func (ReservationRecommendationProperties) MarshalJSON 

func (rrp ReservationRecommendationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationRecommendationProperties.

type ReservationRecommendationsClient 

type ReservationRecommendationsClient struct {
	BaseClient
}

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

func NewReservationRecommendationsClient 

func NewReservationRecommendationsClient(subscriptionID string) ReservationRecommendationsClient

NewReservationRecommendationsClient creates an instance of the ReservationRecommendationsClient client.

func NewReservationRecommendationsClientWithBaseURI 

func NewReservationRecommendationsClientWithBaseURI(baseURI string, subscriptionID string) ReservationRecommendationsClient

NewReservationRecommendationsClientWithBaseURI creates an instance of the ReservationRecommendationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ReservationRecommendationsClient) List 

func (client ReservationRecommendationsClient) List(ctx context.Context, filter string) (result ReservationRecommendationsListResultPage, err error)

List list of recommendations for purchasing reserved instances. Parameters: filter - may be used to filter reservationRecommendations by properties/scope and properties/lookBackPeriod.

func (ReservationRecommendationsClient) ListComplete 

func (client ReservationRecommendationsClient) ListComplete(ctx context.Context, filter string) (result ReservationRecommendationsListResultIterator, err error)

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

func (ReservationRecommendationsClient) ListPreparer 

func (client ReservationRecommendationsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (ReservationRecommendationsClient) ListResponder 

func (client ReservationRecommendationsClient) ListResponder(resp *http.Response) (result ReservationRecommendationsListResult, err error)

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

func (ReservationRecommendationsClient) ListSender 

func (client ReservationRecommendationsClient) 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 ReservationRecommendationsListResult 

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

ReservationRecommendationsListResult result of listing reservation recommendations.

func (ReservationRecommendationsListResult) IsEmpty 

func (rrlr ReservationRecommendationsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ReservationRecommendationsListResult) MarshalJSON 

func (rrlr ReservationRecommendationsListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationRecommendationsListResult.

type ReservationRecommendationsListResultIterator 

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

ReservationRecommendationsListResultIterator provides access to a complete listing of ReservationRecommendation values.

func NewReservationRecommendationsListResultIterator 

func NewReservationRecommendationsListResultIterator(page ReservationRecommendationsListResultPage) ReservationRecommendationsListResultIterator

Creates a new instance of the ReservationRecommendationsListResultIterator type.

func (*ReservationRecommendationsListResultIterator) Next 

func (iter *ReservationRecommendationsListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ReservationRecommendationsListResultIterator) NextWithContext 

func (iter *ReservationRecommendationsListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (ReservationRecommendationsListResultIterator) NotDone 

func (iter ReservationRecommendationsListResultIterator) NotDone() bool

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

func (ReservationRecommendationsListResultIterator) Response 

func (iter ReservationRecommendationsListResultIterator) Response() ReservationRecommendationsListResult

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

func (ReservationRecommendationsListResultIterator) Value 

func (iter ReservationRecommendationsListResultIterator) Value() ReservationRecommendation

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

type ReservationRecommendationsListResultPage 

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

ReservationRecommendationsListResultPage contains a page of ReservationRecommendation values.

func NewReservationRecommendationsListResultPage 

func NewReservationRecommendationsListResultPage(cur ReservationRecommendationsListResult, getNextPage func(context.Context, ReservationRecommendationsListResult) (ReservationRecommendationsListResult, error)) ReservationRecommendationsListResultPage

Creates a new instance of the ReservationRecommendationsListResultPage type.

func (*ReservationRecommendationsListResultPage) Next 

func (page *ReservationRecommendationsListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ReservationRecommendationsListResultPage) NextWithContext 

func (page *ReservationRecommendationsListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (ReservationRecommendationsListResultPage) NotDone 

func (page ReservationRecommendationsListResultPage) NotDone() bool

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

func (ReservationRecommendationsListResultPage) Response 

func (page ReservationRecommendationsListResultPage) Response() ReservationRecommendationsListResult

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

func (ReservationRecommendationsListResultPage) Values 

func (page ReservationRecommendationsListResultPage) Values() []ReservationRecommendation

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

type ReservationSummariesListResult 

type ReservationSummariesListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of reservation summaries.
	Value *[]ReservationSummary `json:"value,omitempty"`
	// NextLink - READ-ONLY; 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.

func (ReservationSummariesListResult) MarshalJSON 

func (rslr ReservationSummariesListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationSummariesListResult.

type ReservationSummariesListResultIterator 

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

ReservationSummariesListResultIterator provides access to a complete listing of ReservationSummary values.

func NewReservationSummariesListResultIterator 

func NewReservationSummariesListResultIterator(page ReservationSummariesListResultPage) ReservationSummariesListResultIterator

Creates a new instance of the ReservationSummariesListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*ReservationSummariesListResultIterator) NextWithContext 

func (iter *ReservationSummariesListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (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() ReservationSummary

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 ReservationSummary values.

func NewReservationSummariesListResultPage 

func NewReservationSummariesListResultPage(cur ReservationSummariesListResult, getNextPage func(context.Context, ReservationSummariesListResult) (ReservationSummariesListResult, error)) ReservationSummariesListResultPage

Creates a new instance of the ReservationSummariesListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*ReservationSummariesListResultPage) NextWithContext 

func (page *ReservationSummariesListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (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() []ReservationSummary

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

type ReservationSummary 

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

ReservationSummary reservation summary resource.

func (ReservationSummary) MarshalJSON 

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

MarshalJSON is the custom marshaler for ReservationSummary.

func (*ReservationSummary) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ReservationSummary struct.

type ReservationSummaryProperties 

type ReservationSummaryProperties struct {
	// ReservationOrderID - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.
	SkuName *string `json:"skuName,omitempty"`
	// ReservedHours - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; Total used hours by the reservation
	UsedHours *decimal.Decimal `json:"usedHours,omitempty"`
	// MinUtilizationPercentage - READ-ONLY; 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 - READ-ONLY; This is average utilization for the entire time range. (day or month depending on the grain)
	AvgUtilizationPercentage *decimal.Decimal `json:"avgUtilizationPercentage,omitempty"`
	// MaxUtilizationPercentage - READ-ONLY; 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"`
}

ReservationSummaryProperties the properties of the reservation summary.

func (ReservationSummaryProperties) MarshalJSON 

func (rsp ReservationSummaryProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReservationSummaryProperties.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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. Parameters: reservationOrderID - order Id of the reservation filter - 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. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the reservation filter - 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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. Parameters: reservationOrderID - order Id of the reservation grain - can be daily or monthly filter - 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. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the reservation grain - can be daily or monthly filter - 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 - READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - READ-ONLY; 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 ResourceAttributes 

type ResourceAttributes struct {
	// Location - READ-ONLY; Resource location
	Location *string `json:"location,omitempty"`
	// Sku - READ-ONLY; Resource sku
	Sku *string `json:"sku,omitempty"`
}

ResourceAttributes the Resource model definition.

func (ResourceAttributes) MarshalJSON 

func (ra ResourceAttributes) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceAttributes.

type Tag 

type Tag struct {
	// Key - Tag key.
	Key *string `json:"key,omitempty"`
}

Tag the tag resource.

type TagProperties 

type TagProperties struct {
	// Tags - A list of Tag.
	Tags *[]Tag `json:"tags,omitempty"`
}

TagProperties the properties of the tag.

type TagsClient 

type TagsClient struct {
	BaseClient
}

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

func NewTagsClient 

func NewTagsClient(subscriptionID string) TagsClient

NewTagsClient creates an instance of the TagsClient client.

func NewTagsClientWithBaseURI 

func NewTagsClientWithBaseURI(baseURI string, subscriptionID string) TagsClient

NewTagsClientWithBaseURI creates an instance of the TagsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (TagsClient) Get 

func (client TagsClient) Get(ctx context.Context, scope string) (result TagsResult, err error)

Get get all available tag keys for the defined scope Parameters: scope - the scope associated with tags operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope..

func (TagsClient) GetPreparer 

func (client TagsClient) GetPreparer(ctx context.Context, scope string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TagsClient) GetResponder 

func (client TagsClient) GetResponder(resp *http.Response) (result TagsResult, err error)

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

func (TagsClient) GetSender 

func (client TagsClient) 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 TagsResult 

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

TagsResult a resource listing all tags.

func (TagsResult) MarshalJSON 

func (tr TagsResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagsResult.

func (*TagsResult) UnmarshalJSON 

func (tr *TagsResult) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TagsResult struct.

type TimeGrainType 

type TimeGrainType string

TimeGrainType enumerates the values for time grain type. 

const (
	// TimeGrainTypeAnnually ...
	TimeGrainTypeAnnually TimeGrainType = "Annually"
	// TimeGrainTypeBillingAnnual ...
	TimeGrainTypeBillingAnnual TimeGrainType = "BillingAnnual"
	// TimeGrainTypeBillingMonth ...
	TimeGrainTypeBillingMonth TimeGrainType = "BillingMonth"
	// TimeGrainTypeBillingQuarter ...
	TimeGrainTypeBillingQuarter TimeGrainType = "BillingQuarter"
	// TimeGrainTypeMonthly ...
	TimeGrainTypeMonthly TimeGrainType = "Monthly"
	// TimeGrainTypeQuarterly ...
	TimeGrainTypeQuarterly TimeGrainType = "Quarterly"
)

func PossibleTimeGrainTypeValues 

func PossibleTimeGrainTypeValues() []TimeGrainType

PossibleTimeGrainTypeValues returns an array of possible values for the TimeGrainType const type.

type UsageDetail 

type UsageDetail struct {
	*UsageDetailProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - READ-ONLY; 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 - READ-ONLY; The id of the billing period resource that the usage belongs to.
	BillingPeriodID *string `json:"billingPeriodId,omitempty"`
	// InvoiceID - READ-ONLY; The id of the invoice resource that the usage belongs to.
	InvoiceID *string `json:"invoiceId,omitempty"`
	// UsageStart - READ-ONLY; The start of the date time range covered by the usage detail.
	UsageStart *date.Time `json:"usageStart,omitempty"`
	// UsageEnd - READ-ONLY; The end of the date time range covered by the usage detail.
	UsageEnd *date.Time `json:"usageEnd,omitempty"`
	// InstanceName - READ-ONLY; The name of the resource instance that the usage is about.
	InstanceName *string `json:"instanceName,omitempty"`
	// InstanceID - READ-ONLY; The uri of the resource instance that the usage is about.
	InstanceID *string `json:"instanceId,omitempty"`
	// InstanceLocation - READ-ONLY; The location of the resource instance that the usage is about.
	InstanceLocation *string `json:"instanceLocation,omitempty"`
	// Currency - READ-ONLY; The ISO currency in which the meter is charged, for example, USD.
	Currency *string `json:"currency,omitempty"`
	// UsageQuantity - READ-ONLY; The quantity of usage.
	UsageQuantity *decimal.Decimal `json:"usageQuantity,omitempty"`
	// BillableQuantity - READ-ONLY; The billable usage quantity.
	BillableQuantity *decimal.Decimal `json:"billableQuantity,omitempty"`
	// PretaxCost - READ-ONLY; The amount of cost before tax.
	PretaxCost *decimal.Decimal `json:"pretaxCost,omitempty"`
	// IsEstimated - READ-ONLY; The estimated usage is subject to change.
	IsEstimated *bool `json:"isEstimated,omitempty"`
	// MeterID - READ-ONLY; The meter id (GUID).
	MeterID *uuid.UUID `json:"meterId,omitempty"`
	// MeterDetails - READ-ONLY; The details about the meter. By default this is not populated, unless it's specified in $expand.
	MeterDetails *MeterDetails `json:"meterDetails,omitempty"`
	// SubscriptionGUID - READ-ONLY; Subscription guid.
	SubscriptionGUID *uuid.UUID `json:"subscriptionGuid,omitempty"`
	// SubscriptionName - READ-ONLY; Subscription name.
	SubscriptionName *string `json:"subscriptionName,omitempty"`
	// AccountName - READ-ONLY; Account name.
	AccountName *string `json:"accountName,omitempty"`
	// DepartmentName - READ-ONLY; Department name.
	DepartmentName *string `json:"departmentName,omitempty"`
	// Product - READ-ONLY; Product name.
	Product *string `json:"product,omitempty"`
	// ConsumedService - READ-ONLY; Consumed service name.
	ConsumedService *string `json:"consumedService,omitempty"`
	// CostCenter - READ-ONLY; The cost center of this department if it is a department and a costcenter exists
	CostCenter *string `json:"costCenter,omitempty"`
	// PartNumber - READ-ONLY; Part Number
	PartNumber *string `json:"partNumber,omitempty"`
	// ResourceGUID - READ-ONLY; Resource Guid
	ResourceGUID *string `json:"resourceGuid,omitempty"`
	// OfferID - READ-ONLY; Offer Id
	OfferID *string `json:"offerId,omitempty"`
	// ChargesBilledSeparately - READ-ONLY; Charges billed separately
	ChargesBilledSeparately *bool `json:"chargesBilledSeparately,omitempty"`
	// Location - READ-ONLY; Resource Location
	Location *string `json:"location,omitempty"`
	// AdditionalProperties - READ-ONLY; 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.

func (UsageDetailProperties) MarshalJSON 

func (UDP UsageDetailProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UsageDetailProperties.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (UsageDetailsClient) List 

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

List lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later. Parameters: scope - the scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' expand - 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 - may be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). skiptoken - 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 - may be used to limit the number of results to the most recent N usageDetails. apply - oData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)

func (UsageDetailsClient) ListComplete 

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

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

func (UsageDetailsClient) ListPreparer 

func (client UsageDetailsClient) ListPreparer(ctx context.Context, scope string, expand string, filter string, skiptoken string, top *int32, apply string) (*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 - READ-ONLY; The list of usage details.
	Value *[]UsageDetail `json:"value,omitempty"`
	// NextLink - READ-ONLY; 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.

func (UsageDetailsListResult) MarshalJSON 

func (udlr UsageDetailsListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UsageDetailsListResult.

type UsageDetailsListResultIterator 

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

UsageDetailsListResultIterator provides access to a complete listing of UsageDetail values.

func NewUsageDetailsListResultIterator 

func NewUsageDetailsListResultIterator(page UsageDetailsListResultPage) UsageDetailsListResultIterator

Creates a new instance of the UsageDetailsListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*UsageDetailsListResultIterator) NextWithContext 

func (iter *UsageDetailsListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (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 NewUsageDetailsListResultPage 

func NewUsageDetailsListResultPage(cur UsageDetailsListResult, getNextPage func(context.Context, UsageDetailsListResult) (UsageDetailsListResult, error)) UsageDetailsListResultPage

Creates a new instance of the UsageDetailsListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*UsageDetailsListResultPage) NextWithContext 

func (page *UsageDetailsListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (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

Directories

Path Synopsis

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.