projectskus

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2025-02-01/projectskus Documentation

The projectskus SDK allows for interaction with Azure Resource Manager devcenter (API Version 2025-02-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-sdk/resource-manager/devcenter/2025-02-01/projectskus"

Client Initialization

client := projectskus.NewProjectSKUsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProjectSKUsClient.SkusListByProject

ctx := context.TODO()
id := projectskus.NewProjectID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectName")

// alternatively `client.SkusListByProject(ctx, id)` can be used to do batched pagination
items, err := client.SkusListByProjectComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForSkuTier() []string
• func ValidateProjectID(input interface{}, key string) (warnings []string, errors []error)
• type Capability
• type DevCenterSku
• type DevCenterSkuOperationPredicate
  • func (p DevCenterSkuOperationPredicate) Matches(input DevCenterSku) bool
• type ProjectId
  • func NewProjectID(subscriptionId string, resourceGroupName string, projectName string) ProjectId
  • func ParseProjectID(input string) (*ProjectId, error)
  • func ParseProjectIDInsensitively(input string) (*ProjectId, error)
  • func (id *ProjectId) FromParseResult(input resourceids.ParseResult) error
  • func (id ProjectId) ID() string
  • func (id ProjectId) Segments() []resourceids.Segment
  • func (id ProjectId) String() string
• type ProjectSKUsClient
  • func NewProjectSKUsClientWithBaseURI(sdkApi sdkEnv.Api) (*ProjectSKUsClient, error)
  • func (c ProjectSKUsClient) SkusListByProject(ctx context.Context, id ProjectId) (result SkusListByProjectOperationResponse, err error)
  • func (c ProjectSKUsClient) SkusListByProjectComplete(ctx context.Context, id ProjectId) (SkusListByProjectCompleteResult, error)
  • func (c ProjectSKUsClient) SkusListByProjectCompleteMatchingPredicate(ctx context.Context, id ProjectId, predicate DevCenterSkuOperationPredicate) (result SkusListByProjectCompleteResult, err error)
• type SkuTier
  • func (s *SkuTier) UnmarshalJSON(bytes []byte) error
• type SkusListByProjectCompleteResult
• type SkusListByProjectCustomPager
  • func (p *SkusListByProjectCustomPager) NextPageLink() *odata.Link
• type SkusListByProjectOperationResponse

Functions

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

func ValidateProjectID

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

ValidateProjectID checks that 'input' can be parsed as a Project ID

Types

type Capability

type Capability struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type DevCenterSku

type DevCenterSku struct {
	Capabilities *[]Capability `json:"capabilities,omitempty"`
	Capacity     *int64        `json:"capacity,omitempty"`
	Family       *string       `json:"family,omitempty"`
	Locations    *[]string     `json:"locations,omitempty"`
	Name         string        `json:"name"`
	ResourceType *string       `json:"resourceType,omitempty"`
	Size         *string       `json:"size,omitempty"`
	Tier         *SkuTier      `json:"tier,omitempty"`
}

type DevCenterSkuOperationPredicate

type DevCenterSkuOperationPredicate struct {
	Capacity     *int64
	Family       *string
	Name         *string
	ResourceType *string
	Size         *string
}

func (DevCenterSkuOperationPredicate) Matches

func (p DevCenterSkuOperationPredicate) Matches(input DevCenterSku) bool

type ProjectId

type ProjectId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProjectName       string
}

ProjectId is a struct representing the Resource ID for a Project

func NewProjectID

func NewProjectID(subscriptionId string, resourceGroupName string, projectName string) ProjectId

NewProjectID returns a new ProjectId struct

func ParseProjectID

func ParseProjectID(input string) (*ProjectId, error)

ParseProjectID parses 'input' into a ProjectId

func ParseProjectIDInsensitively

func ParseProjectIDInsensitively(input string) (*ProjectId, error)

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

func (*ProjectId) FromParseResult

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

func (ProjectId) ID

func (id ProjectId) ID() string

ID returns the formatted Project ID

func (ProjectId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Project ID

func (ProjectId) String

func (id ProjectId) String() string

String returns a human-readable description of this Project ID

type ProjectSKUsClient

type ProjectSKUsClient struct {
	Client *resourcemanager.Client
}

func NewProjectSKUsClientWithBaseURI

func NewProjectSKUsClientWithBaseURI(sdkApi sdkEnv.Api) (*ProjectSKUsClient, error)

func (ProjectSKUsClient) SkusListByProject

func (c ProjectSKUsClient) SkusListByProject(ctx context.Context, id ProjectId) (result SkusListByProjectOperationResponse, err error)

SkusListByProject ...

func (ProjectSKUsClient) SkusListByProjectComplete

func (c ProjectSKUsClient) SkusListByProjectComplete(ctx context.Context, id ProjectId) (SkusListByProjectCompleteResult, error)

SkusListByProjectComplete retrieves all the results into a single object

func (ProjectSKUsClient) SkusListByProjectCompleteMatchingPredicate

func (c ProjectSKUsClient) SkusListByProjectCompleteMatchingPredicate(ctx context.Context, id ProjectId, predicate DevCenterSkuOperationPredicate) (result SkusListByProjectCompleteResult, err error)

SkusListByProjectCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SkuTier

type SkuTier string

const (
	SkuTierBasic    SkuTier = "Basic"
	SkuTierFree     SkuTier = "Free"
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON

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

type SkusListByProjectCompleteResult

type SkusListByProjectCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DevCenterSku
}

type SkusListByProjectCustomPager

type SkusListByProjectCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*SkusListByProjectCustomPager) NextPageLink

func (p *SkusListByProjectCustomPager) NextPageLink() *odata.Link

type SkusListByProjectOperationResponse

type SkusListByProjectOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DevCenterSku
}