Documentation
¶
Overview ¶
Package skus implements the Azure ARM Skus service API version 2017-09-01.
Compute Client
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type ResourceSku
- type ResourceSkuCapabilities
- type ResourceSkuCapacity
- type ResourceSkuCapacityScaleType
- type ResourceSkuCosts
- type ResourceSkuLocationInfo
- type ResourceSkuRestrictionInfo
- type ResourceSkuRestrictions
- type ResourceSkuRestrictionsReasonCode
- type ResourceSkuRestrictionsType
- type ResourceSkusClient
- func (client ResourceSkusClient) List(ctx context.Context) (result ResourceSkusResultPage, err error)
- func (client ResourceSkusClient) ListComplete(ctx context.Context) (result ResourceSkusResultIterator, err error)
- func (client ResourceSkusClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client ResourceSkusClient) ListResponder(resp *http.Response) (result ResourceSkusResult, err error)
- func (client ResourceSkusClient) ListSender(req *http.Request) (*http.Response, error)
- type ResourceSkusResult
- type ResourceSkusResultIterator
- type ResourceSkusResultPage
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Skus
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type BaseClient ¶
BaseClient is the base client for Skus.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type ResourceSku ¶
type ResourceSku struct {
// ResourceType - The type of resource the SKU applies to.
ResourceType *string `json:"resourceType,omitempty"`
// Name - The name of SKU.
Name *string `json:"name,omitempty"`
// Tier - Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic**
Tier *string `json:"tier,omitempty"`
// Size - The Size of the SKU.
Size *string `json:"size,omitempty"`
// Family - The Family of this particular SKU.
Family *string `json:"family,omitempty"`
// Kind - The Kind of resources that are supported in this SKU.
Kind *string `json:"kind,omitempty"`
// Capacity - Specifies the number of virtual machines in the scale set.
Capacity *ResourceSkuCapacity `json:"capacity,omitempty"`
// Locations - The set of locations that the SKU is available.
Locations *[]string `json:"locations,omitempty"`
// LocationInfo - A list of locations and availability zones in those locations where the SKU is available.
LocationInfo *[]ResourceSkuLocationInfo `json:"locationInfo,omitempty"`
// APIVersions - The api versions that support this SKU.
APIVersions *[]string `json:"apiVersions,omitempty"`
// Costs - Metadata for retrieving price info.
Costs *[]ResourceSkuCosts `json:"costs,omitempty"`
// Capabilities - A name value pair to describe the capability.
Capabilities *[]ResourceSkuCapabilities `json:"capabilities,omitempty"`
// Restrictions - The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
Restrictions *[]ResourceSkuRestrictions `json:"restrictions,omitempty"`
}
ResourceSku describes an available Compute SKU.
type ResourceSkuCapabilities ¶
type ResourceSkuCapabilities struct {
// Name - An invariant to describe the feature.
Name *string `json:"name,omitempty"`
// Value - An invariant if the feature is measured by quantity.
Value *string `json:"value,omitempty"`
}
ResourceSkuCapabilities describes The SKU capabilites object.
type ResourceSkuCapacity ¶
type ResourceSkuCapacity struct {
// Minimum - The minimum capacity.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - The maximum capacity that can be set.
Maximum *int64 `json:"maximum,omitempty"`
// Default - The default capacity.
Default *int64 `json:"default,omitempty"`
// ScaleType - The scale type applicable to the sku. Possible values include: 'Automatic', 'Manual', 'None'
ScaleType ResourceSkuCapacityScaleType `json:"scaleType,omitempty"`
}
ResourceSkuCapacity describes scaling information of a SKU.
type ResourceSkuCapacityScaleType ¶
type ResourceSkuCapacityScaleType string
ResourceSkuCapacityScaleType enumerates the values for resource sku capacity scale type.
const ( // Automatic ... Automatic ResourceSkuCapacityScaleType = "Automatic" // Manual ... Manual ResourceSkuCapacityScaleType = "Manual" // None ... None ResourceSkuCapacityScaleType = "None" )
func PossibleResourceSkuCapacityScaleTypeValues ¶
func PossibleResourceSkuCapacityScaleTypeValues() []ResourceSkuCapacityScaleType
PossibleResourceSkuCapacityScaleTypeValues returns an array of possible values for the ResourceSkuCapacityScaleType const type.
type ResourceSkuCosts ¶
type ResourceSkuCosts struct {
// MeterID - Used for querying price from commerce.
MeterID *string `json:"meterID,omitempty"`
// Quantity - The multiplier is needed to extend the base metered cost.
Quantity *int64 `json:"quantity,omitempty"`
// ExtendedUnit - An invariant to show the extended unit.
ExtendedUnit *string `json:"extendedUnit,omitempty"`
}
ResourceSkuCosts describes metadata for retrieving price info.
type ResourceSkuLocationInfo ¶
type ResourceSkuLocationInfo struct {
// Location - Location of the SKU
Location *string `json:"location,omitempty"`
// Zones - List of availability zones where the SKU is supported.
Zones *[]string `json:"zones,omitempty"`
}
ResourceSkuLocationInfo ...
type ResourceSkuRestrictionInfo ¶
type ResourceSkuRestrictionInfo struct {
// Locations - Locations where the SKU is restricted
Locations *[]string `json:"locations,omitempty"`
// Zones - List of availability zones where the SKU is restricted.
Zones *[]string `json:"zones,omitempty"`
}
ResourceSkuRestrictionInfo ...
type ResourceSkuRestrictions ¶
type ResourceSkuRestrictions struct {
// Type - The type of restrictions. Possible values include: 'Location', 'Zone'
Type ResourceSkuRestrictionsType `json:"type,omitempty"`
// Values - The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
Values *[]string `json:"values,omitempty"`
// RestrictionInfo - The information about the restriction where the SKU cannot be used.
RestrictionInfo *ResourceSkuRestrictionInfo `json:"restrictionInfo,omitempty"`
// ReasonCode - The reason for restriction. Possible values include: 'QuotaID', 'NotAvailableForSubscription'
ReasonCode ResourceSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
}
ResourceSkuRestrictions describes scaling information of a SKU.
type ResourceSkuRestrictionsReasonCode ¶
type ResourceSkuRestrictionsReasonCode string
ResourceSkuRestrictionsReasonCode enumerates the values for resource sku restrictions reason code.
const ( // NotAvailableForSubscription ... NotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription" // QuotaID ... QuotaID ResourceSkuRestrictionsReasonCode = "QuotaId" )
func PossibleResourceSkuRestrictionsReasonCodeValues ¶
func PossibleResourceSkuRestrictionsReasonCodeValues() []ResourceSkuRestrictionsReasonCode
PossibleResourceSkuRestrictionsReasonCodeValues returns an array of possible values for the ResourceSkuRestrictionsReasonCode const type.
type ResourceSkuRestrictionsType ¶
type ResourceSkuRestrictionsType string
ResourceSkuRestrictionsType enumerates the values for resource sku restrictions type.
const ( // Location ... Location ResourceSkuRestrictionsType = "Location" // Zone ... Zone ResourceSkuRestrictionsType = "Zone" )
func PossibleResourceSkuRestrictionsTypeValues ¶
func PossibleResourceSkuRestrictionsTypeValues() []ResourceSkuRestrictionsType
PossibleResourceSkuRestrictionsTypeValues returns an array of possible values for the ResourceSkuRestrictionsType const type.
type ResourceSkusClient ¶
type ResourceSkusClient struct {
BaseClient
}
ResourceSkusClient is the compute Client
func NewResourceSkusClient ¶
func NewResourceSkusClient(subscriptionID string) ResourceSkusClient
NewResourceSkusClient creates an instance of the ResourceSkusClient client.
func NewResourceSkusClientWithBaseURI ¶
func NewResourceSkusClientWithBaseURI(baseURI string, subscriptionID string) ResourceSkusClient
NewResourceSkusClientWithBaseURI creates an instance of the ResourceSkusClient client.
func (ResourceSkusClient) List ¶
func (client ResourceSkusClient) List(ctx context.Context) (result ResourceSkusResultPage, err error)
List gets the list of Microsoft.Compute SKUs available for your Subscription.
func (ResourceSkusClient) ListComplete ¶
func (client ResourceSkusClient) ListComplete(ctx context.Context) (result ResourceSkusResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (ResourceSkusClient) ListPreparer ¶
ListPreparer prepares the List request.
func (ResourceSkusClient) ListResponder ¶
func (client ResourceSkusClient) ListResponder(resp *http.Response) (result ResourceSkusResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (ResourceSkusClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ResourceSkusResult ¶
type ResourceSkusResult struct {
autorest.Response `json:"-"`
// Value - The list of skus available for the subscription.
Value *[]ResourceSku `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Compute Skus. Call ListNext() with this to fetch the next page of VMSS Skus.
NextLink *string `json:"nextLink,omitempty"`
}
ResourceSkusResult the Compute List Skus operation response.
func (ResourceSkusResult) IsEmpty ¶
func (rsr ResourceSkusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ResourceSkusResultIterator ¶
type ResourceSkusResultIterator struct {
// contains filtered or unexported fields
}
ResourceSkusResultIterator provides access to a complete listing of ResourceSku values.
func (*ResourceSkusResultIterator) Next ¶
func (iter *ResourceSkusResultIterator) 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.
func (ResourceSkusResultIterator) NotDone ¶
func (iter ResourceSkusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ResourceSkusResultIterator) Response ¶
func (iter ResourceSkusResultIterator) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (ResourceSkusResultIterator) Value ¶
func (iter ResourceSkusResultIterator) Value() ResourceSku
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ResourceSkusResultPage ¶
type ResourceSkusResultPage struct {
// contains filtered or unexported fields
}
ResourceSkusResultPage contains a page of ResourceSku values.
func (*ResourceSkusResultPage) Next ¶
func (page *ResourceSkusResultPage) 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.
func (ResourceSkusResultPage) NotDone ¶
func (page ResourceSkusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ResourceSkusResultPage) Response ¶
func (page ResourceSkusResultPage) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (ResourceSkusResultPage) Values ¶
func (page ResourceSkusResultPage) Values() []ResourceSku
Values returns the slice of values for the current page or nil if there are no values.