sdk

Documentation

Index

• Constants
• type Client
  • func NewClient(moduleName, moduleVersion string, options *ClientOptions) (*Client, error)
  • func (c *Client) Endpoint() string
  • func (c *Client) Pipeline() runtime.Pipeline
  • func (c *Client) Tracer() tracing.Tracer
• type ClientOptions
• type ISO8601Time
  • func (t *ISO8601Time) MarshalJSON() ([]byte, error)
  • func (t *ISO8601Time) UnmarshalJSON(b []byte) error
• type ResourceSKU
• type RetailPricesClient
  • func NewRetailPricesClient(options *arm.ClientOptions) (*RetailPricesClient, error)
  • func (client *RetailPricesClient) NewListPager(options *RetailPricesClientListOptions) *runtime.Pager[RetailPricesClientListResponse]
• type RetailPricesClientListOptions
• type RetailPricesClientListResponse
• type RetailPricesResult
• type SavingsPlan

Constants

const (
	UTCFormat       = "\"2006-01-02T15:04:05\""
	UTCSuffixFormat = "\"2006-01-02T15:04:05Z\""
	NonUTCFormat    = "\"2006-01-02T15:04:05-0700\""
)

Types

type Client

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

Client is a HTTP client for use with ARM endpoints. It consists of an endpoint, pipeline, and tracing provider.

func NewClient

func NewClient(moduleName, moduleVersion string, options *ClientOptions) (*Client, error)

NewClient creates a new Client instance with the provided values. This client is intended to be used with Azure Resource Manager endpoints.

• moduleName - the fully qualified name of the module where the client is defined; used by the telemetry policy and tracing provider.
• moduleVersion - the semantic version of the module; used by the telemetry policy and tracing provider.
• cred - the TokenCredential used to authenticate the request
• options - optional client configurations; pass nil to accept the default values

func (*Client) Endpoint

func (c *Client) Endpoint() string

Endpoint returns the service's base URL for this client.

func (*Client) Pipeline

func (c *Client) Pipeline() runtime.Pipeline

Pipeline returns the pipeline for this client.

func (*Client) Tracer

func (c *Client) Tracer() tracing.Tracer

Tracer returns the tracer for this client.

type ClientOptions

type ClientOptions = armpolicy.ClientOptions

ClientOptions contains configuration settings for a client's pipeline.

type ISO8601Time

type ISO8601Time struct {
	time.Time
}

func (*ISO8601Time) MarshalJSON

func (t *ISO8601Time) MarshalJSON() ([]byte, error)

func (*ISO8601Time) UnmarshalJSON

func (t *ISO8601Time) UnmarshalJSON(b []byte) error

type ResourceSKU

type ResourceSKU struct {
	CurrencyCode         string        `json:"currencyCode"`
	TierMinimumUnits     float64       `json:"tierMinimumUnits"`
	RetailPrice          float64       `json:"retailPrice"`
	UnitPrice            float64       `json:"unitPrice"`
	ArmRegionName        string        `json:"armRegionName"`
	Location             string        `json:"location"`
	EffectiveStartDate   ISO8601Time   `json:"effectiveStartDate"`
	MeterID              string        `json:"meterId"`
	MeterName            string        `json:"meterName"`
	ProductID            string        `json:"productId"`
	SkuID                string        `json:"skuId"`
	ProductName          string        `json:"productName"`
	SkuName              string        `json:"skuName"`
	ServiceName          string        `json:"serviceName"`
	ServiceID            string        `json:"serviceId"`
	ServiceFamily        string        `json:"serviceFamily"`
	UnitOfMeasure        string        `json:"unitOfMeasure"`
	Type                 string        `json:"type"`
	IsPrimaryMeterRegion bool          `json:"isPrimaryMeterRegion"`
	ArmSkuName           string        `json:"armSkuName"`
	ReservationTerm      string        `json:"reservationTerm,omitempty"`
	SavingsPlan          []SavingsPlan `json:"savingsPlan,omitempty"`
	EffectiveEndDate     ISO8601Time   `json:"effectiveEndDate,omitempty"`
}

type RetailPricesClient

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

RetailPricesClient contains the methods for the RetailPrices group. Don't use this type directly, use NewRetailPricesClient() instead.

func NewRetailPricesClient

func NewRetailPricesClient(options *arm.ClientOptions) (*RetailPricesClient, error)

NewRetailPricesClient creates a new instance of RetailPricesClient with the specified values.

• subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
• credential - used to authorize requests. Usually a credential from azidentity.
• options - pass nil to accept the default values.

func (*RetailPricesClient) NewListPager

func (client *RetailPricesClient) NewListPager(options *RetailPricesClientListOptions) *runtime.Pager[RetailPricesClientListResponse]

NewListPager - Gets the list of Microsoft.Compute SKUs available for your Subscription.

Generated from API version 2021-07-01

• options - RetailPricesClientListOptions contains the optional parameters for the RetailPricesClient.NewListPager method.

type RetailPricesClientListOptions

type RetailPricesClientListOptions struct {
	// Filters are supported for the following fields:
	// - armRegionName
	// - Location
	// - meterId
	// - meterName
	// - productid
	// - skuId
	// - productName
	// - skuName
	// - serviceName
	// - serviceId
	// - serviceFamily
	// - priceType
	// - armSkuName
	Filter       *string
	APIVersion   *string
	MeterRegion  *string
	CurrencyCode *string
}

RetailPricesClientListOptions contains the optional parameters for the RetailPricesClient.NewListPager method.

type RetailPricesClientListResponse

type RetailPricesClientListResponse struct {
	// The List Retail Prices operation response.
	RetailPricesResult
}

RetailPricesClientListResponse contains the response from method RetailPricesClient.NewListPager.

type RetailPricesResult

type RetailPricesResult struct {
	BillingCurrency    string        `json:"BillingCurrency"`
	CustomerEntityID   string        `json:"CustomerEntityId"`
	CustomerEntityType string        `json:"CustomerEntityType"`
	Items              []ResourceSKU `json:"Items"`
	Count              int           `json:"Count"`

	// The URI to fetch the next page of Retail Prices. Call ListNext() with this URI to fetch the next page of Retail Prices
	NextLink *string `json:"NextPageLink"`
}

RetailPricesResult - The List Retail Prices operation response.

type SavingsPlan

type SavingsPlan struct {
	UnitPrice   float64 `json:"unitPrice"`
	RetailPrice float64 `json:"retailPrice"`
	Term        string  `json:"term"`
}