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

package costmanagement

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

Package costmanagement implements the Azure ARM Costmanagement service API version 2018-05-31.

Index

Package Files

billingaccountdimensions.go client.go models.go operations.go reportconfig.go resourcegroupdimensions.go subscriptiondimensions.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Costmanagement
    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 Costmanagement.

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.

func (BaseClient) QueryBillingAccount Uses

func (client BaseClient) QueryBillingAccount(ctx context.Context, billingAccountID string, parameters ReportConfigDefinition) (result QueryResult, err error)

QueryBillingAccount lists the usage data for billing account. Parameters: billingAccountID - billingAccount ID parameters - parameters supplied to the CreateOrUpdate Report Config operation.

func (BaseClient) QueryBillingAccountPreparer Uses

func (client BaseClient) QueryBillingAccountPreparer(ctx context.Context, billingAccountID string, parameters ReportConfigDefinition) (*http.Request, error)

QueryBillingAccountPreparer prepares the QueryBillingAccount request.

func (BaseClient) QueryBillingAccountResponder Uses

func (client BaseClient) QueryBillingAccountResponder(resp *http.Response) (result QueryResult, err error)

QueryBillingAccountResponder handles the response to the QueryBillingAccount request. The method always closes the http.Response Body.

func (BaseClient) QueryBillingAccountSender Uses

func (client BaseClient) QueryBillingAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) QueryResourceGroup Uses

func (client BaseClient) QueryResourceGroup(ctx context.Context, resourceGroupName string, parameters ReportConfigDefinition) (result QueryResult, err error)

QueryResourceGroup lists the usage data for subscriptionId and resource group. Parameters: resourceGroupName - azure Resource Group Name. parameters - parameters supplied to the CreateOrUpdate Report Config operation.

func (BaseClient) QueryResourceGroupPreparer Uses

func (client BaseClient) QueryResourceGroupPreparer(ctx context.Context, resourceGroupName string, parameters ReportConfigDefinition) (*http.Request, error)

QueryResourceGroupPreparer prepares the QueryResourceGroup request.

func (BaseClient) QueryResourceGroupResponder Uses

func (client BaseClient) QueryResourceGroupResponder(resp *http.Response) (result QueryResult, err error)

QueryResourceGroupResponder handles the response to the QueryResourceGroup request. The method always closes the http.Response Body.

func (BaseClient) QueryResourceGroupSender Uses

func (client BaseClient) QueryResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) QuerySubscription Uses

func (client BaseClient) QuerySubscription(ctx context.Context, parameters ReportConfigDefinition) (result QueryResult, err error)

QuerySubscription lists the usage data for subscriptionId. Parameters: parameters - parameters supplied to the CreateOrUpdate Report Config operation.

func (BaseClient) QuerySubscriptionPreparer Uses

func (client BaseClient) QuerySubscriptionPreparer(ctx context.Context, parameters ReportConfigDefinition) (*http.Request, error)

QuerySubscriptionPreparer prepares the QuerySubscription request.

func (BaseClient) QuerySubscriptionResponder Uses

func (client BaseClient) QuerySubscriptionResponder(resp *http.Response) (result QueryResult, err error)

QuerySubscriptionResponder handles the response to the QuerySubscription request. The method always closes the http.Response Body.

func (BaseClient) QuerySubscriptionSender Uses

func (client BaseClient) QuerySubscriptionSender(req *http.Request) (*http.Response, error)

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

type BillingAccountDimensionsClient Uses

type BillingAccountDimensionsClient struct {
    BaseClient
}

BillingAccountDimensionsClient is the client for the BillingAccountDimensions methods of the Costmanagement service.

func NewBillingAccountDimensionsClient Uses

func NewBillingAccountDimensionsClient(subscriptionID string) BillingAccountDimensionsClient

NewBillingAccountDimensionsClient creates an instance of the BillingAccountDimensionsClient client.

func NewBillingAccountDimensionsClientWithBaseURI Uses

func NewBillingAccountDimensionsClientWithBaseURI(baseURI string, subscriptionID string) BillingAccountDimensionsClient

NewBillingAccountDimensionsClientWithBaseURI creates an instance of the BillingAccountDimensionsClient client.

func (BillingAccountDimensionsClient) List Uses

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

List lists the dimensions by billingAccount Id. Parameters: billingAccountID - billingAccount ID filter - may be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. expand - may be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. 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 dimension data.

