Documentation ¶
Overview ¶
Package consumption implements the Azure ARM Consumption service API version 2018-05-31.
Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type Bound
- type ChargeType
- type ErrorDetails
- type ErrorResponse
- type Forecast
- type ForecastProperties
- type ForecastPropertiesConfidenceLevelsItem
- type ForecastsClient
- func (client ForecastsClient) List(ctx context.Context, filter string) (result ForecastsListResult, err error)
- func (client ForecastsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)
- func (client ForecastsClient) ListResponder(resp *http.Response) (result ForecastsListResult, err error)
- func (client ForecastsClient) ListSender(req *http.Request) (*http.Response, error)
- type ForecastsListResult
- type Grain
- type MeterDetails
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() Operation
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []Operation
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type PriceSheetClient
- func (client PriceSheetClient) Get(ctx context.Context, expand string, skiptoken string, top *int32) (result PriceSheetResult, err error)
- func (client PriceSheetClient) GetByBillingPeriod(ctx context.Context, billingPeriodName string, expand string, skiptoken string, ...) (result PriceSheetResult, err error)
- func (client PriceSheetClient) GetByBillingPeriodPreparer(ctx context.Context, billingPeriodName string, expand string, skiptoken string, ...) (*http.Request, error)
- func (client PriceSheetClient) GetByBillingPeriodResponder(resp *http.Response) (result PriceSheetResult, err error)
- func (client PriceSheetClient) GetByBillingPeriodSender(req *http.Request) (*http.Response, error)
- func (client PriceSheetClient) GetPreparer(ctx context.Context, expand string, skiptoken string, top *int32) (*http.Request, error)
- func (client PriceSheetClient) GetResponder(resp *http.Response) (result PriceSheetResult, err error)
- func (client PriceSheetClient) GetSender(req *http.Request) (*http.Response, error)
- type PriceSheetModel
- type PriceSheetProperties
- type PriceSheetResult
- type Resource
- type UsageDetail
- type UsageDetailProperties
- type UsageDetailsClient
- func (client UsageDetailsClient) List(ctx context.Context, expand string, filter string, skiptoken string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListByBillingAccount(ctx context.Context, billingAccountID string, expand string, filter string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListByBillingAccountComplete(ctx context.Context, billingAccountID string, expand string, filter string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListByBillingAccountPreparer(ctx context.Context, billingAccountID string, expand string, filter string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListByBillingAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListByBillingAccountSender(req *http.Request) (*http.Response, error)
- func (client UsageDetailsClient) ListByBillingPeriod(ctx context.Context, billingPeriodName string, expand string, filter string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListByBillingPeriodComplete(ctx context.Context, billingPeriodName string, expand string, filter string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListByBillingPeriodPreparer(ctx context.Context, billingPeriodName string, expand string, filter string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListByBillingPeriodResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListByBillingPeriodSender(req *http.Request) (*http.Response, error)
- func (client UsageDetailsClient) ListByDepartment(ctx context.Context, departmentID string, expand string, filter string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListByDepartmentComplete(ctx context.Context, departmentID string, expand string, filter string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListByDepartmentPreparer(ctx context.Context, departmentID string, expand string, filter string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListByDepartmentResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListByDepartmentSender(req *http.Request) (*http.Response, error)
- func (client UsageDetailsClient) ListByEnrollmentAccount(ctx context.Context, enrollmentAccountID string, expand string, filter string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListByEnrollmentAccountComplete(ctx context.Context, enrollmentAccountID string, expand string, filter string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListByEnrollmentAccountPreparer(ctx context.Context, enrollmentAccountID string, expand string, filter string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListByEnrollmentAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListByEnrollmentAccountSender(req *http.Request) (*http.Response, error)
- func (client UsageDetailsClient) ListComplete(ctx context.Context, expand string, filter string, skiptoken string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByBillingAccount(ctx context.Context, billingAccountID string, billingPeriodName string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountComplete(ctx context.Context, billingAccountID string, billingPeriodName string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountPreparer(ctx context.Context, billingAccountID string, billingPeriodName string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountSender(req *http.Request) (*http.Response, error)
- func (client UsageDetailsClient) ListForBillingPeriodByDepartment(ctx context.Context, departmentID string, billingPeriodName string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByDepartmentComplete(ctx context.Context, departmentID string, billingPeriodName string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByDepartmentPreparer(ctx context.Context, departmentID string, billingPeriodName string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListForBillingPeriodByDepartmentResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByDepartmentSender(req *http.Request) (*http.Response, error)
- func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccount(ctx context.Context, enrollmentAccountID string, billingPeriodName string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountComplete(ctx context.Context, enrollmentAccountID string, billingPeriodName string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountPreparer(ctx context.Context, enrollmentAccountID string, billingPeriodName string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountSender(req *http.Request) (*http.Response, error)
- func (client UsageDetailsClient) ListPreparer(ctx context.Context, expand string, filter string, skiptoken string, ...) (*http.Request, error)
- func (client UsageDetailsClient) ListResponder(resp *http.Response) (result UsageDetailsListResult, err error)
- func (client UsageDetailsClient) ListSender(req *http.Request) (*http.Response, error)
- type UsageDetailsListResult
- type UsageDetailsListResultIterator
- func (iter *UsageDetailsListResultIterator) Next() error
- func (iter *UsageDetailsListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter UsageDetailsListResultIterator) NotDone() bool
- func (iter UsageDetailsListResultIterator) Response() UsageDetailsListResult
- func (iter UsageDetailsListResultIterator) Value() UsageDetail
- type UsageDetailsListResultPage
- func (page *UsageDetailsListResultPage) Next() error
- func (page *UsageDetailsListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page UsageDetailsListResultPage) NotDone() bool
- func (page UsageDetailsListResultPage) Response() UsageDetailsListResult
- func (page UsageDetailsListResultPage) Values() []UsageDetail
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Consumption
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type BaseClient ¶
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 Bound ¶
type Bound string
Bound enumerates the values for bound.
func PossibleBoundValues ¶
func PossibleBoundValues() []Bound
PossibleBoundValues returns an array of possible values for the Bound const type.
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 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.
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 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 ¶
MarshalJSON is the custom marshaler for Forecast.
func (*Forecast) UnmarshalJSON ¶
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 ¶
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.
type Grain ¶
type Grain string
Grain enumerates the values for grain.
func PossibleGrainValues ¶
func PossibleGrainValues() []Grain
PossibleGrainValues returns an array of possible values for the Grain const type.
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"` }
MeterDetails the properties of the meter detail.
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 ¶
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.
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.
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(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 ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
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 ¶
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.
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
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.
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 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 ¶
MarshalJSON is the custom marshaler for Resource.
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"` // 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.
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, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultPage, err error)
List lists the usage details for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: 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) ListByBillingAccount ¶
func (client UsageDetailsClient) ListByBillingAccount(ctx context.Context, billingAccountID string, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultPage, err error)
ListByBillingAccount lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: billingAccountID - billingAccount ID 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) ListByBillingAccountComplete ¶
func (client UsageDetailsClient) ListByBillingAccountComplete(ctx context.Context, billingAccountID string, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultIterator, err error)
ListByBillingAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListByBillingAccountPreparer ¶
func (client UsageDetailsClient) ListByBillingAccountPreparer(ctx context.Context, billingAccountID string, expand string, filter string, skiptoken string, top *int32, apply string) (*http.Request, error)
ListByBillingAccountPreparer prepares the ListByBillingAccount request.
func (UsageDetailsClient) ListByBillingAccountResponder ¶
func (client UsageDetailsClient) ListByBillingAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListByBillingAccountResponder handles the response to the ListByBillingAccount request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListByBillingAccountSender ¶
func (client UsageDetailsClient) ListByBillingAccountSender(req *http.Request) (*http.Response, error)
ListByBillingAccountSender sends the ListByBillingAccount request. The method will close the http.Response Body if it receives an error.
func (UsageDetailsClient) ListByBillingPeriod ¶
func (client UsageDetailsClient) ListByBillingPeriod(ctx context.Context, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultPage, err error)
ListByBillingPeriod lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: billingPeriodName - billing Period Name. 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 or properties/instanceId. 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 (:). apply - oData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period 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.
func (UsageDetailsClient) ListByBillingPeriodComplete ¶
func (client UsageDetailsClient) ListByBillingPeriodComplete(ctx context.Context, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultIterator, err error)
ListByBillingPeriodComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListByBillingPeriodPreparer ¶
func (client UsageDetailsClient) ListByBillingPeriodPreparer(ctx context.Context, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (*http.Request, error)
ListByBillingPeriodPreparer prepares the ListByBillingPeriod request.
func (UsageDetailsClient) ListByBillingPeriodResponder ¶
func (client UsageDetailsClient) ListByBillingPeriodResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListByBillingPeriodResponder handles the response to the ListByBillingPeriod request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListByBillingPeriodSender ¶
func (client UsageDetailsClient) ListByBillingPeriodSender(req *http.Request) (*http.Response, error)
ListByBillingPeriodSender sends the ListByBillingPeriod request. The method will close the http.Response Body if it receives an error.
func (UsageDetailsClient) ListByDepartment ¶
func (client UsageDetailsClient) ListByDepartment(ctx context.Context, departmentID string, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultPage, err error)
ListByDepartment lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: departmentID - department ID 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) ListByDepartmentComplete ¶
func (client UsageDetailsClient) ListByDepartmentComplete(ctx context.Context, departmentID string, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultIterator, err error)
ListByDepartmentComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListByDepartmentPreparer ¶
func (client UsageDetailsClient) ListByDepartmentPreparer(ctx context.Context, departmentID string, expand string, filter string, skiptoken string, top *int32, apply string) (*http.Request, error)
ListByDepartmentPreparer prepares the ListByDepartment request.
func (UsageDetailsClient) ListByDepartmentResponder ¶
func (client UsageDetailsClient) ListByDepartmentResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListByDepartmentResponder handles the response to the ListByDepartment request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListByDepartmentSender ¶
ListByDepartmentSender sends the ListByDepartment request. The method will close the http.Response Body if it receives an error.
func (UsageDetailsClient) ListByEnrollmentAccount ¶
func (client UsageDetailsClient) ListByEnrollmentAccount(ctx context.Context, enrollmentAccountID string, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultPage, err error)
ListByEnrollmentAccount lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: enrollmentAccountID - enrollmentAccount ID 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) ListByEnrollmentAccountComplete ¶
func (client UsageDetailsClient) ListByEnrollmentAccountComplete(ctx context.Context, enrollmentAccountID string, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultIterator, err error)
ListByEnrollmentAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListByEnrollmentAccountPreparer ¶
func (client UsageDetailsClient) ListByEnrollmentAccountPreparer(ctx context.Context, enrollmentAccountID string, expand string, filter string, skiptoken string, top *int32, apply string) (*http.Request, error)
ListByEnrollmentAccountPreparer prepares the ListByEnrollmentAccount request.
func (UsageDetailsClient) ListByEnrollmentAccountResponder ¶
func (client UsageDetailsClient) ListByEnrollmentAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListByEnrollmentAccountResponder handles the response to the ListByEnrollmentAccount request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListByEnrollmentAccountSender ¶
func (client UsageDetailsClient) ListByEnrollmentAccountSender(req *http.Request) (*http.Response, error)
ListByEnrollmentAccountSender sends the ListByEnrollmentAccount request. The method will close the http.Response Body if it receives an error.
func (UsageDetailsClient) ListComplete ¶
func (client UsageDetailsClient) ListComplete(ctx context.Context, expand string, filter string, skiptoken string, top *int32, apply string) (result UsageDetailsListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListForBillingPeriodByBillingAccount ¶
func (client UsageDetailsClient) ListForBillingPeriodByBillingAccount(ctx context.Context, billingAccountID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultPage, err error)
ListForBillingPeriodByBillingAccount lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: billingAccountID - billingAccount ID billingPeriodName - billing Period Name. 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 or properties/instanceId. 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 (:). apply - oData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period 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.
func (UsageDetailsClient) ListForBillingPeriodByBillingAccountComplete ¶
func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountComplete(ctx context.Context, billingAccountID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultIterator, err error)
ListForBillingPeriodByBillingAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListForBillingPeriodByBillingAccountPreparer ¶
func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountPreparer(ctx context.Context, billingAccountID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (*http.Request, error)
ListForBillingPeriodByBillingAccountPreparer prepares the ListForBillingPeriodByBillingAccount request.
func (UsageDetailsClient) ListForBillingPeriodByBillingAccountResponder ¶
func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListForBillingPeriodByBillingAccountResponder handles the response to the ListForBillingPeriodByBillingAccount request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListForBillingPeriodByBillingAccountSender ¶
func (client UsageDetailsClient) ListForBillingPeriodByBillingAccountSender(req *http.Request) (*http.Response, error)
ListForBillingPeriodByBillingAccountSender sends the ListForBillingPeriodByBillingAccount request. The method will close the http.Response Body if it receives an error.
func (UsageDetailsClient) ListForBillingPeriodByDepartment ¶
func (client UsageDetailsClient) ListForBillingPeriodByDepartment(ctx context.Context, departmentID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultPage, err error)
ListForBillingPeriodByDepartment lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: departmentID - department ID billingPeriodName - billing Period Name. 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 or properties/instanceId. 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 (:). apply - oData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period 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.
func (UsageDetailsClient) ListForBillingPeriodByDepartmentComplete ¶
func (client UsageDetailsClient) ListForBillingPeriodByDepartmentComplete(ctx context.Context, departmentID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultIterator, err error)
ListForBillingPeriodByDepartmentComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListForBillingPeriodByDepartmentPreparer ¶
func (client UsageDetailsClient) ListForBillingPeriodByDepartmentPreparer(ctx context.Context, departmentID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (*http.Request, error)
ListForBillingPeriodByDepartmentPreparer prepares the ListForBillingPeriodByDepartment request.
func (UsageDetailsClient) ListForBillingPeriodByDepartmentResponder ¶
func (client UsageDetailsClient) ListForBillingPeriodByDepartmentResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListForBillingPeriodByDepartmentResponder handles the response to the ListForBillingPeriodByDepartment request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListForBillingPeriodByDepartmentSender ¶
func (client UsageDetailsClient) ListForBillingPeriodByDepartmentSender(req *http.Request) (*http.Response, error)
ListForBillingPeriodByDepartmentSender sends the ListForBillingPeriodByDepartment request. The method will close the http.Response Body if it receives an error.
func (UsageDetailsClient) ListForBillingPeriodByEnrollmentAccount ¶
func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccount(ctx context.Context, enrollmentAccountID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultPage, err error)
ListForBillingPeriodByEnrollmentAccount lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: enrollmentAccountID - enrollmentAccount ID billingPeriodName - billing Period Name. 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 or properties/instanceId. 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 (:). apply - oData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period 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.
func (UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountComplete ¶
func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountComplete(ctx context.Context, enrollmentAccountID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (result UsageDetailsListResultIterator, err error)
ListForBillingPeriodByEnrollmentAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountPreparer ¶
func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountPreparer(ctx context.Context, enrollmentAccountID string, billingPeriodName string, expand string, filter string, apply string, skiptoken string, top *int32) (*http.Request, error)
ListForBillingPeriodByEnrollmentAccountPreparer prepares the ListForBillingPeriodByEnrollmentAccount request.
func (UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountResponder ¶
func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListForBillingPeriodByEnrollmentAccountResponder handles the response to the ListForBillingPeriodByEnrollmentAccount request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountSender ¶
func (client UsageDetailsClient) ListForBillingPeriodByEnrollmentAccountSender(req *http.Request) (*http.Response, error)
ListForBillingPeriodByEnrollmentAccountSender sends the ListForBillingPeriodByEnrollmentAccount request. The method will close the http.Response Body if it receives an error.
func (UsageDetailsClient) ListPreparer ¶
func (client UsageDetailsClient) ListPreparer(ctx context.Context, 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 ¶
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.
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(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.