usagedetails

README

github.com/hashicorp/go-azure-sdk/resource-manager/costmanagement/2023-03-01/usagedetails Documentation

The usagedetails SDK allows for interaction with Azure Resource Manager costmanagement (API Version 2023-03-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/costmanagement/2023-03-01/usagedetails"

Client Initialization

client := usagedetails.NewUsageDetailsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UsageDetailsClient.GenerateDetailedCostReportCreateOperation

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

payload := usagedetails.GenerateDetailedCostReportDefinition{
	// ...
}


if err := client.GenerateDetailedCostReportCreateOperationThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

• func PossibleValuesForGenerateDetailedCostReportMetricType() []string
• type DownloadURL
  • func (o *DownloadURL) GetExpiryTimeAsTime() (*time.Time, error)
  • func (o *DownloadURL) GetValidTillAsTime() (*time.Time, error)
  • func (o *DownloadURL) SetExpiryTimeAsTime(input time.Time)
  • func (o *DownloadURL) SetValidTillAsTime(input time.Time)
• type GenerateDetailedCostReportCreateOperationOperationResponse
• type GenerateDetailedCostReportDefinition
• type GenerateDetailedCostReportMetricType
  • func (s *GenerateDetailedCostReportMetricType) UnmarshalJSON(bytes []byte) error
• type GenerateDetailedCostReportOperationResult
• type GenerateDetailedCostReportTimePeriod
• type UsageDetailsClient
  • func NewUsageDetailsClientWithBaseURI(sdkApi sdkEnv.Api) (*UsageDetailsClient, error)
  • func (c UsageDetailsClient) GenerateDetailedCostReportCreateOperation(ctx context.Context, id commonids.ScopeId, ...) (result GenerateDetailedCostReportCreateOperationOperationResponse, err error)
  • func (c UsageDetailsClient) GenerateDetailedCostReportCreateOperationThenPoll(ctx context.Context, id commonids.ScopeId, ...) error

Functions

func PossibleValuesForGenerateDetailedCostReportMetricType

func PossibleValuesForGenerateDetailedCostReportMetricType() []string

Types

type DownloadURL

type DownloadURL struct {
	DownloadURL *string `json:"downloadUrl,omitempty"`
	ExpiryTime  *string `json:"expiryTime,omitempty"`
	ValidTill   *string `json:"validTill,omitempty"`
}

func (*DownloadURL) GetExpiryTimeAsTime

func (o *DownloadURL) GetExpiryTimeAsTime() (*time.Time, error)

func (*DownloadURL) GetValidTillAsTime

func (o *DownloadURL) GetValidTillAsTime() (*time.Time, error)

func (*DownloadURL) SetExpiryTimeAsTime

func (o *DownloadURL) SetExpiryTimeAsTime(input time.Time)

func (*DownloadURL) SetValidTillAsTime

func (o *DownloadURL) SetValidTillAsTime(input time.Time)

type GenerateDetailedCostReportCreateOperationOperationResponse

type GenerateDetailedCostReportCreateOperationOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GenerateDetailedCostReportOperationResult
}

type GenerateDetailedCostReportDefinition

type GenerateDetailedCostReportDefinition struct {
	BillingPeriod *string                               `json:"billingPeriod,omitempty"`
	CustomerId    *string                               `json:"customerId,omitempty"`
	InvoiceId     *string                               `json:"invoiceId,omitempty"`
	Metric        *GenerateDetailedCostReportMetricType `json:"metric,omitempty"`
	TimePeriod    *GenerateDetailedCostReportTimePeriod `json:"timePeriod,omitempty"`
}

type GenerateDetailedCostReportMetricType

type GenerateDetailedCostReportMetricType string

const (
	GenerateDetailedCostReportMetricTypeActualCost    GenerateDetailedCostReportMetricType = "ActualCost"
	GenerateDetailedCostReportMetricTypeAmortizedCost GenerateDetailedCostReportMetricType = "AmortizedCost"
)

func (*GenerateDetailedCostReportMetricType) UnmarshalJSON

func (s *GenerateDetailedCostReportMetricType) UnmarshalJSON(bytes []byte) error

type GenerateDetailedCostReportOperationResult

type GenerateDetailedCostReportOperationResult struct {
	Id         *string      `json:"id,omitempty"`
	Name       *string      `json:"name,omitempty"`
	Properties *DownloadURL `json:"properties,omitempty"`
	Type       *string      `json:"type,omitempty"`
}

type GenerateDetailedCostReportTimePeriod

type GenerateDetailedCostReportTimePeriod struct {
	End   string `json:"end"`
	Start string `json:"start"`
}

type UsageDetailsClient

type UsageDetailsClient struct {
	Client *resourcemanager.Client
}

func NewUsageDetailsClientWithBaseURI

func NewUsageDetailsClientWithBaseURI(sdkApi sdkEnv.Api) (*UsageDetailsClient, error)

func (UsageDetailsClient) GenerateDetailedCostReportCreateOperation

func (c UsageDetailsClient) GenerateDetailedCostReportCreateOperation(ctx context.Context, id commonids.ScopeId, input GenerateDetailedCostReportDefinition) (result GenerateDetailedCostReportCreateOperationOperationResponse, err error)

GenerateDetailedCostReportCreateOperation ...

func (UsageDetailsClient) GenerateDetailedCostReportCreateOperationThenPoll

func (c UsageDetailsClient) GenerateDetailedCostReportCreateOperationThenPoll(ctx context.Context, id commonids.ScopeId, input GenerateDetailedCostReportDefinition) error

GenerateDetailedCostReportCreateOperationThenPoll performs GenerateDetailedCostReportCreateOperation then polls until it's completed