func (BillingAccountDimensionsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (BillingAccountDimensionsClient) ListResponder Uses

func (client BillingAccountDimensionsClient) ListResponder(resp *http.Response) (result DimensionsListResult, err error)

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

func (BillingAccountDimensionsClient) ListSender Uses

func (client BillingAccountDimensionsClient) 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 Dimension Uses

type Dimension struct {
    *DimensionProperties `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"`
}

Dimension ...

func (Dimension) MarshalJSON Uses

func (d Dimension) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Dimension.

func (*Dimension) UnmarshalJSON Uses

func (d *Dimension) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Dimension struct.

type DimensionProperties Uses

type DimensionProperties struct {
    Data       *[]string  `json:"data,omitempty"`
    Total      *int32     `json:"total,omitempty"`
    Category   *string    `json:"category,omitempty"`
    UsageStart *date.Time `json:"usageStart,omitempty"`
    UsageEnd   *date.Time `json:"usageEnd,omitempty"`
    NextLink   *string    `json:"nextLink,omitempty"`
}

DimensionProperties ...

type DimensionsListResult Uses

type DimensionsListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The list of dimensions.
    Value *[]Dimension `json:"value,omitempty"`
}

DimensionsListResult result of listing dimensions. It contains a list of available dimensions.

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

type FormatType string

FormatType enumerates the values for format type.

const (
    // Csv ...
    Csv FormatType = "Csv"
)

func PossibleFormatTypeValues Uses

func PossibleFormatTypeValues() []FormatType

PossibleFormatTypeValues returns an array of possible values for the FormatType const type.

type GranularityType Uses

type GranularityType string

GranularityType enumerates the values for granularity type.

const (
    // Daily ...
    Daily GranularityType = "Daily"
)

func PossibleGranularityTypeValues Uses

func PossibleGranularityTypeValues() []GranularityType

PossibleGranularityTypeValues returns an array of possible values for the GranularityType const type.

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 Cost management REST API operation.

type OperationDisplay Uses

type OperationDisplay struct {
    // Provider - READ-ONLY; Service provider: Microsoft.CostManagement.
    Provider *string `json:"provider,omitempty"`
    // Resource - READ-ONLY; Resource on which the operation is performed: Dimensions, Query.
    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 cost management operations supported by the Microsoft.CostManagement 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 cost management 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 client for the Operations methods of the Costmanagement service.

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

type Query struct {
    *QueryProperties `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"`
}

Query ...

func (Query) MarshalJSON Uses

func (q Query) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Query.

func (*Query) UnmarshalJSON Uses

func (q *Query) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Query struct.

type QueryColumn Uses

type QueryColumn struct {
    Name *string `json:"name,omitempty"`
    Type *string `json:"type,omitempty"`
}

QueryColumn ...

type QueryProperties Uses

type QueryProperties struct {
    NextLink *string `json:"nextLink,omitempty"`
    // Columns - Array of columns
    Columns *[]QueryColumn   `json:"columns,omitempty"`
    Rows    *[][]interface{} `json:"rows,omitempty"`
}

QueryProperties ...

type QueryResult Uses

type QueryResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The list of usage data.
    Value *[]Query `json:"value,omitempty"`
}

QueryResult result of query. It contains all columns listed under groupings and aggregation.

type RecurrenceType Uses

type RecurrenceType string

RecurrenceType enumerates the values for recurrence type.

const (
    // RecurrenceTypeAnnually ...
    RecurrenceTypeAnnually RecurrenceType = "Annually"
    // RecurrenceTypeDaily ...
    RecurrenceTypeDaily RecurrenceType = "Daily"
    // RecurrenceTypeMonthly ...
    RecurrenceTypeMonthly RecurrenceType = "Monthly"
    // RecurrenceTypeWeekly ...
    RecurrenceTypeWeekly RecurrenceType = "Weekly"
)

func PossibleRecurrenceTypeValues Uses

func PossibleRecurrenceTypeValues() []RecurrenceType

PossibleRecurrenceTypeValues returns an array of possible values for the RecurrenceType const type.

type ReportConfig Uses

type ReportConfig struct {
    autorest.Response       `json:"-"`
    *ReportConfigProperties `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"`
}

ReportConfig a report config resource.

func (ReportConfig) MarshalJSON Uses

func (rc ReportConfig) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReportConfig.

func (*ReportConfig) UnmarshalJSON Uses

func (rc *ReportConfig) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ReportConfig struct.

type ReportConfigAggregation Uses

