dimensions

README

github.com/hashicorp/go-azure-sdk/resource-manager/costmanagement/2023-08-01/dimensions Documentation

The dimensions SDK allows for interaction with Azure Resource Manager costmanagement (API Version 2023-08-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-08-01/dimensions"

Client Initialization

client := dimensions.NewDimensionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DimensionsClient.ByExternalCloudProviderType

ctx := context.TODO()
id := dimensions.NewExternalCloudProviderTypeID("externalBillingAccounts", "externalCloudProviderId")

read, err := client.ByExternalCloudProviderType(ctx, id, dimensions.DefaultByExternalCloudProviderTypeOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DimensionsClient.List

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

read, err := client.List(ctx, id, dimensions.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForExternalCloudProviderType() []string
• func ValidateExternalCloudProviderTypeID(input interface{}, key string) (warnings []string, errors []error)
• type ByExternalCloudProviderTypeOperationOptions
  • func DefaultByExternalCloudProviderTypeOperationOptions() ByExternalCloudProviderTypeOperationOptions
  • func (o ByExternalCloudProviderTypeOperationOptions) ToHeaders() *client.Headers
  • func (o ByExternalCloudProviderTypeOperationOptions) ToOData() *odata.Query
  • func (o ByExternalCloudProviderTypeOperationOptions) ToQuery() *client.QueryParams
• type ByExternalCloudProviderTypeOperationResponse
• type Dimension
• type DimensionProperties
  • func (o *DimensionProperties) GetUsageEndAsTime() (*time.Time, error)
  • func (o *DimensionProperties) GetUsageStartAsTime() (*time.Time, error)
  • func (o *DimensionProperties) SetUsageEndAsTime(input time.Time)
  • func (o *DimensionProperties) SetUsageStartAsTime(input time.Time)
• type DimensionsClient
  • func NewDimensionsClientWithBaseURI(sdkApi sdkEnv.Api) (*DimensionsClient, error)
  • func (c DimensionsClient) ByExternalCloudProviderType(ctx context.Context, id ExternalCloudProviderTypeId, ...) (result ByExternalCloudProviderTypeOperationResponse, err error)
  • func (c DimensionsClient) List(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (result ListOperationResponse, err error)
• type DimensionsListResult
• type ExternalCloudProviderType
  • func (s *ExternalCloudProviderType) UnmarshalJSON(bytes []byte) error
• type ExternalCloudProviderTypeId
  • func NewExternalCloudProviderTypeID(externalCloudProviderType ExternalCloudProviderType, ...) ExternalCloudProviderTypeId
  • func ParseExternalCloudProviderTypeID(input string) (*ExternalCloudProviderTypeId, error)
  • func ParseExternalCloudProviderTypeIDInsensitively(input string) (*ExternalCloudProviderTypeId, error)
  • func (id *ExternalCloudProviderTypeId) FromParseResult(input resourceids.ParseResult) error
  • func (id ExternalCloudProviderTypeId) ID() string
  • func (id ExternalCloudProviderTypeId) Segments() []resourceids.Segment
  • func (id ExternalCloudProviderTypeId) String() string
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse

Functions

func PossibleValuesForExternalCloudProviderType

func PossibleValuesForExternalCloudProviderType() []string

func ValidateExternalCloudProviderTypeID

func ValidateExternalCloudProviderTypeID(input interface{}, key string) (warnings []string, errors []error)

ValidateExternalCloudProviderTypeID checks that 'input' can be parsed as a External Cloud Provider Type ID

Types

type ByExternalCloudProviderTypeOperationOptions

type ByExternalCloudProviderTypeOperationOptions struct {
	Expand *string
	Filter *string
	Top    *int64
}

func DefaultByExternalCloudProviderTypeOperationOptions

func DefaultByExternalCloudProviderTypeOperationOptions() ByExternalCloudProviderTypeOperationOptions

func (ByExternalCloudProviderTypeOperationOptions) ToHeaders

func (o ByExternalCloudProviderTypeOperationOptions) ToHeaders() *client.Headers

func (ByExternalCloudProviderTypeOperationOptions) ToOData

func (o ByExternalCloudProviderTypeOperationOptions) ToOData() *odata.Query

func (ByExternalCloudProviderTypeOperationOptions) ToQuery

func (o ByExternalCloudProviderTypeOperationOptions) ToQuery() *client.QueryParams

type ByExternalCloudProviderTypeOperationResponse

type ByExternalCloudProviderTypeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DimensionsListResult
}

type Dimension

type Dimension struct {
	ETag       *string              `json:"eTag,omitempty"`
	Id         *string              `json:"id,omitempty"`
	Location   *string              `json:"location,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *DimensionProperties `json:"properties,omitempty"`
	Sku        *string              `json:"sku,omitempty"`
	Tags       *map[string]string   `json:"tags,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type DimensionProperties

type DimensionProperties struct {
	Category        *string   `json:"category,omitempty"`
	Data            *[]string `json:"data,omitempty"`
	Description     *string   `json:"description,omitempty"`
	FilterEnabled   *bool     `json:"filterEnabled,omitempty"`
	GroupingEnabled *bool     `json:"groupingEnabled,omitempty"`
	NextLink        *string   `json:"nextLink,omitempty"`
	Total           *int64    `json:"total,omitempty"`
	UsageEnd        *string   `json:"usageEnd,omitempty"`
	UsageStart      *string   `json:"usageStart,omitempty"`
}

func (*DimensionProperties) GetUsageEndAsTime

func (o *DimensionProperties) GetUsageEndAsTime() (*time.Time, error)

func (*DimensionProperties) GetUsageStartAsTime

func (o *DimensionProperties) GetUsageStartAsTime() (*time.Time, error)

func (*DimensionProperties) SetUsageEndAsTime

func (o *DimensionProperties) SetUsageEndAsTime(input time.Time)

func (*DimensionProperties) SetUsageStartAsTime

func (o *DimensionProperties) SetUsageStartAsTime(input time.Time)

type DimensionsClient

type DimensionsClient struct {
	Client *resourcemanager.Client
}

func NewDimensionsClientWithBaseURI

func NewDimensionsClientWithBaseURI(sdkApi sdkEnv.Api) (*DimensionsClient, error)

func (DimensionsClient) ByExternalCloudProviderType

func (c DimensionsClient) ByExternalCloudProviderType(ctx context.Context, id ExternalCloudProviderTypeId, options ByExternalCloudProviderTypeOperationOptions) (result ByExternalCloudProviderTypeOperationResponse, err error)

ByExternalCloudProviderType ...

func (DimensionsClient) List

func (c DimensionsClient) List(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

type DimensionsListResult

type DimensionsListResult struct {
	Value *[]Dimension `json:"value,omitempty"`
}

type ExternalCloudProviderType

type ExternalCloudProviderType string

const (
	ExternalCloudProviderTypeExternalBillingAccounts ExternalCloudProviderType = "externalBillingAccounts"
	ExternalCloudProviderTypeExternalSubscriptions   ExternalCloudProviderType = "externalSubscriptions"
)

func (*ExternalCloudProviderType) UnmarshalJSON

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

type ExternalCloudProviderTypeId

type ExternalCloudProviderTypeId struct {
	ExternalCloudProviderType ExternalCloudProviderType
	ExternalCloudProviderId   string
}

ExternalCloudProviderTypeId is a struct representing the Resource ID for a External Cloud Provider Type

func NewExternalCloudProviderTypeID

func NewExternalCloudProviderTypeID(externalCloudProviderType ExternalCloudProviderType, externalCloudProviderId string) ExternalCloudProviderTypeId

NewExternalCloudProviderTypeID returns a new ExternalCloudProviderTypeId struct

func ParseExternalCloudProviderTypeID

func ParseExternalCloudProviderTypeID(input string) (*ExternalCloudProviderTypeId, error)

ParseExternalCloudProviderTypeID parses 'input' into a ExternalCloudProviderTypeId

func ParseExternalCloudProviderTypeIDInsensitively

func ParseExternalCloudProviderTypeIDInsensitively(input string) (*ExternalCloudProviderTypeId, error)

ParseExternalCloudProviderTypeIDInsensitively parses 'input' case-insensitively into a ExternalCloudProviderTypeId note: this method should only be used for API response data and not user input

func (*ExternalCloudProviderTypeId) FromParseResult

func (id *ExternalCloudProviderTypeId) FromParseResult(input resourceids.ParseResult) error

func (ExternalCloudProviderTypeId) ID

func (id ExternalCloudProviderTypeId) ID() string

ID returns the formatted External Cloud Provider Type ID

func (ExternalCloudProviderTypeId) Segments

func (id ExternalCloudProviderTypeId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this External Cloud Provider Type ID

func (ExternalCloudProviderTypeId) String

func (id ExternalCloudProviderTypeId) String() string

String returns a human-readable description of this External Cloud Provider Type ID

type ListOperationOptions

type ListOperationOptions struct {
	Expand *string
	Filter *string
	Top    *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DimensionsListResult
}