consumptionapi

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Index

• type AggregatedCostClientAPI
• type BalancesClientAPI
• type BudgetsClientAPI
• type ChargesClientAPI
• type CreditsClientAPI
• type EventsClientAPI
• type ForecastsClientAPI
• type LotsClientAPI
• type MarketplacesClientAPI
• type OperationsClientAPI
• type PriceSheetClientAPI
• type ReservationRecommendationDetailsClientAPI
• type ReservationRecommendationsClientAPI
• type ReservationTransactionsClientAPI
• type ReservationsDetailsClientAPI
• type ReservationsSummariesClientAPI
• type TagsClientAPI
• type UsageDetailsClientAPI

Types

type AggregatedCostClientAPI

type AggregatedCostClientAPI interface {
	GetByManagementGroup(ctx context.Context, managementGroupID string, filter string) (result consumption.ManagementGroupAggregatedCostResult, err error)
	GetForBillingPeriodByManagementGroup(ctx context.Context, managementGroupID string, billingPeriodName string) (result consumption.ManagementGroupAggregatedCostResult, err error)
}

AggregatedCostClientAPI contains the set of methods on the AggregatedCostClient type.

type BalancesClientAPI

type BalancesClientAPI interface {
	GetByBillingAccount(ctx context.Context, billingAccountID string) (result consumption.Balance, err error)
	GetForBillingPeriodByBillingAccount(ctx context.Context, billingAccountID string, billingPeriodName string) (result consumption.Balance, err error)
}

BalancesClientAPI contains the set of methods on the BalancesClient type.

type BudgetsClientAPI

type BudgetsClientAPI interface {
	CreateOrUpdate(ctx context.Context, scope string, budgetName string, parameters consumption.Budget) (result consumption.Budget, err error)
	Delete(ctx context.Context, scope string, budgetName string) (result autorest.Response, err error)
	Get(ctx context.Context, scope string, budgetName string) (result consumption.Budget, err error)
	List(ctx context.Context, scope string) (result consumption.BudgetsListResultPage, err error)
	ListComplete(ctx context.Context, scope string) (result consumption.BudgetsListResultIterator, err error)
}

BudgetsClientAPI contains the set of methods on the BudgetsClient type.

type ChargesClientAPI

type ChargesClientAPI interface {
	List(ctx context.Context, scope string, startDate string, endDate string, filter string, apply string) (result consumption.ChargesListResult, err error)
}

ChargesClientAPI contains the set of methods on the ChargesClient type.

type CreditsClientAPI

type CreditsClientAPI interface {
	Get(ctx context.Context, scope string) (result consumption.CreditSummary, err error)
}

CreditsClientAPI contains the set of methods on the CreditsClient type.

type EventsClientAPI

type EventsClientAPI interface {
	List(ctx context.Context, startDate string, endDate string, scope string) (result consumption.EventsPage, err error)
	ListComplete(ctx context.Context, startDate string, endDate string, scope string) (result consumption.EventsIterator, err error)
}

EventsClientAPI contains the set of methods on the EventsClient type.

type ForecastsClientAPI

type ForecastsClientAPI interface {
	List(ctx context.Context, filter string) (result consumption.ForecastsListResult, err error)
}

ForecastsClientAPI contains the set of methods on the ForecastsClient type.

type LotsClientAPI

type LotsClientAPI interface {
	List(ctx context.Context, scope string) (result consumption.LotsPage, err error)
	ListComplete(ctx context.Context, scope string) (result consumption.LotsIterator, err error)
}

LotsClientAPI contains the set of methods on the LotsClient type.

type MarketplacesClientAPI

type MarketplacesClientAPI interface {
	List(ctx context.Context, scope string, filter string, top *int32, skiptoken string) (result consumption.MarketplacesListResultPage, err error)
	ListComplete(ctx context.Context, scope string, filter string, top *int32, skiptoken string) (result consumption.MarketplacesListResultIterator, err error)
}

MarketplacesClientAPI contains the set of methods on the MarketplacesClient type.

type OperationsClientAPI

type OperationsClientAPI interface {
	List(ctx context.Context) (result consumption.OperationListResultPage, err error)
	ListComplete(ctx context.Context) (result consumption.OperationListResultIterator, err error)
}

OperationsClientAPI contains the set of methods on the OperationsClient type.

type PriceSheetClientAPI

type PriceSheetClientAPI interface {
	Get(ctx context.Context, expand string, skiptoken string, top *int32) (result consumption.PriceSheetResult, err error)
	GetByBillingPeriod(ctx context.Context, billingPeriodName string, expand string, skiptoken string, top *int32) (result consumption.PriceSheetResult, err error)
}

PriceSheetClientAPI contains the set of methods on the PriceSheetClient type.

type ReservationRecommendationDetailsClientAPI

