Documentation ¶
Overview ¶
Package consumption implements the Azure ARM Consumption service API version 2017-11-30.
Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type Datagrain
- type ErrorDetails
- type ErrorResponse
- 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 ReservationDetails
- type ReservationDetailsListResult
- type ReservationDetailsProperties
- type ReservationSummaries
- type ReservationSummariesListResult
- type ReservationSummariesProperties
- type ReservationsDetailsClient
- func (client ReservationsDetailsClient) List(ctx context.Context, scope string, filter string) (result ReservationDetailsListResult, err error)
- func (client ReservationsDetailsClient) ListPreparer(ctx context.Context, scope string, filter string) (*http.Request, error)
- func (client ReservationsDetailsClient) ListResponder(resp *http.Response) (result ReservationDetailsListResult, err error)
- func (client ReservationsDetailsClient) ListSender(req *http.Request) (*http.Response, error)
- type ReservationsSummariesClient
- func (client ReservationsSummariesClient) List(ctx context.Context, scope string, grain Datagrain, filter string) (result ReservationSummariesListResult, err error)
- func (client ReservationsSummariesClient) ListPreparer(ctx context.Context, scope string, grain Datagrain, filter string) (*http.Request, error)
- func (client ReservationsSummariesClient) ListResponder(resp *http.Response) (result ReservationSummariesListResult, err error)
- func (client ReservationsSummariesClient) ListSender(req *http.Request) (*http.Response, error)
- type Resource
- type UsageDetail
- type UsageDetailProperties
- type UsageDetailsClient
- func (client UsageDetailsClient) List(ctx context.Context, scope string, expand string, filter string, ...) (result UsageDetailsListResultPage, err error)
- func (client UsageDetailsClient) ListComplete(ctx context.Context, scope string, expand string, filter string, ...) (result UsageDetailsListResultIterator, err error)
- func (client UsageDetailsClient) ListPreparer(ctx context.Context, scope string, expand string, filter 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.
type Datagrain ¶
type Datagrain string
Datagrain enumerates the values for datagrain.
func PossibleDatagrainValues ¶
func PossibleDatagrainValues() []Datagrain
PossibleDatagrainValues returns an array of possible values for the Datagrain const type.
type ErrorDetails ¶
type ErrorDetails struct { // Code - Error code. Code *string `json:"code,omitempty"` // Message - Error message indicating why the operation failed. Message *string `json:"message,omitempty"` }
ErrorDetails the details of the error.
type ErrorResponse ¶
type ErrorResponse struct { // Error - The details of the error. Error *ErrorDetails `json:"error,omitempty"` }
ErrorResponse error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
type MeterDetails ¶
type MeterDetails struct { // MeterName - The name of the meter, within the given meter category MeterName *string `json:"meterName,omitempty"` // MeterCategory - The category of the meter, for example, 'Cloud services', 'Networking', etc.. MeterCategory *string `json:"meterCategory,omitempty"` // MeterSubCategory - The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. MeterSubCategory *string `json:"meterSubCategory,omitempty"` // Unit - The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. Unit *string `json:"unit,omitempty"` // MeterLocation - The location in which the Azure service is available. MeterLocation *string `json:"meterLocation,omitempty"` // TotalIncludedQuantity - The total included quantity associated with the offer. TotalIncludedQuantity *decimal.Decimal `json:"totalIncludedQuantity,omitempty"` // PretaxStandardRate - The pretax listing price. PretaxStandardRate *decimal.Decimal `json:"pretaxStandardRate,omitempty"` }
MeterDetails the properties of the meter detail.
type Operation ¶
type Operation struct { // Name - Operation name: {provider}/{resource}/{operation}. Name *string `json:"name,omitempty"` // Display - The object that represents the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation a Consumption REST API operation.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - Service provider: Microsoft.Consumption. Provider *string `json:"provider,omitempty"` // Resource - Resource on which the operation is performed: UsageDetail, etc. Resource *string `json:"resource,omitempty"` // Operation - Operation type: Read, write, delete, etc. Operation *string `json:"operation,omitempty"` }
OperationDisplay the object that represents the operation.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - List of consumption operations supported by the Microsoft.Consumption resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - URL to get the next set of operation list results if there are any. NextLink *string `json:"nextLink,omitempty"` }
OperationListResult result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.
func (OperationListResult) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
func 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.
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 ReservationDetails ¶
type ReservationDetails struct { *ReservationDetailsProperties `json:"properties,omitempty"` // ID - Resource Id. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` }
ReservationDetails reservation details resource.
func (ReservationDetails) MarshalJSON ¶
func (rd ReservationDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ReservationDetails.
func (*ReservationDetails) UnmarshalJSON ¶
func (rd *ReservationDetails) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ReservationDetails struct.
type ReservationDetailsListResult ¶
type ReservationDetailsListResult struct { autorest.Response `json:"-"` // Value - The list of reservation details. Value *[]ReservationDetails `json:"value,omitempty"` }
ReservationDetailsListResult result of listing reservation details.
type ReservationDetailsProperties ¶
type ReservationDetailsProperties struct { // ReservationOrderID - The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ReservationOrderID *string `json:"reservationOrderId,omitempty"` // ReservationID - The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ReservationID *string `json:"reservationId,omitempty"` // SkuName - This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records. SkuName *string `json:"skuName,omitempty"` // ReservedHours - This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days. ReservedHours *decimal.Decimal `json:"reservedHours,omitempty"` // UsageDate - The date on which consumption occurred. UsageDate *date.Time `json:"usageDate,omitempty"` // UsedHours - This is the total hours used by the instance. UsedHours *decimal.Decimal `json:"usedHours,omitempty"` // InstanceID - This identifier is the name of the resource or the fully qualified Resource ID. InstanceID *string `json:"instanceId,omitempty"` // TotalReservedQuantity - This is the total count of instances that are reserved for the reservationid. TotalReservedQuantity *decimal.Decimal `json:"totalReservedQuantity,omitempty"` }
ReservationDetailsProperties the properties of the reservation details.
type ReservationSummaries ¶
type ReservationSummaries struct { *ReservationSummariesProperties `json:"properties,omitempty"` // ID - Resource Id. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` }
ReservationSummaries reservation summaries resource.
func (ReservationSummaries) MarshalJSON ¶
func (rs ReservationSummaries) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ReservationSummaries.
func (*ReservationSummaries) UnmarshalJSON ¶
func (rs *ReservationSummaries) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ReservationSummaries struct.
type ReservationSummariesListResult ¶
type ReservationSummariesListResult struct { autorest.Response `json:"-"` // Value - The list of reservation summaries. Value *[]ReservationSummaries `json:"value,omitempty"` }
ReservationSummariesListResult result of listing reservation summaries.
type ReservationSummariesProperties ¶
type ReservationSummariesProperties struct { // ReservationOrderID - The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ReservationOrderID *string `json:"reservationOrderId,omitempty"` // ReservationID - The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ReservationID *string `json:"reservationId,omitempty"` // SkuName - This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records. SkuName *string `json:"skuName,omitempty"` // ReservedHours - This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days ReservedHours *decimal.Decimal `json:"reservedHours,omitempty"` // UsageDate - Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. UsageDate *date.Time `json:"usageDate,omitempty"` // UsedHours - Total used hours by the reservation UsedHours *decimal.Decimal `json:"usedHours,omitempty"` // MinUtilizationPercentage - This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day MinUtilizationPercentage *decimal.Decimal `json:"minUtilizationPercentage,omitempty"` // AvgUtilizationPercentage - This is average utilization for the entire time range. (day or month depending on the grain) AvgUtilizationPercentage *decimal.Decimal `json:"avgUtilizationPercentage,omitempty"` // MaxUtilizationPercentage - This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day. MaxUtilizationPercentage *decimal.Decimal `json:"maxUtilizationPercentage,omitempty"` }
ReservationSummariesProperties the properties of the reservation summaries.
type ReservationsDetailsClient ¶
type ReservationsDetailsClient struct {
BaseClient
}
ReservationsDetailsClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.
func NewReservationsDetailsClient ¶
func NewReservationsDetailsClient(subscriptionID string) ReservationsDetailsClient
NewReservationsDetailsClient creates an instance of the ReservationsDetailsClient client.
func NewReservationsDetailsClientWithBaseURI ¶
func NewReservationsDetailsClientWithBaseURI(baseURI string, subscriptionID string) ReservationsDetailsClient
NewReservationsDetailsClientWithBaseURI creates an instance of the ReservationsDetailsClient client.
func (ReservationsDetailsClient) List ¶
func (client ReservationsDetailsClient) List(ctx context.Context, scope string, filter string) (result ReservationDetailsListResult, err error)
List lists the reservations details for provided date range. Parameters: scope - the scope of the reservation details. The scope can be 'providers/Microsoft.Capacity/reservationorders/{ReservationOrderId}' or 'providers/Microsoft.Capacity/reservationorders/{ReservationOrderId}/reservations/{ReservationId}' filter - filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'
func (ReservationsDetailsClient) ListPreparer ¶
func (client ReservationsDetailsClient) ListPreparer(ctx context.Context, scope string, filter string) (*http.Request, error)
ListPreparer prepares the List request.
func (ReservationsDetailsClient) ListResponder ¶
func (client ReservationsDetailsClient) ListResponder(resp *http.Response) (result ReservationDetailsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (ReservationsDetailsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ReservationsSummariesClient ¶
type ReservationsSummariesClient struct {
BaseClient
}
ReservationsSummariesClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.
func NewReservationsSummariesClient ¶
func NewReservationsSummariesClient(subscriptionID string) ReservationsSummariesClient
NewReservationsSummariesClient creates an instance of the ReservationsSummariesClient client.
func NewReservationsSummariesClientWithBaseURI ¶
func NewReservationsSummariesClientWithBaseURI(baseURI string, subscriptionID string) ReservationsSummariesClient
NewReservationsSummariesClientWithBaseURI creates an instance of the ReservationsSummariesClient client.
func (ReservationsSummariesClient) List ¶
func (client ReservationsSummariesClient) List(ctx context.Context, scope string, grain Datagrain, filter string) (result ReservationSummariesListResult, err error)
List lists the reservations summaries for daily or monthly grain. Parameters: scope - the scope of the reservation summaries. The scope can be 'providers/Microsoft.Capacity/reservationorders/{ReservationOrderId}' or 'providers/Microsoft.Capacity/reservationorders/{ReservationOrderId}/reservations/{ReservationId}' 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) ListPreparer ¶
func (client ReservationsSummariesClient) ListPreparer(ctx context.Context, scope string, grain Datagrain, filter string) (*http.Request, error)
ListPreparer prepares the List request.
func (ReservationsSummariesClient) ListResponder ¶
func (client ReservationsSummariesClient) ListResponder(resp *http.Response) (result ReservationSummariesListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (ReservationsSummariesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Resource ¶
type Resource struct { // ID - Resource Id. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` }
Resource the Resource model definition.
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.
type UsageDetail ¶
type UsageDetail struct { *UsageDetailProperties `json:"properties,omitempty"` // ID - Resource Id. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` }
UsageDetail an usage detail resource.
func (UsageDetail) MarshalJSON ¶
func (ud UsageDetail) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UsageDetail.
func (*UsageDetail) UnmarshalJSON ¶
func (ud *UsageDetail) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UsageDetail struct.
type UsageDetailProperties ¶
type UsageDetailProperties struct { // BillingPeriodID - The id of the billing period resource that the usage belongs to. BillingPeriodID *string `json:"billingPeriodId,omitempty"` // InvoiceID - The id of the invoice resource that the usage belongs to. InvoiceID *string `json:"invoiceId,omitempty"` // UsageStart - The start of the date time range covered by the usage detail. UsageStart *date.Time `json:"usageStart,omitempty"` // UsageEnd - The end of the date time range covered by the usage detail. UsageEnd *date.Time `json:"usageEnd,omitempty"` // InstanceName - The name of the resource instance that the usage is about. InstanceName *string `json:"instanceName,omitempty"` // InstanceID - The uri of the resource instance that the usage is about. InstanceID *string `json:"instanceId,omitempty"` // InstanceLocation - The location of the resource instance that the usage is about. InstanceLocation *string `json:"instanceLocation,omitempty"` // Currency - The ISO currency in which the meter is charged, for example, USD. Currency *string `json:"currency,omitempty"` // UsageQuantity - The quantity of usage. UsageQuantity *decimal.Decimal `json:"usageQuantity,omitempty"` // BillableQuantity - The billable usage quantity. BillableQuantity *decimal.Decimal `json:"billableQuantity,omitempty"` // PretaxCost - The amount of cost before tax. PretaxCost *decimal.Decimal `json:"pretaxCost,omitempty"` // IsEstimated - The estimated usage is subject to change. IsEstimated *bool `json:"isEstimated,omitempty"` // MeterID - The meter id. MeterID *string `json:"meterId,omitempty"` // MeterDetails - The details about the meter. By default this is not populated, unless it's specified in $expand. MeterDetails *MeterDetails `json:"meterDetails,omitempty"` // SubscriptionGUID - Subscription guid. SubscriptionGUID *string `json:"subscriptionGuid,omitempty"` // SubscriptionName - Subscription name. SubscriptionName *string `json:"subscriptionName,omitempty"` // AccountName - Account name. AccountName *string `json:"accountName,omitempty"` // DepartmentName - Department name. DepartmentName *string `json:"departmentName,omitempty"` // Product - Product name. Product *string `json:"product,omitempty"` // ConsumedService - Consumed service name. ConsumedService *string `json:"consumedService,omitempty"` // CostCenter - The cost center of this department if it is a department and a costcenter exists CostCenter *string `json:"costCenter,omitempty"` // AdditionalProperties - Additional details of this usage item. By default this is not populated, unless it's specified in $expand. AdditionalProperties *string `json:"additionalProperties,omitempty"` }
UsageDetailProperties the properties of the usage detail.
type UsageDetailsClient ¶
type UsageDetailsClient struct {
BaseClient
}
UsageDetailsClient is the consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.
func NewUsageDetailsClient ¶
func NewUsageDetailsClient(subscriptionID string) UsageDetailsClient
NewUsageDetailsClient creates an instance of the UsageDetailsClient client.
func NewUsageDetailsClientWithBaseURI ¶
func NewUsageDetailsClientWithBaseURI(baseURI string, subscriptionID string) UsageDetailsClient
NewUsageDetailsClientWithBaseURI creates an instance of the UsageDetailsClient client.
func (UsageDetailsClient) List ¶
func (client UsageDetailsClient) List(ctx context.Context, scope string, expand string, filter string, skiptoken string, top *int32) (result UsageDetailsListResultPage, err error)
List lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. Parameters: scope - the scope of the usage details. The scope can be '/subscriptions/{subscriptionId}' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing perdiod. 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'. 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) ListComplete ¶
func (client UsageDetailsClient) ListComplete(ctx context.Context, scope string, expand string, filter string, skiptoken string, top *int32) (result UsageDetailsListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (UsageDetailsClient) ListPreparer ¶
func (client UsageDetailsClient) ListPreparer(ctx context.Context, scope string, expand string, filter string, skiptoken string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (UsageDetailsClient) ListResponder ¶
func (client UsageDetailsClient) ListResponder(resp *http.Response) (result UsageDetailsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (UsageDetailsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type UsageDetailsListResult ¶
type UsageDetailsListResult struct { autorest.Response `json:"-"` // Value - The list of usage details. Value *[]UsageDetail `json:"value,omitempty"` // NextLink - The link (url) to the next page of results. NextLink *string `json:"nextLink,omitempty"` }
UsageDetailsListResult result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.
func (UsageDetailsListResult) IsEmpty ¶
func (udlr UsageDetailsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type UsageDetailsListResultIterator ¶
type UsageDetailsListResultIterator struct {
// contains filtered or unexported fields
}
UsageDetailsListResultIterator provides access to a complete listing of UsageDetail values.
func 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.