type ReportConfigAggregation struct {
    // Name - The name of the column to aggregate.
    Name *string `json:"name,omitempty"`
    // Function - The name of the aggregation function to use.
    Function *string `json:"function,omitempty"`
}

ReportConfigAggregation the aggregation expression to be used in the report.

type ReportConfigClient Uses

type ReportConfigClient struct {
    BaseClient
}

ReportConfigClient is the client for the ReportConfig methods of the Costmanagement service.

func NewReportConfigClient Uses

func NewReportConfigClient(subscriptionID string) ReportConfigClient

NewReportConfigClient creates an instance of the ReportConfigClient client.

func NewReportConfigClientWithBaseURI Uses

func NewReportConfigClientWithBaseURI(baseURI string, subscriptionID string) ReportConfigClient

NewReportConfigClientWithBaseURI creates an instance of the ReportConfigClient client.

func (ReportConfigClient) CreateOrUpdate Uses

func (client ReportConfigClient) CreateOrUpdate(ctx context.Context, reportConfigName string, parameters ReportConfig) (result ReportConfig, err error)

CreateOrUpdate the operation to create or update a report config. 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: reportConfigName - report Config Name. parameters - parameters supplied to the CreateOrUpdate Report Config operation.

func (ReportConfigClient) CreateOrUpdateByResourceGroupName Uses

func (client ReportConfigClient) CreateOrUpdateByResourceGroupName(ctx context.Context, resourceGroupName string, reportConfigName string, parameters ReportConfig) (result ReportConfig, err error)

CreateOrUpdateByResourceGroupName the operation to create or update a report config. 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. reportConfigName - report Config Name. parameters - parameters supplied to the CreateOrUpdate Report Config operation.

func (ReportConfigClient) CreateOrUpdateByResourceGroupNamePreparer Uses

func (client ReportConfigClient) CreateOrUpdateByResourceGroupNamePreparer(ctx context.Context, resourceGroupName string, reportConfigName string, parameters ReportConfig) (*http.Request, error)

CreateOrUpdateByResourceGroupNamePreparer prepares the CreateOrUpdateByResourceGroupName request.

func (ReportConfigClient) CreateOrUpdateByResourceGroupNameResponder Uses

func (client ReportConfigClient) CreateOrUpdateByResourceGroupNameResponder(resp *http.Response) (result ReportConfig, err error)

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

func (ReportConfigClient) CreateOrUpdateByResourceGroupNameSender Uses

func (client ReportConfigClient) 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 (ReportConfigClient) CreateOrUpdatePreparer Uses

func (client ReportConfigClient) CreateOrUpdatePreparer(ctx context.Context, reportConfigName string, parameters ReportConfig) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ReportConfigClient) CreateOrUpdateResponder Uses

func (client ReportConfigClient) CreateOrUpdateResponder(resp *http.Response) (result ReportConfig, err error)

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

func (ReportConfigClient) CreateOrUpdateSender Uses

func (client ReportConfigClient) 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 (ReportConfigClient) Delete Uses

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

Delete the operation to delete a report. Parameters: reportConfigName - report Config Name.

func (ReportConfigClient) DeleteByResourceGroupName Uses

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

DeleteByResourceGroupName the operation to delete a report config. Parameters: resourceGroupName - azure Resource Group Name. reportConfigName - report Config Name.

func (ReportConfigClient) DeleteByResourceGroupNamePreparer Uses

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

DeleteByResourceGroupNamePreparer prepares the DeleteByResourceGroupName request.

func (ReportConfigClient) DeleteByResourceGroupNameResponder Uses

func (client ReportConfigClient) 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 (ReportConfigClient) DeleteByResourceGroupNameSender Uses

func (client ReportConfigClient) 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 (ReportConfigClient) DeletePreparer Uses

func (client ReportConfigClient) DeletePreparer(ctx context.Context, reportConfigName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ReportConfigClient) DeleteResponder Uses

func (client ReportConfigClient) 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 (ReportConfigClient) DeleteSender Uses

func (client ReportConfigClient) 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 (ReportConfigClient) Get Uses

func (client ReportConfigClient) Get(ctx context.Context, reportConfigName string) (result ReportConfig, err error)

Get gets the report config for a subscription by report config name. Parameters: reportConfigName - report Config Name.

func (ReportConfigClient) GetByResourceGroupName Uses

func (client ReportConfigClient) GetByResourceGroupName(ctx context.Context, resourceGroupName string, reportConfigName string) (result ReportConfig, err error)

