azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/consumption/mgmt/2018-01-31/consumption Index | Files | Directories

package consumption

import "github.com/Azure/azure-sdk-for-go/services/consumption/mgmt/2018-01-31/consumption"

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

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

Index

Package Files

budgets.go client.go marketplaces.go models.go operations.go pricesheet.go reservationsdetails.go reservationssummaries.go usagedetails.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Consumption
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent Uses

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version Uses

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type BaseClient Uses

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

BaseClient is the base client for Consumption.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Budget Uses

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

Budget a budget resource.

func (Budget) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Budget.

func (*Budget) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Budget struct.

type BudgetProperties Uses

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

BudgetProperties the properties of the budget.

func (BudgetProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for BudgetProperties.

type BudgetTimePeriod Uses

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

BudgetTimePeriod the start and end date for a budget.

type BudgetsClient Uses

type BudgetsClient struct {
    BaseClient
}

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

func NewBudgetsClient Uses

func NewBudgetsClient(subscriptionID string) BudgetsClient

NewBudgetsClient creates an instance of the BudgetsClient client.

func NewBudgetsClientWithBaseURI Uses

func NewBudgetsClientWithBaseURI(baseURI string, subscriptionID string) BudgetsClient

NewBudgetsClientWithBaseURI creates an instance of the BudgetsClient client.

func (BudgetsClient) CreateOrUpdate Uses

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

CreateOrUpdate the operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag. Parameters: budgetName - budget Name. parameters - parameters supplied to the Create Budget operation.

func (BudgetsClient) CreateOrUpdateByResourceGroupName Uses

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

CreateOrUpdateByResourceGroupName the operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag. Parameters: resourceGroupName - azure Resource Group Name. budgetName - budget Name. parameters - parameters supplied to the Create Budget operation.

func (BudgetsClient) CreateOrUpdateByResourceGroupNamePreparer Uses

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

CreateOrUpdateByResourceGroupNamePreparer prepares the CreateOrUpdateByResourceGroupName request.

func (BudgetsClient) CreateOrUpdateByResourceGroupNameResponder Uses

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

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

func (BudgetsClient) CreateOrUpdateByResourceGroupNameSender Uses

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

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

func (BudgetsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BudgetsClient) CreateOrUpdateResponder Uses

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

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

func (BudgetsClient) CreateOrUpdateSender Uses

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

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

func (BudgetsClient) Delete Uses

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

Delete the operation to delete a budget. Parameters: budgetName - budget Name.

func (BudgetsClient) DeleteByResourceGroupName Uses

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

DeleteByResourceGroupName the operation to delete a budget. Parameters: resourceGroupName - azure Resource Group Name. budgetName - budget Name.

func (BudgetsClient) DeleteByResourceGroupNamePreparer Uses

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

DeleteByResourceGroupNamePreparer prepares the DeleteByResourceGroupName request.

func (BudgetsClient) DeleteByResourceGroupNameResponder Uses

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

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

func (BudgetsClient) DeleteByResourceGroupNameSender Uses

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

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

func (BudgetsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (BudgetsClient) DeleteResponder Uses

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

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

func (BudgetsClient) DeleteSender Uses

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

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

func (BudgetsClient) Get Uses

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

Get gets the budget for a subscription by budget name. Parameters: budgetName - budget Name.

func (BudgetsClient) GetByResourceGroupName Uses

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

GetByResourceGroupName gets the budget for a resource group under a subscription by budget name. Parameters: resourceGroupName - azure Resource Group Name. budgetName - budget Name.

func (BudgetsClient) GetByResourceGroupNamePreparer Uses

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

GetByResourceGroupNamePreparer prepares the GetByResourceGroupName request.

func (BudgetsClient) GetByResourceGroupNameResponder Uses

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

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

func (BudgetsClient) GetByResourceGroupNameSender Uses

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

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

func (BudgetsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (BudgetsClient) GetResponder Uses

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

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

func (BudgetsClient) GetSender Uses

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

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

func (BudgetsClient) List Uses

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

List lists all budgets for a subscription.

func (BudgetsClient) ListByResourceGroupName Uses

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

ListByResourceGroupName lists all budgets for a resource group under a subscription. Parameters: resourceGroupName - azure Resource Group Name.

func (BudgetsClient) ListByResourceGroupNameComplete Uses

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

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

func (BudgetsClient) ListByResourceGroupNamePreparer Uses

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

ListByResourceGroupNamePreparer prepares the ListByResourceGroupName request.

func (BudgetsClient) ListByResourceGroupNameResponder Uses

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

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

func (BudgetsClient) ListByResourceGroupNameSender Uses

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

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

func (BudgetsClient) ListComplete Uses

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

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

func (BudgetsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (BudgetsClient) ListResponder Uses

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

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

func (BudgetsClient) ListSender Uses

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

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

type BudgetsListResult Uses

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

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

func (BudgetsListResult) IsEmpty Uses

func (blr BudgetsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BudgetsListResultIterator Uses

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

BudgetsListResultIterator provides access to a complete listing of Budget values.

func NewBudgetsListResultIterator Uses

func NewBudgetsListResultIterator(page BudgetsListResultPage) BudgetsListResultIterator

Creates a new instance of the BudgetsListResultIterator type.

func (*BudgetsListResultIterator) Next Uses

func (iter *BudgetsListResultIterator) Next() error

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

func (*BudgetsListResultIterator) NextWithContext Uses

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

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

func (BudgetsListResultIterator) NotDone Uses

func (iter BudgetsListResultIterator) NotDone() bool

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

func (BudgetsListResultIterator) Response Uses

func (iter BudgetsListResultIterator) Response() BudgetsListResult

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

func (BudgetsListResultIterator) Value Uses

func (iter BudgetsListResultIterator) Value() Budget

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

type BudgetsListResultPage Uses

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

BudgetsListResultPage contains a page of Budget values.

func NewBudgetsListResultPage Uses

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

Creates a new instance of the BudgetsListResultPage type.

func (*BudgetsListResultPage) Next Uses

func (page *BudgetsListResultPage) Next() error

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

func (*BudgetsListResultPage) NextWithContext Uses

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

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

func (BudgetsListResultPage) NotDone Uses

func (page BudgetsListResultPage) NotDone() bool

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

func (BudgetsListResultPage) Response Uses

func (page BudgetsListResultPage) Response() BudgetsListResult

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

func (BudgetsListResultPage) Values Uses

func (page BudgetsListResultPage) Values() []Budget

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

type CategoryType Uses

type CategoryType string

CategoryType enumerates the values for category type.

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

func PossibleCategoryTypeValues Uses

func PossibleCategoryTypeValues() []CategoryType

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

type CurrentSpend Uses

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

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

type Datagrain Uses

type Datagrain string

Datagrain enumerates the values for datagrain.

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

func PossibleDatagrainValues Uses

func PossibleDatagrainValues() []Datagrain

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

type ErrorDetails Uses

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 Uses

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

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

type Filters Uses

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

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

type Marketplace Uses

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

Marketplace an marketplace resource.

func (Marketplace) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Marketplace.

func (*Marketplace) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Marketplace struct.

type MarketplaceProperties Uses

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

MarketplaceProperties the properties of the marketplace usage detail.

type MarketplacesClient Uses

type MarketplacesClient struct {
    BaseClient
}

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

func NewMarketplacesClient Uses

func NewMarketplacesClient(subscriptionID string) MarketplacesClient

NewMarketplacesClient creates an instance of the MarketplacesClient client.

func NewMarketplacesClientWithBaseURI Uses

func NewMarketplacesClientWithBaseURI(baseURI string, subscriptionID string) MarketplacesClient

NewMarketplacesClientWithBaseURI creates an instance of the MarketplacesClient client.

func (MarketplacesClient) List Uses

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

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

func (MarketplacesClient) ListByBillingPeriod Uses

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

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

func (MarketplacesClient) ListByBillingPeriodComplete Uses

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

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

func (MarketplacesClient) ListByBillingPeriodPreparer Uses

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

ListByBillingPeriodPreparer prepares the ListByBillingPeriod request.

func (MarketplacesClient) ListByBillingPeriodResponder Uses

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

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

func (MarketplacesClient) ListByBillingPeriodSender Uses

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

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

func (MarketplacesClient) ListComplete Uses

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

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

func (MarketplacesClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (MarketplacesClient) ListResponder Uses

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

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

func (MarketplacesClient) ListSender Uses

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

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

type MarketplacesListResult Uses

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

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

func (MarketplacesListResult) IsEmpty Uses

func (mlr MarketplacesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type MarketplacesListResultIterator Uses

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

MarketplacesListResultIterator provides access to a complete listing of Marketplace values.

func NewMarketplacesListResultIterator Uses

func NewMarketplacesListResultIterator(page MarketplacesListResultPage) MarketplacesListResultIterator

Creates a new instance of the MarketplacesListResultIterator type.

func (*MarketplacesListResultIterator) Next Uses

func (iter *MarketplacesListResultIterator) Next() error

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

func (*MarketplacesListResultIterator) NextWithContext Uses

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

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

func (MarketplacesListResultIterator) NotDone Uses

func (iter MarketplacesListResultIterator) NotDone() bool

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

func (MarketplacesListResultIterator) Response Uses

func (iter MarketplacesListResultIterator) Response() MarketplacesListResult

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

func (MarketplacesListResultIterator) Value Uses

func (iter MarketplacesListResultIterator) Value() Marketplace

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

type MarketplacesListResultPage Uses

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

MarketplacesListResultPage contains a page of Marketplace values.

func NewMarketplacesListResultPage Uses

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

Creates a new instance of the MarketplacesListResultPage type.

func (*MarketplacesListResultPage) Next Uses

func (page *MarketplacesListResultPage) Next() error

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

func (*MarketplacesListResultPage) NextWithContext Uses

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

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

func (MarketplacesListResultPage) NotDone Uses

func (page MarketplacesListResultPage) NotDone() bool

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

func (MarketplacesListResultPage) Response Uses

func (page MarketplacesListResultPage) Response() MarketplacesListResult

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

func (MarketplacesListResultPage) Values Uses

func (page MarketplacesListResultPage) Values() []Marketplace

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

type MeterDetails Uses

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 Notification Uses

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

Notification the notification associated with a budget.

type Operation Uses

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.

type OperationDisplay Uses

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 Uses

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 Uses

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator Uses

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator Uses

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next Uses

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 Uses

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 Uses

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response Uses

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value Uses

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 Uses

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage Uses

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next Uses

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 Uses

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 Uses

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response Uses

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values Uses

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

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

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

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

List lists all of the available consumption REST API operations.

func (OperationsClient) ListComplete Uses

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

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

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

type OperatorType Uses

type OperatorType string

OperatorType enumerates the values for operator type.

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

func PossibleOperatorTypeValues Uses

func PossibleOperatorTypeValues() []OperatorType

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

type PriceSheetClient Uses

type PriceSheetClient struct {
    BaseClient
}

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

func NewPriceSheetClient Uses

func NewPriceSheetClient(subscriptionID string) PriceSheetClient

NewPriceSheetClient creates an instance of the PriceSheetClient client.

func NewPriceSheetClientWithBaseURI Uses

func NewPriceSheetClientWithBaseURI(baseURI string, subscriptionID string) PriceSheetClient

NewPriceSheetClientWithBaseURI creates an instance of the PriceSheetClient client.

func (PriceSheetClient) Get Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

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

func (PriceSheetClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (PriceSheetClient) GetResponder Uses

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

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

func (PriceSheetClient) GetSender Uses

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

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

type PriceSheetModel Uses

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 Uses

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
    MeterID *string `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"`
}

PriceSheetProperties the properties of the price sheet.

type PriceSheetResult Uses

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 Uses

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

MarshalJSON is the custom marshaler for PriceSheetResult.

func (*PriceSheetResult) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for PriceSheetResult struct.

type ProxyResource Uses

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

ProxyResource the Resource model definition.

type ReservationDetails Uses

type ReservationDetails struct {
    *ReservationDetailsProperties `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"`
}

ReservationDetails reservation details resource.

func (ReservationDetails) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ReservationDetails.

func (*ReservationDetails) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ReservationDetails struct.

type ReservationDetailsListResult Uses

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

ReservationDetailsListResult result of listing reservation details.

func (ReservationDetailsListResult) IsEmpty Uses

func (rdlr ReservationDetailsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ReservationDetailsListResultIterator Uses

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

ReservationDetailsListResultIterator provides access to a complete listing of ReservationDetails values.

func NewReservationDetailsListResultIterator Uses

func NewReservationDetailsListResultIterator(page ReservationDetailsListResultPage) ReservationDetailsListResultIterator

Creates a new instance of the ReservationDetailsListResultIterator type.

func (*ReservationDetailsListResultIterator) Next Uses

func (iter *ReservationDetailsListResultIterator) Next() error

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

func (*ReservationDetailsListResultIterator) NextWithContext Uses

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

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

func (ReservationDetailsListResultIterator) NotDone Uses

func (iter ReservationDetailsListResultIterator) NotDone() bool

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

func (ReservationDetailsListResultIterator) Response Uses

func (iter ReservationDetailsListResultIterator) Response() ReservationDetailsListResult

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

func (ReservationDetailsListResultIterator) Value Uses

func (iter ReservationDetailsListResultIterator) Value() ReservationDetails

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

type ReservationDetailsListResultPage Uses

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

ReservationDetailsListResultPage contains a page of ReservationDetails values.

func NewReservationDetailsListResultPage Uses

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

Creates a new instance of the ReservationDetailsListResultPage type.

func (*ReservationDetailsListResultPage) Next Uses

func (page *ReservationDetailsListResultPage) Next() error

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

func (*ReservationDetailsListResultPage) NextWithContext Uses

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

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

func (ReservationDetailsListResultPage) NotDone Uses

func (page ReservationDetailsListResultPage) NotDone() bool

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

func (ReservationDetailsListResultPage) Response Uses

func (page ReservationDetailsListResultPage) Response() ReservationDetailsListResult

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

func (ReservationDetailsListResultPage) Values Uses

func (page ReservationDetailsListResultPage) Values() []ReservationDetails

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

type ReservationDetailsProperties Uses

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

ReservationDetailsProperties the properties of the reservation details.

type ReservationSummaries Uses

type ReservationSummaries struct {
    *ReservationSummariesProperties `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"`
}

ReservationSummaries reservation summaries resource.

func (ReservationSummaries) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ReservationSummaries.

func (*ReservationSummaries) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ReservationSummaries struct.

type ReservationSummariesListResult Uses

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

ReservationSummariesListResult result of listing reservation summaries.

func (ReservationSummariesListResult) IsEmpty Uses

func (rslr ReservationSummariesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ReservationSummariesListResultIterator Uses

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

ReservationSummariesListResultIterator provides access to a complete listing of ReservationSummaries values.

func NewReservationSummariesListResultIterator Uses

func NewReservationSummariesListResultIterator(page ReservationSummariesListResultPage) ReservationSummariesListResultIterator

Creates a new instance of the ReservationSummariesListResultIterator type.

func (*ReservationSummariesListResultIterator) Next Uses

func (iter *ReservationSummariesListResultIterator) Next() error

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

func (*ReservationSummariesListResultIterator) NextWithContext Uses

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

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

func (ReservationSummariesListResultIterator) NotDone Uses

func (iter ReservationSummariesListResultIterator) NotDone() bool

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

func (ReservationSummariesListResultIterator) Response Uses

func (iter ReservationSummariesListResultIterator) Response() ReservationSummariesListResult

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

func (ReservationSummariesListResultIterator) Value Uses

func (iter ReservationSummariesListResultIterator) Value() ReservationSummaries

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

type ReservationSummariesListResultPage Uses

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

ReservationSummariesListResultPage contains a page of ReservationSummaries values.

func NewReservationSummariesListResultPage Uses

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

Creates a new instance of the ReservationSummariesListResultPage type.

func (*ReservationSummariesListResultPage) Next Uses

func (page *ReservationSummariesListResultPage) Next() error

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

func (*ReservationSummariesListResultPage) NextWithContext Uses

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

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

func (ReservationSummariesListResultPage) NotDone Uses

func (page ReservationSummariesListResultPage) NotDone() bool

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

func (ReservationSummariesListResultPage) Response Uses

func (page ReservationSummariesListResultPage) Response() ReservationSummariesListResult

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

func (ReservationSummariesListResultPage) Values Uses

func (page ReservationSummariesListResultPage) Values() []ReservationSummaries

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

type ReservationSummariesProperties Uses

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

ReservationSummariesProperties the properties of the reservation summaries.

type ReservationsDetailsClient Uses

type ReservationsDetailsClient struct {
    BaseClient
}

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

func NewReservationsDetailsClient Uses

func NewReservationsDetailsClient(subscriptionID string) ReservationsDetailsClient

NewReservationsDetailsClient creates an instance of the ReservationsDetailsClient client.

func NewReservationsDetailsClientWithBaseURI Uses

func NewReservationsDetailsClientWithBaseURI(baseURI string, subscriptionID string) ReservationsDetailsClient

NewReservationsDetailsClientWithBaseURI creates an instance of the ReservationsDetailsClient client.

func (ReservationsDetailsClient) ListByReservationOrder Uses

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

ListByReservationOrder lists the reservations details for provided date range. Parameters: reservationOrderID - order Id of the reservation filter - filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsDetailsClient) ListByReservationOrderAndReservation Uses

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

ListByReservationOrderAndReservation lists the reservations details for provided date range. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the reservation filter - filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsDetailsClient) ListByReservationOrderAndReservationComplete Uses

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

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

func (ReservationsDetailsClient) ListByReservationOrderAndReservationPreparer Uses

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

ListByReservationOrderAndReservationPreparer prepares the ListByReservationOrderAndReservation request.

func (ReservationsDetailsClient) ListByReservationOrderAndReservationResponder Uses

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

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

func (ReservationsDetailsClient) ListByReservationOrderAndReservationSender Uses

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

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

func (ReservationsDetailsClient) ListByReservationOrderComplete Uses

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

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

func (ReservationsDetailsClient) ListByReservationOrderPreparer Uses

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

ListByReservationOrderPreparer prepares the ListByReservationOrder request.

func (ReservationsDetailsClient) ListByReservationOrderResponder Uses

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

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

func (ReservationsDetailsClient) ListByReservationOrderSender Uses

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

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

type ReservationsSummariesClient Uses

type ReservationsSummariesClient struct {
    BaseClient
}

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

func NewReservationsSummariesClient Uses

func NewReservationsSummariesClient(subscriptionID string) ReservationsSummariesClient

NewReservationsSummariesClient creates an instance of the ReservationsSummariesClient client.

func NewReservationsSummariesClientWithBaseURI Uses

func NewReservationsSummariesClientWithBaseURI(baseURI string, subscriptionID string) ReservationsSummariesClient

NewReservationsSummariesClientWithBaseURI creates an instance of the ReservationsSummariesClient client.

func (ReservationsSummariesClient) ListByReservationOrder Uses

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

ListByReservationOrder lists the reservations summaries for daily or monthly grain. Parameters: reservationOrderID - order Id of the reservation grain - can be daily or monthly filter - required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsSummariesClient) ListByReservationOrderAndReservation Uses

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

ListByReservationOrderAndReservation lists the reservations summaries for daily or monthly grain. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the reservation grain - can be daily or monthly filter - required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'

func (ReservationsSummariesClient) ListByReservationOrderAndReservationComplete Uses

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

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

func (ReservationsSummariesClient) ListByReservationOrderAndReservationPreparer Uses

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

ListByReservationOrderAndReservationPreparer prepares the ListByReservationOrderAndReservation request.

func (ReservationsSummariesClient) ListByReservationOrderAndReservationResponder Uses

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

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

func (ReservationsSummariesClient) ListByReservationOrderAndReservationSender Uses

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

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

func (ReservationsSummariesClient) ListByReservationOrderComplete Uses

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

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

func (ReservationsSummariesClient) ListByReservationOrderPreparer Uses

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

ListByReservationOrderPreparer prepares the ListByReservationOrder request.

func (ReservationsSummariesClient) ListByReservationOrderResponder Uses

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

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

func (ReservationsSummariesClient) ListByReservationOrderSender Uses

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

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

type Resource Uses

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 Uses

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

MarshalJSON is the custom marshaler for Resource.

type TimeGrainType Uses

type TimeGrainType string

TimeGrainType enumerates the values for time grain type.

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

func PossibleTimeGrainTypeValues Uses

func PossibleTimeGrainTypeValues() []TimeGrainType

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

type UsageDetail Uses

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 Uses

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

MarshalJSON is the custom marshaler for UsageDetail.

func (*UsageDetail) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for UsageDetail struct.

type UsageDetailProperties Uses

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.
    MeterID *string `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 *string `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"`
    // 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 Uses

type UsageDetailsClient struct {
    BaseClient
}

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

func NewUsageDetailsClient Uses

func NewUsageDetailsClient(subscriptionID string) UsageDetailsClient

NewUsageDetailsClient creates an instance of the UsageDetailsClient client.

func NewUsageDetailsClientWithBaseURI Uses

func NewUsageDetailsClientWithBaseURI(baseURI string, subscriptionID string) UsageDetailsClient

NewUsageDetailsClientWithBaseURI creates an instance of the UsageDetailsClient client.

func (UsageDetailsClient) List Uses

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

List lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. 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 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) ListByBillingPeriod Uses

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

ListByBillingPeriod lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. 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'. 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 Uses

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

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

func (UsageDetailsClient) ListByBillingPeriodPreparer Uses

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

ListByBillingPeriodPreparer prepares the ListByBillingPeriod request.

func (UsageDetailsClient) ListByBillingPeriodResponder Uses

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 Uses

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

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

func (UsageDetailsClient) ListComplete Uses

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

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

func (UsageDetailsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (UsageDetailsClient) ListResponder Uses

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 Uses

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

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

type UsageDetailsListResult Uses

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 Uses

func (udlr UsageDetailsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UsageDetailsListResultIterator Uses

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

UsageDetailsListResultIterator provides access to a complete listing of UsageDetail values.

func NewUsageDetailsListResultIterator Uses

func NewUsageDetailsListResultIterator(page UsageDetailsListResultPage) UsageDetailsListResultIterator

Creates a new instance of the UsageDetailsListResultIterator type.

func (*UsageDetailsListResultIterator) Next Uses

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 Uses

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 Uses

func (iter UsageDetailsListResultIterator) NotDone() bool

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

func (UsageDetailsListResultIterator) Response Uses

func (iter UsageDetailsListResultIterator) Response() UsageDetailsListResult

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

func (UsageDetailsListResultIterator) Value Uses

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 Uses

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

UsageDetailsListResultPage contains a page of UsageDetail values.

func NewUsageDetailsListResultPage Uses

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

Creates a new instance of the UsageDetailsListResultPage type.

func (*UsageDetailsListResultPage) Next Uses

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 Uses

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 Uses

func (page UsageDetailsListResultPage) NotDone() bool

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

func (UsageDetailsListResultPage) Response Uses

func (page UsageDetailsListResultPage) Response() UsageDetailsListResult

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

func (UsageDetailsListResultPage) Values Uses

func (page UsageDetailsListResultPage) Values() []UsageDetail

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

Directories

PathSynopsis
consumptionapi

Package consumption imports 11 packages (graph) and is imported by 4 packages. Updated 2019-08-18. Refresh now. Tools for package owners.