type ReservationRecommendationDetailsClientAPI interface {
	Get(ctx context.Context, billingScope string, scope consumption.Scope14, region string, term consumption.Term, lookBackPeriod consumption.LookBackPeriod, product string) (result consumption.ReservationRecommendationDetailsModel, err error)
}

ReservationRecommendationDetailsClientAPI contains the set of methods on the ReservationRecommendationDetailsClient type.

type ReservationRecommendationsClientAPI

type ReservationRecommendationsClientAPI interface {
	List(ctx context.Context, scope string, filter string) (result consumption.ReservationRecommendationsListResultPage, err error)
	ListComplete(ctx context.Context, scope string, filter string) (result consumption.ReservationRecommendationsListResultIterator, err error)
}

ReservationRecommendationsClientAPI contains the set of methods on the ReservationRecommendationsClient type.

type ReservationTransactionsClientAPI

type ReservationTransactionsClientAPI interface {
	List(ctx context.Context, billingAccountID string, filter string) (result consumption.ReservationTransactionsListResultPage, err error)
	ListComplete(ctx context.Context, billingAccountID string, filter string) (result consumption.ReservationTransactionsListResultIterator, err error)
	ListByBillingProfile(ctx context.Context, billingAccountID string, billingProfileID string, filter string) (result consumption.ModernReservationTransactionsListResultPage, err error)
	ListByBillingProfileComplete(ctx context.Context, billingAccountID string, billingProfileID string, filter string) (result consumption.ModernReservationTransactionsListResultIterator, err error)
}

ReservationTransactionsClientAPI contains the set of methods on the ReservationTransactionsClient type.

type ReservationsDetailsClientAPI

type ReservationsDetailsClientAPI interface {
	List(ctx context.Context, scope string, startDate string, endDate string, filter string, reservationID string, reservationOrderID string) (result consumption.ReservationDetailsListResultPage, err error)
	ListComplete(ctx context.Context, scope string, startDate string, endDate string, filter string, reservationID string, reservationOrderID string) (result consumption.ReservationDetailsListResultIterator, err error)
	ListByReservationOrder(ctx context.Context, reservationOrderID string, filter string) (result consumption.ReservationDetailsListResultPage, err error)
	ListByReservationOrderComplete(ctx context.Context, reservationOrderID string, filter string) (result consumption.ReservationDetailsListResultIterator, err error)
	ListByReservationOrderAndReservation(ctx context.Context, reservationOrderID string, reservationID string, filter string) (result consumption.ReservationDetailsListResultPage, err error)
	ListByReservationOrderAndReservationComplete(ctx context.Context, reservationOrderID string, reservationID string, filter string) (result consumption.ReservationDetailsListResultIterator, err error)
}

ReservationsDetailsClientAPI contains the set of methods on the ReservationsDetailsClient type.

type ReservationsSummariesClientAPI

type ReservationsSummariesClientAPI interface {
	List(ctx context.Context, scope string, grain consumption.Datagrain, startDate string, endDate string, filter string, reservationID string, reservationOrderID string) (result consumption.ReservationSummariesListResultPage, err error)
	ListComplete(ctx context.Context, scope string, grain consumption.Datagrain, startDate string, endDate string, filter string, reservationID string, reservationOrderID string) (result consumption.ReservationSummariesListResultIterator, err error)
	ListByReservationOrder(ctx context.Context, reservationOrderID string, grain consumption.Datagrain, filter string) (result consumption.ReservationSummariesListResultPage, err error)
	ListByReservationOrderComplete(ctx context.Context, reservationOrderID string, grain consumption.Datagrain, filter string) (result consumption.ReservationSummariesListResultIterator, err error)
	ListByReservationOrderAndReservation(ctx context.Context, reservationOrderID string, reservationID string, grain consumption.Datagrain, filter string) (result consumption.ReservationSummariesListResultPage, err error)
	ListByReservationOrderAndReservationComplete(ctx context.Context, reservationOrderID string, reservationID string, grain consumption.Datagrain, filter string) (result consumption.ReservationSummariesListResultIterator, err error)
}

ReservationsSummariesClientAPI contains the set of methods on the ReservationsSummariesClient type.

type TagsClientAPI

type TagsClientAPI interface {
	Get(ctx context.Context, scope string) (result consumption.TagsResult, err error)
}

TagsClientAPI contains the set of methods on the TagsClient type.

type UsageDetailsClientAPI

type UsageDetailsClientAPI interface {
	List(ctx context.Context, scope string, expand string, filter string, skiptoken string, top *int32, metric consumption.Metrictype) (result consumption.UsageDetailsListResultPage, err error)
	ListComplete(ctx context.Context, scope string, expand string, filter string, skiptoken string, top *int32, metric consumption.Metrictype) (result consumption.UsageDetailsListResultIterator, err error)
}

UsageDetailsClientAPI contains the set of methods on the UsageDetailsClient type.