GetByResourceGroupName gets the report config for a resource group under a subscription by report config name. Parameters: resourceGroupName - azure Resource Group Name. reportConfigName - report Config Name.

func (ReportConfigClient) GetByResourceGroupNamePreparer Uses

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

GetByResourceGroupNamePreparer prepares the GetByResourceGroupName request.

func (ReportConfigClient) GetByResourceGroupNameResponder Uses

func (client ReportConfigClient) GetByResourceGroupNameResponder(resp *http.Response) (result ReportConfig, err error)

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

func (ReportConfigClient) GetByResourceGroupNameSender Uses

func (client ReportConfigClient) 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 (ReportConfigClient) GetPreparer Uses

func (client ReportConfigClient) GetPreparer(ctx context.Context, reportConfigName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ReportConfigClient) GetResponder Uses

func (client ReportConfigClient) GetResponder(resp *http.Response) (result ReportConfig, err error)

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

func (ReportConfigClient) GetSender Uses

func (client ReportConfigClient) 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 (ReportConfigClient) List Uses

func (client ReportConfigClient) List(ctx context.Context) (result ReportConfigListResult, err error)

List lists all report configs for a subscription.

func (ReportConfigClient) ListByResourceGroupName Uses

func (client ReportConfigClient) ListByResourceGroupName(ctx context.Context, resourceGroupName string) (result ReportConfigListResult, err error)

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

func (ReportConfigClient) ListByResourceGroupNamePreparer Uses

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

ListByResourceGroupNamePreparer prepares the ListByResourceGroupName request.

func (ReportConfigClient) ListByResourceGroupNameResponder Uses

func (client ReportConfigClient) ListByResourceGroupNameResponder(resp *http.Response) (result ReportConfigListResult, err error)

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

func (ReportConfigClient) ListByResourceGroupNameSender Uses

