quotarequests

package
v0.20241111.1164443 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 11, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/quota/2023-02-01/quotarequests Documentation

The quotarequests SDK allows for interaction with Azure Resource Manager quota (API Version 2023-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/quota/2023-02-01/quotarequests"

Client Initialization

client := quotarequests.NewQuotaRequestsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: QuotaRequestsClient.TatusGet

ctx := context.TODO()
id := quotarequests.NewScopedQuotaRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "quotaRequestName")

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

Example Usage: QuotaRequestsClient.TatusList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForLimitType 

func PossibleValuesForLimitType() []string

func PossibleValuesForQuotaLimitTypes 

func PossibleValuesForQuotaLimitTypes() []string

func PossibleValuesForQuotaRequestState 

func PossibleValuesForQuotaRequestState() []string

func ValidateScopedQuotaRequestID 

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

ValidateScopedQuotaRequestID checks that 'input' can be parsed as a Scoped Quota Request ID

Types

type BaseLimitJsonObjectImpl added in v0.20240920.1135249 

type BaseLimitJsonObjectImpl struct {
	LimitObjectType LimitType `json:"limitObjectType"`
}

func (BaseLimitJsonObjectImpl) LimitJsonObject added in v0.20240920.1135249 

func (s BaseLimitJsonObjectImpl) LimitJsonObject() BaseLimitJsonObjectImpl

type LimitJsonObject 

type LimitJsonObject interface {
	LimitJsonObject() BaseLimitJsonObjectImpl
}

func UnmarshalLimitJsonObjectImplementation added in v0.20240920.1135249 

func UnmarshalLimitJsonObjectImplementation(input []byte) (LimitJsonObject, error)

type LimitObject 

type LimitObject struct {
	LimitType *QuotaLimitTypes `json:"limitType,omitempty"`
	Value     int64            `json:"value"`

	LimitObjectType LimitType `json:"limitObjectType"`
}

func (LimitObject) LimitJsonObject added in v0.20240920.1135249 

func (s LimitObject) LimitJsonObject() BaseLimitJsonObjectImpl

func (LimitObject) MarshalJSON 

func (s LimitObject) MarshalJSON() ([]byte, error)

type LimitType 

type LimitType string
const (
	LimitTypeLimitValue LimitType = "LimitValue"
)

func (*LimitType) UnmarshalJSON 

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

type QuotaLimitTypes 

type QuotaLimitTypes string
const (
	QuotaLimitTypesIndependent QuotaLimitTypes = "Independent"
	QuotaLimitTypesShared      QuotaLimitTypes = "Shared"
)

func (*QuotaLimitTypes) UnmarshalJSON 

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

type QuotaRequestDetails 