func (client ReportConfigClient) 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 (ReportConfigClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (ReportConfigClient) ListResponder Uses

func (client ReportConfigClient) ListResponder(resp *http.Response) (result ReportConfigListResult, err error)

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

func (ReportConfigClient) ListSender Uses

func (client ReportConfigClient) 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 ReportConfigColumnType Uses

type ReportConfigColumnType string

ReportConfigColumnType enumerates the values for report config column type.

const (
    // ReportConfigColumnTypeDimension ...
    ReportConfigColumnTypeDimension ReportConfigColumnType = "Dimension"
    // ReportConfigColumnTypeTag ...
    ReportConfigColumnTypeTag ReportConfigColumnType = "Tag"
)

func PossibleReportConfigColumnTypeValues Uses

func PossibleReportConfigColumnTypeValues() []ReportConfigColumnType

PossibleReportConfigColumnTypeValues returns an array of possible values for the ReportConfigColumnType const type.

type ReportConfigComparisonExpression Uses

type ReportConfigComparisonExpression struct {
    // Name - The name of the column to use in comparison.
    Name *string `json:"name,omitempty"`
    // Operator - The operator to use for comparison.
    Operator *string `json:"operator,omitempty"`
    // Values - Array of values to use for comparison
    Values *[]string `json:"values,omitempty"`
}

ReportConfigComparisonExpression the comparison expression to be used in the report.

type ReportConfigDataset Uses

type ReportConfigDataset struct {
    // Granularity - The granularity of rows in the report. Possible values include: 'Daily'
    Granularity GranularityType `json:"granularity,omitempty"`
    // Configuration - Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.
    Configuration *ReportConfigDatasetConfiguration `json:"configuration,omitempty"`
    // Aggregation - Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.
    Aggregation map[string]*ReportConfigAggregation `json:"aggregation"`
    // Grouping - Array of group by expression to use in the report. Report can have up to 2 group by clauses.
    Grouping *[]ReportConfigGrouping `json:"grouping,omitempty"`
    // Filter - Has filter expression to use in the report.
    Filter *ReportConfigFilter `json:"filter,omitempty"`
}

ReportConfigDataset the definition of data present in the report.

func (ReportConfigDataset) MarshalJSON Uses

func (rcd ReportConfigDataset) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReportConfigDataset.

type ReportConfigDatasetConfiguration Uses

type ReportConfigDatasetConfiguration struct {
    // Columns - Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.
    Columns *[]string `json:"columns,omitempty"`
}

ReportConfigDatasetConfiguration the configuration of dataset in the report.

type ReportConfigDefinition Uses

type ReportConfigDefinition struct {
    // Type - The type of the report.
    Type *string `json:"type,omitempty"`
    // Timeframe - The time frame for pulling data for the report. If custom, then a specific time period must be provided. Possible values include: 'WeekToDate', 'MonthToDate', 'YearToDate', 'Custom'
    Timeframe TimeframeType `json:"timeframe,omitempty"`
    // TimePeriod - Has time period for pulling data for the report.
    TimePeriod *ReportConfigTimePeriod `json:"timePeriod,omitempty"`
    // Dataset - Has definition for data in this report config.
    Dataset *ReportConfigDataset `json:"dataset,omitempty"`
}

ReportConfigDefinition the definition of a report config.

type ReportConfigDeliveryDestination Uses

type ReportConfigDeliveryDestination struct {
    // ResourceID - The resource id of the storage account where reports will be delivered.
    ResourceID *string `json:"resourceId,omitempty"`
    // Container - The name of the container where reports will be uploaded.
    Container *string `json:"container,omitempty"`
    // RootFolderPath - The name of the directory where reports will be uploaded.
    RootFolderPath *string `json:"rootFolderPath,omitempty"`
}

ReportConfigDeliveryDestination the destination information for the delivery of the report.

type ReportConfigDeliveryInfo Uses

type ReportConfigDeliveryInfo struct {
    // Destination - Has destination for the report being delivered.
    Destination *ReportConfigDeliveryDestination `json:"destination,omitempty"`
}

ReportConfigDeliveryInfo the delivery information associated with a report config.

type ReportConfigFilter Uses

type ReportConfigFilter struct {
    // And - The logical "AND" expression. Must have at least 2 items.
    And *[]ReportConfigFilter `json:"and,omitempty"`
    // Or - The logical "OR" expression. Must have at least 2 items.
    Or  *[]ReportConfigFilter `json:"or,omitempty"`
    // Not - The logical "NOT" expression.
    Not *ReportConfigFilter `json:"not,omitempty"`
    // Dimension - Has comparison expression for a dimension
    Dimension *ReportConfigComparisonExpression `json:"dimension,omitempty"`
    // Tag - Has comparison expression for a tag
    Tag *ReportConfigComparisonExpression `json:"tag,omitempty"`
}

ReportConfigFilter the filter expression to be used in the report.

type ReportConfigGrouping Uses

type ReportConfigGrouping struct {
    // ColumnType - Has type of the column to group. Possible values include: 'ReportConfigColumnTypeTag', 'ReportConfigColumnTypeDimension'
    ColumnType ReportConfigColumnType `json:"columnType,omitempty"`
    // Name - The name of the column to group.
    Name *string `json:"name,omitempty"`
}

ReportConfigGrouping the group by expression to be used in the report.

type ReportConfigListResult Uses

type ReportConfigListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The list of report configs.
    Value *[]ReportConfig `json:"value,omitempty"`
}

ReportConfigListResult result of listing report configs. It contains a list of available report configurations in the scope provided.

type ReportConfigProperties Uses

type ReportConfigProperties struct {
    // Schedule - Has schedule information for the report config.
    Schedule *ReportConfigSchedule `json:"schedule,omitempty"`
    // Format - The format of the report being delivered. Possible values include: 'Csv'
    Format FormatType `json:"format,omitempty"`
    // DeliveryInfo - Has delivery information for the report config.
    DeliveryInfo *ReportConfigDeliveryInfo `json:"deliveryInfo,omitempty"`
    // Definition - Has definition for the report config.
    Definition *ReportConfigDefinition `json:"definition,omitempty"`
}

ReportConfigProperties the properties of the report config.

type ReportConfigRecurrencePeriod Uses

type ReportConfigRecurrencePeriod struct {
    // From - The start date of recurrence.
    From *date.Time `json:"from,omitempty"`
    // To - The end date of recurrence. If not provided, we default this to 10 years from the start date.
    To  *date.Time `json:"to,omitempty"`
}

ReportConfigRecurrencePeriod the start and end date for recurrence schedule.

type ReportConfigSchedule Uses

type ReportConfigSchedule struct {
    // Status - The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. Possible values include: 'Active', 'Inactive'
    Status StatusType `json:"status,omitempty"`
    // Recurrence - The schedule recurrence. Possible values include: 'RecurrenceTypeDaily', 'RecurrenceTypeWeekly', 'RecurrenceTypeMonthly', 'RecurrenceTypeAnnually'
    Recurrence RecurrenceType `json:"recurrence,omitempty"`
    // RecurrencePeriod - Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.
    RecurrencePeriod *ReportConfigRecurrencePeriod `json:"recurrencePeriod,omitempty"`
}

ReportConfigSchedule the schedule associated with a report config.

type ReportConfigTimePeriod Uses

type ReportConfigTimePeriod struct {
    // From - The start date to pull data from.
    From *date.Time `json:"from,omitempty"`
    // To - The end date to pull data to.
    To  *date.Time `json:"to,omitempty"`
}

ReportConfigTimePeriod the start and end date for pulling data for the report.

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

type ResourceGroupDimensionsClient struct {
    BaseClient
}

ResourceGroupDimensionsClient is the client for the ResourceGroupDimensions methods of the Costmanagement service.

func NewResourceGroupDimensionsClient Uses

func NewResourceGroupDimensionsClient(subscriptionID string) ResourceGroupDimensionsClient

NewResourceGroupDimensionsClient creates an instance of the ResourceGroupDimensionsClient client.

func NewResourceGroupDimensionsClientWithBaseURI Uses

func NewResourceGroupDimensionsClientWithBaseURI(baseURI string, subscriptionID string) ResourceGroupDimensionsClient

NewResourceGroupDimensionsClientWithBaseURI creates an instance of the ResourceGroupDimensionsClient client.

func (ResourceGroupDimensionsClient) List Uses

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

List lists the dimensions by resource group Id. Parameters: resourceGroupName - azure Resource Group Name. filter - may be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. expand - may be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. 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 dimension data.

func (ResourceGroupDimensionsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (ResourceGroupDimensionsClient) ListResponder Uses

func (client ResourceGroupDimensionsClient) ListResponder(resp *http.Response) (result DimensionsListResult, err error)

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

func (ResourceGroupDimensionsClient) ListSender Uses

func (client ResourceGroupDimensionsClient) 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 StatusType Uses

type StatusType string

StatusType enumerates the values for status type.

const (
    // Active ...
    Active StatusType = "Active"
    // Inactive ...
    Inactive StatusType = "Inactive"
)

func PossibleStatusTypeValues Uses

func PossibleStatusTypeValues() []StatusType

PossibleStatusTypeValues returns an array of possible values for the StatusType const type.

type SubscriptionDimensionsClient Uses

type SubscriptionDimensionsClient struct {
    BaseClient
}

SubscriptionDimensionsClient is the client for the SubscriptionDimensions methods of the Costmanagement service.

func NewSubscriptionDimensionsClient Uses

func NewSubscriptionDimensionsClient(subscriptionID string) SubscriptionDimensionsClient

NewSubscriptionDimensionsClient creates an instance of the SubscriptionDimensionsClient client.

func NewSubscriptionDimensionsClientWithBaseURI Uses

func NewSubscriptionDimensionsClientWithBaseURI(baseURI string, subscriptionID string) SubscriptionDimensionsClient

NewSubscriptionDimensionsClientWithBaseURI creates an instance of the SubscriptionDimensionsClient client.

func (SubscriptionDimensionsClient) List Uses

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

List lists the dimensions by subscription Id. Parameters: filter - may be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. expand - may be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. 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 dimension data.

func (SubscriptionDimensionsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (SubscriptionDimensionsClient) ListResponder Uses

func (client SubscriptionDimensionsClient) ListResponder(resp *http.Response) (result DimensionsListResult, err error)

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

func (SubscriptionDimensionsClient) ListSender Uses

func (client SubscriptionDimensionsClient) 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 TimeframeType Uses

type TimeframeType string

TimeframeType enumerates the values for timeframe type.

const (
    // Custom ...
    Custom TimeframeType = "Custom"
    // MonthToDate ...
    MonthToDate TimeframeType = "MonthToDate"
    // WeekToDate ...
    WeekToDate TimeframeType = "WeekToDate"
    // YearToDate ...
    YearToDate TimeframeType = "YearToDate"
)

func PossibleTimeframeTypeValues Uses

func PossibleTimeframeTypeValues() []TimeframeType

PossibleTimeframeTypeValues returns an array of possible values for the TimeframeType const type.

Directories

PathSynopsis
costmanagementapi

Package costmanagement imports 10 packages (graph) and is imported by 4 packages. Updated 2019-07-30. Refresh now. Tools for package owners.