type QuotaRequestDetails struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *QuotaRequestProperties `json:"properties,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type QuotaRequestDetailsOperationPredicate 

type QuotaRequestDetailsOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (QuotaRequestDetailsOperationPredicate) Matches 

func (p QuotaRequestDetailsOperationPredicate) Matches(input QuotaRequestDetails) bool

type QuotaRequestProperties 

type QuotaRequestProperties struct {
	Error             *ServiceErrorDetail `json:"error,omitempty"`
	Message           *string             `json:"message,omitempty"`
	ProvisioningState *QuotaRequestState  `json:"provisioningState,omitempty"`
	RequestSubmitTime *string             `json:"requestSubmitTime,omitempty"`
	Value             *[]SubRequest       `json:"value,omitempty"`
}

func (*QuotaRequestProperties) GetRequestSubmitTimeAsTime 

func (o *QuotaRequestProperties) GetRequestSubmitTimeAsTime() (*time.Time, error)

func (*QuotaRequestProperties) SetRequestSubmitTimeAsTime 

func (o *QuotaRequestProperties) SetRequestSubmitTimeAsTime(input time.Time)

type QuotaRequestState 

type QuotaRequestState string
const (
	QuotaRequestStateAccepted   QuotaRequestState = "Accepted"
	QuotaRequestStateFailed     QuotaRequestState = "Failed"
	QuotaRequestStateInProgress QuotaRequestState = "InProgress"
	QuotaRequestStateInvalid    QuotaRequestState = "Invalid"
	QuotaRequestStateSucceeded  QuotaRequestState = "Succeeded"
)

func (*QuotaRequestState) UnmarshalJSON 

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

type QuotaRequestsClient 

type QuotaRequestsClient struct {
	Client *resourcemanager.Client
}

func NewQuotaRequestsClientWithBaseURI 

func NewQuotaRequestsClientWithBaseURI(sdkApi sdkEnv.Api) (*QuotaRequestsClient, error)

func (QuotaRequestsClient) TatusGet 

func (c QuotaRequestsClient) TatusGet(ctx context.Context, id ScopedQuotaRequestId) (result TatusGetOperationResponse, err error)

TatusGet ...

func (QuotaRequestsClient) TatusList 

func (c QuotaRequestsClient) TatusList(ctx context.Context, id commonids.ScopeId, options TatusListOperationOptions) (result TatusListOperationResponse, err error)

TatusList ...

func (QuotaRequestsClient) TatusListComplete 

func (c QuotaRequestsClient) TatusListComplete(ctx context.Context, id commonids.ScopeId, options TatusListOperationOptions) (TatusListCompleteResult, error)

TatusListComplete retrieves all the results into a single object

func (QuotaRequestsClient) TatusListCompleteMatchingPredicate 

func (c QuotaRequestsClient) TatusListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options TatusListOperationOptions, predicate QuotaRequestDetailsOperationPredicate) (result TatusListCompleteResult, err error)

TatusListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RawLimitJsonObjectImpl 

type RawLimitJsonObjectImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawLimitJsonObjectImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawLimitJsonObjectImpl) LimitJsonObject added in v0.20240920.1135249 

func (s RawLimitJsonObjectImpl) LimitJsonObject() BaseLimitJsonObjectImpl

type ResourceName 

type ResourceName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}

type ScopedQuotaRequestId 

type ScopedQuotaRequestId struct {
	Scope            string
	QuotaRequestName string
}

ScopedQuotaRequestId is a struct representing the Resource ID for a Scoped Quota Request

func NewScopedQuotaRequestID 

func NewScopedQuotaRequestID(scope string, quotaRequestName string) ScopedQuotaRequestId

NewScopedQuotaRequestID returns a new ScopedQuotaRequestId struct

func ParseScopedQuotaRequestID 

func ParseScopedQuotaRequestID(input string) (*ScopedQuotaRequestId, error)

ParseScopedQuotaRequestID parses 'input' into a ScopedQuotaRequestId

func ParseScopedQuotaRequestIDInsensitively 

func ParseScopedQuotaRequestIDInsensitively(input string) (*ScopedQuotaRequestId, error)

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

func (*ScopedQuotaRequestId) FromParseResult 

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

func (ScopedQuotaRequestId) ID 

func (id ScopedQuotaRequestId) ID() string

ID returns the formatted Scoped Quota Request ID

func (ScopedQuotaRequestId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Quota Request ID

func (ScopedQuotaRequestId) String 

func (id ScopedQuotaRequestId) String() string

String returns a human-readable description of this Scoped Quota Request ID

type ServiceErrorDetail 

type ServiceErrorDetail struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type SubRequest 

type SubRequest struct {
	Limit             LimitJsonObject    `json:"limit"`
	Message           *string            `json:"message,omitempty"`
	Name              *ResourceName      `json:"name,omitempty"`
	ProvisioningState *QuotaRequestState `json:"provisioningState,omitempty"`
	ResourceType      *string            `json:"resourceType,omitempty"`
	SubRequestId      *string            `json:"subRequestId,omitempty"`
	Unit              *string            `json:"unit,omitempty"`
}

func (*SubRequest) UnmarshalJSON 

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

type TatusGetOperationResponse 

type TatusGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *QuotaRequestDetails
}

type TatusListCompleteResult 

type TatusListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []QuotaRequestDetails
}

type TatusListCustomPager added in v0.20240628.1153531 

type TatusListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *TatusListCustomPager) NextPageLink() *odata.Link

type TatusListOperationOptions 

type TatusListOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultTatusListOperationOptions 

func DefaultTatusListOperationOptions() TatusListOperationOptions

func (TatusListOperationOptions) ToHeaders 

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

func (TatusListOperationOptions) ToOData 

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

func (TatusListOperationOptions) ToQuery 

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

type TatusListOperationResponse 

type TatusListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]QuotaRequestDetails
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.