reservations

package
v68.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/reservations/armreservations(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/reservations/armreservations). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package reservations implements the Azure ARM Reservations service API version .

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Reservations
	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 AppliedReservationList 

type AppliedReservationList struct {
	Value *[]string `json:"value,omitempty"`
	// NextLink - Url to get the next page of reservations
	NextLink *string `json:"nextLink,omitempty"`
}

AppliedReservationList ...

type AppliedReservations 

type AppliedReservations struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Identifier of the applied reservations
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Type of resource. "Microsoft.Capacity/AppliedReservations"
	Type                           *string `json:"type,omitempty"`
	*AppliedReservationsProperties `json:"properties,omitempty"`
}

AppliedReservations ...

func (AppliedReservations) MarshalJSON 

func (ar AppliedReservations) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AppliedReservations.

func (*AppliedReservations) UnmarshalJSON 

func (ar *AppliedReservations) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AppliedReservations struct.

type AppliedReservationsProperties 

type AppliedReservationsProperties struct {
	ReservationOrderIds *AppliedReservationList `json:"reservationOrderIds,omitempty"`
}

AppliedReservationsProperties ...

type AppliedScopeType 

type AppliedScopeType string

AppliedScopeType enumerates the values for applied scope type. 

const (
	// AppliedScopeTypeShared ...
	AppliedScopeTypeShared AppliedScopeType = "Shared"
	// AppliedScopeTypeSingle ...
	AppliedScopeTypeSingle AppliedScopeType = "Single"
)

func PossibleAppliedScopeTypeValues 

func PossibleAppliedScopeTypeValues() []AppliedScopeType

PossibleAppliedScopeTypeValues returns an array of possible values for the AppliedScopeType const type.

type AvailableScopeProperties 

type AvailableScopeProperties struct {
	autorest.Response `json:"-"`
	Properties        *SubscriptionScopeProperties `json:"properties,omitempty"`
}

AvailableScopeProperties ...

type AvailableScopeRequest 

type AvailableScopeRequest struct {
	Properties *AvailableScopeRequestProperties `json:"properties,omitempty"`
}

AvailableScopeRequest available scope

type AvailableScopeRequestProperties 

type AvailableScopeRequestProperties struct {
	Scopes *[]string `json:"scopes,omitempty"`
}

AvailableScopeRequestProperties available scope request properties

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Reservations.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BaseClient) GetAppliedReservationList 

func (client BaseClient) GetAppliedReservationList(ctx context.Context, subscriptionID string) (result AppliedReservations, err error)

GetAppliedReservationList get applicable `Reservation`s that are applied to this subscription or a resource group under this subscription. Parameters: subscriptionID - id of the subscription

func (BaseClient) GetAppliedReservationListPreparer 

func (client BaseClient) GetAppliedReservationListPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)

GetAppliedReservationListPreparer prepares the GetAppliedReservationList request.

func (BaseClient) GetAppliedReservationListResponder 

func (client BaseClient) GetAppliedReservationListResponder(resp *http.Response) (result AppliedReservations, err error)

GetAppliedReservationListResponder handles the response to the GetAppliedReservationList request. The method always closes the http.Response Body.

func (BaseClient) GetAppliedReservationListSender 

func (client BaseClient) GetAppliedReservationListSender(req *http.Request) (*http.Response, error)

GetAppliedReservationListSender sends the GetAppliedReservationList request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GetCatalog 

func (client BaseClient) GetCatalog(ctx context.Context, subscriptionID string, reservedResourceType string, location string, publisherID string, offerID string, planID string) (result ListCatalog, err error)

GetCatalog sends the get catalog request. Parameters: subscriptionID - id of the subscription reservedResourceType - the type of the resource for which the skus should be provided. location - filters the skus based on the location specified in this parameter. This can be an azure region or global publisherID - publisher id used to get the third party products offerID - offer id used to get the third party products planID - plan id used to get the third party products

func (BaseClient) GetCatalogPreparer 

func (client BaseClient) GetCatalogPreparer(ctx context.Context, subscriptionID string, reservedResourceType string, location string, publisherID string, offerID string, planID string) (*http.Request, error)

GetCatalogPreparer prepares the GetCatalog request.

func (BaseClient) GetCatalogResponder 

func (client BaseClient) GetCatalogResponder(resp *http.Response) (result ListCatalog, err error)

GetCatalogResponder handles the response to the GetCatalog request. The method always closes the http.Response Body.

func (BaseClient) GetCatalogSender 

func (client BaseClient) GetCatalogSender(req *http.Request) (*http.Response, error)

GetCatalogSender sends the GetCatalog request. The method will close the http.Response Body if it receives an error.

type BillingInformation 

type BillingInformation struct {
	BillingCurrencyTotalPaidAmount           *Price `json:"billingCurrencyTotalPaidAmount,omitempty"`
	BillingCurrencyProratedAmount            *Price `json:"billingCurrencyProratedAmount,omitempty"`
	BillingCurrencyRemainingCommitmentAmount *Price `json:"billingCurrencyRemainingCommitmentAmount,omitempty"`
}

BillingInformation billing information

type CalculateExchangeClient 

type CalculateExchangeClient struct {
	BaseClient
}

CalculateExchangeClient is the client for the CalculateExchange methods of the Reservations service.

func NewCalculateExchangeClient 

func NewCalculateExchangeClient() CalculateExchangeClient

NewCalculateExchangeClient creates an instance of the CalculateExchangeClient client.

func NewCalculateExchangeClientWithBaseURI 

func NewCalculateExchangeClientWithBaseURI(baseURI string) CalculateExchangeClient

NewCalculateExchangeClientWithBaseURI creates an instance of the CalculateExchangeClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (CalculateExchangeClient) Post 

func (client CalculateExchangeClient) Post(ctx context.Context, body CalculateExchangeRequest) (result CalculateExchangePostFuture, err error)

Post calculates price for exchanging `Reservations` if there are no policy errors. Parameters: body - request containing purchases and refunds that need to be executed.

func (CalculateExchangeClient) PostPreparer 

func (client CalculateExchangeClient) PostPreparer(ctx context.Context, body CalculateExchangeRequest) (*http.Request, error)

PostPreparer prepares the Post request.

func (CalculateExchangeClient) PostResponder 

func (client CalculateExchangeClient) PostResponder(resp *http.Response) (result CalculateExchangeOperationResultResponse, err error)

PostResponder handles the response to the Post request. The method always closes the http.Response Body.

func (CalculateExchangeClient) PostSender 

func (client CalculateExchangeClient) PostSender(req *http.Request) (future CalculateExchangePostFuture, err error)

PostSender sends the Post request. The method will close the http.Response Body if it receives an error.

type CalculateExchangeOperationResultResponse 

type CalculateExchangeOperationResultResponse struct {
	autorest.Response `json:"-"`
	// ID - It should match what is used to GET the operation result.
	ID *string `json:"id,omitempty"`
	// Name - It must match the last segment of the id field, and will typically be a GUID / system generated value.
	Name *string `json:"name,omitempty"`
	// Status - Status of the operation. Possible values include: 'CalculateExchangeOperationResultStatusSucceeded', 'CalculateExchangeOperationResultStatusFailed', 'CalculateExchangeOperationResultStatusCancelled', 'CalculateExchangeOperationResultStatusPending'
	Status     CalculateExchangeOperationResultStatus `json:"status,omitempty"`
	Properties *CalculateExchangeResponseProperties   `json:"properties,omitempty"`
	Error      *OperationResultError                  `json:"error,omitempty"`
}

CalculateExchangeOperationResultResponse calculateExchange operation result

type CalculateExchangeOperationResultStatus 

type CalculateExchangeOperationResultStatus string

CalculateExchangeOperationResultStatus enumerates the values for calculate exchange operation result status. 

const (
	// CalculateExchangeOperationResultStatusCancelled ...
	CalculateExchangeOperationResultStatusCancelled CalculateExchangeOperationResultStatus = "Cancelled"
	// CalculateExchangeOperationResultStatusFailed ...
	CalculateExchangeOperationResultStatusFailed CalculateExchangeOperationResultStatus = "Failed"
	// CalculateExchangeOperationResultStatusPending ...
	CalculateExchangeOperationResultStatusPending CalculateExchangeOperationResultStatus = "Pending"
	// CalculateExchangeOperationResultStatusSucceeded ...
	CalculateExchangeOperationResultStatusSucceeded CalculateExchangeOperationResultStatus = "Succeeded"
)

func PossibleCalculateExchangeOperationResultStatusValues 

func PossibleCalculateExchangeOperationResultStatusValues() []CalculateExchangeOperationResultStatus

PossibleCalculateExchangeOperationResultStatusValues returns an array of possible values for the CalculateExchangeOperationResultStatus const type.

type CalculateExchangePostFuture 

type CalculateExchangePostFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CalculateExchangeClient) (CalculateExchangeOperationResultResponse, error)
}

CalculateExchangePostFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CalculateExchangePostFuture) UnmarshalJSON 

func (future *CalculateExchangePostFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CalculateExchangeRequest 

type CalculateExchangeRequest struct {
	Properties *CalculateExchangeRequestProperties `json:"properties,omitempty"`
}

CalculateExchangeRequest calculate exchange request

type CalculateExchangeRequestProperties 

type CalculateExchangeRequestProperties struct {
	// ReservationsToPurchase - List of reservations that are being purchased in this exchange.
	ReservationsToPurchase *[]PurchaseRequest `json:"reservationsToPurchase,omitempty"`
	// ReservationsToExchange - List of reservations that are being returned in this exchange.
	ReservationsToExchange *[]ToReturn `json:"reservationsToExchange,omitempty"`
}

CalculateExchangeRequestProperties calculate exchange request properties

type CalculateExchangeResponseProperties 

type CalculateExchangeResponseProperties struct {
	// SessionID - Exchange session identifier
	SessionID      *string `json:"sessionId,omitempty"`
	NetPayable     *Price  `json:"netPayable,omitempty"`
	RefundsTotal   *Price  `json:"refundsTotal,omitempty"`
	PurchasesTotal *Price  `json:"purchasesTotal,omitempty"`
	// ReservationsToPurchase - Details of the reservations being purchased
	ReservationsToPurchase *[]ToPurchaseCalculateExchange `json:"reservationsToPurchase,omitempty"`
	// ReservationsToExchange - Details of the reservations being returned
	ReservationsToExchange *[]ToExchange         `json:"reservationsToExchange,omitempty"`
	PolicyResult           *ExchangePolicyErrors `json:"policyResult,omitempty"`
}

CalculateExchangeResponseProperties calculateExchange response properties

type CalculatePriceResponse 

type CalculatePriceResponse struct {
	autorest.Response `json:"-"`
	Properties        *CalculatePriceResponseProperties `json:"properties,omitempty"`
}

CalculatePriceResponse ...

type CalculatePriceResponseProperties 

type CalculatePriceResponseProperties struct {
	// BillingCurrencyTotal - Currency and amount that customer will be charged in customer's local currency. Tax is not included.
	BillingCurrencyTotal *CalculatePriceResponsePropertiesBillingCurrencyTotal `json:"billingCurrencyTotal,omitempty"`
	// NetTotal - Net total amount in pricing currency.
	NetTotal *float64 `json:"netTotal,omitempty"`
	// TaxTotal - Tax amount in pricing currency.
	TaxTotal *float64 `json:"taxTotal,omitempty"`
	// GrandTotal - Total amount in pricing currency.
	GrandTotal *float64 `json:"grandTotal,omitempty"`
	// IsTaxIncluded - Whether or not tax is included in grand total
	IsTaxIncluded *bool `json:"isTaxIncluded,omitempty"`
	// IsBillingPartnerManaged - True if billing is managed by Microsoft Partner. Used only for CSP accounts.
	IsBillingPartnerManaged *bool `json:"isBillingPartnerManaged,omitempty"`
	// ReservationOrderID - GUID that represents reservation order that can be placed after calculating price.
	ReservationOrderID *string `json:"reservationOrderId,omitempty"`
	// SkuTitle - Title of SKU that is being purchased.
	SkuTitle *string `json:"skuTitle,omitempty"`
	// SkuDescription - Description of SKU that is being purchased.
	SkuDescription *string `json:"skuDescription,omitempty"`
	// PricingCurrencyTotal - Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included.
	PricingCurrencyTotal *CalculatePriceResponsePropertiesPricingCurrencyTotal `json:"pricingCurrencyTotal,omitempty"`
	PaymentSchedule      *[]PaymentDetail                                      `json:"paymentSchedule,omitempty"`
}

CalculatePriceResponseProperties ...

type CalculatePriceResponsePropertiesBillingCurrencyTotal 

type CalculatePriceResponsePropertiesBillingCurrencyTotal struct {
	// CurrencyCode - The ISO 4217 3-letter currency code for the currency used by this purchase record.
	CurrencyCode *string `json:"currencyCode,omitempty"`
	// Amount - Amount in pricing currency. Tax is not included.
	Amount *float64 `json:"amount,omitempty"`
}

CalculatePriceResponsePropertiesBillingCurrencyTotal currency and amount that customer will be charged in customer's local currency. Tax is not included.

type CalculatePriceResponsePropertiesPricingCurrencyTotal 

type CalculatePriceResponsePropertiesPricingCurrencyTotal struct {
	// CurrencyCode - The ISO 4217 3-letter currency code for the currency used by this purchase record.
	CurrencyCode *string  `json:"currencyCode,omitempty"`
	Amount       *float64 `json:"amount,omitempty"`
}

CalculatePriceResponsePropertiesPricingCurrencyTotal amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included.

type CalculateRefundClient 

type CalculateRefundClient struct {
	BaseClient
}

CalculateRefundClient is the client for the CalculateRefund methods of the Reservations service.

func NewCalculateRefundClient 

func NewCalculateRefundClient() CalculateRefundClient

NewCalculateRefundClient creates an instance of the CalculateRefundClient client.

func NewCalculateRefundClientWithBaseURI 

func NewCalculateRefundClientWithBaseURI(baseURI string) CalculateRefundClient

NewCalculateRefundClientWithBaseURI creates an instance of the CalculateRefundClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (CalculateRefundClient) Post 

func (client CalculateRefundClient) Post(ctx context.Context, reservationOrderID string, body CalculateRefundRequest) (result CalculateRefundResponse, err error)

Post calculate price for returning `Reservations` if there are no policy errors. Parameters: reservationOrderID - order Id of the reservation body - information needed for calculating refund of a reservation.

func (CalculateRefundClient) PostPreparer 

func (client CalculateRefundClient) PostPreparer(ctx context.Context, reservationOrderID string, body CalculateRefundRequest) (*http.Request, error)

PostPreparer prepares the Post request.

func (CalculateRefundClient) PostResponder 

func (client CalculateRefundClient) PostResponder(resp *http.Response) (result CalculateRefundResponse, err error)

PostResponder handles the response to the Post request. The method always closes the http.Response Body.

func (CalculateRefundClient) PostSender 

func (client CalculateRefundClient) PostSender(req *http.Request) (*http.Response, error)

PostSender sends the Post request. The method will close the http.Response Body if it receives an error.

type CalculateRefundRequest 

type CalculateRefundRequest struct {
	// ID - Fully qualified identifier of the reservation order being returned
	ID         *string                           `json:"id,omitempty"`
	Properties *CalculateRefundRequestProperties `json:"properties,omitempty"`
}

CalculateRefundRequest ...

type CalculateRefundRequestProperties 

type CalculateRefundRequestProperties struct {
	// Scope - The scope of the refund, e.g. Reservation
	Scope               *string   `json:"scope,omitempty"`
	ReservationToReturn *ToReturn `json:"reservationToReturn,omitempty"`
}

CalculateRefundRequestProperties ...

type CalculateRefundResponse 

type CalculateRefundResponse struct {
	autorest.Response `json:"-"`
	// ID - Fully qualified identifier of the reservation being returned
	ID         *string                   `json:"id,omitempty"`
	Properties *RefundResponseProperties `json:"properties,omitempty"`
}

CalculateRefundResponse ...

type Catalog 

type Catalog struct {
	// ResourceType - READ-ONLY; The type of resource the SKU applies to.
	ResourceType *string `json:"resourceType,omitempty"`
	// Name - READ-ONLY; The name of SKU
	Name *string `json:"name,omitempty"`
	// BillingPlans - The billing plan options available for this SKU.
	BillingPlans map[string][]ReservationBillingPlan `json:"billingPlans"`
	// Terms - READ-ONLY; Available reservation terms for this resource
	Terms *[]ReservationTerm `json:"terms,omitempty"`
	// Locations - READ-ONLY
	Locations *[]string `json:"locations,omitempty"`
	// SkuProperties - READ-ONLY
	SkuProperties *[]SkuProperty `json:"skuProperties,omitempty"`
	// Msrp - READ-ONLY; Pricing information about the SKU
	Msrp *CatalogMsrp `json:"msrp,omitempty"`
	// Restrictions - READ-ONLY
	Restrictions *[]SkuRestriction `json:"restrictions,omitempty"`
	// Tier - READ-ONLY; The tier of this SKU
	Tier *string `json:"tier,omitempty"`
	// Size - READ-ONLY; The size of this SKU
	Size *string `json:"size,omitempty"`
	// Capabilities - READ-ONLY
	Capabilities *[]SkuCapability `json:"capabilities,omitempty"`
}

Catalog ...

func (Catalog) MarshalJSON 

func (c Catalog) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Catalog.

type CatalogMsrp 

type CatalogMsrp struct {
	// P1Y - Amount in pricing currency. Tax not included.
	P1Y *Price `json:"p1Y,omitempty"`
}

CatalogMsrp pricing information about the SKU

type ChangeDirectoryRequest 

type ChangeDirectoryRequest struct {
	// DestinationTenantID - Tenant id GUID that reservation order is to be transferred to
	DestinationTenantID *string `json:"destinationTenantId,omitempty"`
}

ChangeDirectoryRequest ...

type ChangeDirectoryResponse 

type ChangeDirectoryResponse struct {
	autorest.Response    `json:"-"`
	ReservationOrder     *ChangeDirectoryResult   `json:"reservationOrder,omitempty"`
	ReservationsProperty *[]ChangeDirectoryResult `json:"reservations,omitempty"`
}

ChangeDirectoryResponse change directory response

type ChangeDirectoryResult 

type ChangeDirectoryResult struct {
	// ID - Identifier of the reservation order or reservation
	ID *string `json:"id,omitempty"`
	// Name - Name of the reservation order or reservation
	Name *string `json:"name,omitempty"`
	// IsSucceeded - True if change directory operation succeeded on this reservation order or reservation
	IsSucceeded *bool `json:"isSucceeded,omitempty"`
	// Error - Error reason if operation failed. Null otherwise
	Error *string `json:"error,omitempty"`
}

ChangeDirectoryResult change directory result for reservation order or reservation

type Client 

type Client struct {
	BaseClient
}

Client is the client for the Reservation methods of the Reservations service.

func NewClient 

func NewClient() Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

func NewClientWithBaseURI(baseURI string) Client

NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (Client) Archive 

func (client Client) Archive(ctx context.Context, reservationOrderID string, reservationID string) (result autorest.Response, err error)

Archive archiving a `Reservation` moves it to `Archived` state. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the Reservation Item

func (Client) ArchivePreparer 

func (client Client) ArchivePreparer(ctx context.Context, reservationOrderID string, reservationID string) (*http.Request, error)

ArchivePreparer prepares the Archive request.

func (Client) ArchiveResponder 

func (client Client) ArchiveResponder(resp *http.Response) (result autorest.Response, err error)

ArchiveResponder handles the response to the Archive request. The method always closes the http.Response Body.

func (Client) ArchiveSender 

func (client Client) ArchiveSender(req *http.Request) (*http.Response, error)

ArchiveSender sends the Archive request. The method will close the http.Response Body if it receives an error.

func (Client) AvailableScopes 

func (client Client) AvailableScopes(ctx context.Context, reservationOrderID string, reservationID string, body AvailableScopeRequest) (result ReservationAvailableScopesFuture, err error)

AvailableScopes get Available Scopes for `Reservation`. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the Reservation Item

func (Client) AvailableScopesPreparer 

func (client Client) AvailableScopesPreparer(ctx context.Context, reservationOrderID string, reservationID string, body AvailableScopeRequest) (*http.Request, error)

AvailableScopesPreparer prepares the AvailableScopes request.

func (Client) AvailableScopesResponder 

func (client Client) AvailableScopesResponder(resp *http.Response) (result AvailableScopeProperties, err error)

AvailableScopesResponder handles the response to the AvailableScopes request. The method always closes the http.Response Body.

func (Client) AvailableScopesSender 

func (client Client) AvailableScopesSender(req *http.Request) (future ReservationAvailableScopesFuture, err error)

AvailableScopesSender sends the AvailableScopes request. The method will close the http.Response Body if it receives an error.

func (Client) Get 

func (client Client) Get(ctx context.Context, reservationID string, reservationOrderID string, expand string) (result Response, err error)

Get get specific `Reservation` details. Parameters: reservationID - id of the Reservation Item reservationOrderID - order Id of the reservation expand - supported value of this query is renewProperties

func (Client) GetPreparer 

func (client Client) GetPreparer(ctx context.Context, reservationID string, reservationOrderID string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder 

func (client Client) GetResponder(resp *http.Response) (result Response, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (Client) GetSender 

func (client Client) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (Client) List 

func (client Client) List(ctx context.Context, reservationOrderID string) (result ListPage, err error)

List list `Reservation`s within a single `ReservationOrder`. Parameters: reservationOrderID - order Id of the reservation

func (Client) ListAll 

func (client Client) ListAll(ctx context.Context, filter string, orderby string, refreshSummary string, skiptoken *float64, selectedState string, take *float64) (result ListResultPage, err error)

ListAll list the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant. Parameters: filter - may be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} orderby - may be used to sort order by reservation properties. refreshSummary - to indicate whether to refresh the roll up counts of the reservations group by provisioning states skiptoken - the number of reservations to skip from the list before returning results selectedState - the selected provisioning state take - to number of reservations to return

func (Client) ListAllComplete 

func (client Client) ListAllComplete(ctx context.Context, filter string, orderby string, refreshSummary string, skiptoken *float64, selectedState string, take *float64) (result ListResultIterator, err error)

ListAllComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListAllPreparer 

func (client Client) ListAllPreparer(ctx context.Context, filter string, orderby string, refreshSummary string, skiptoken *float64, selectedState string, take *float64) (*http.Request, error)

ListAllPreparer prepares the ListAll request.

func (Client) ListAllResponder 

func (client Client) ListAllResponder(resp *http.Response) (result ListResult, err error)

ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.

func (Client) ListAllSender 

func (client Client) ListAllSender(req *http.Request) (*http.Response, error)

ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.

func (Client) ListComplete 

func (client Client) ListComplete(ctx context.Context, reservationOrderID string) (result ListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListPreparer 

func (client Client) ListPreparer(ctx context.Context, reservationOrderID string) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder 

func (client Client) ListResponder(resp *http.Response) (result List, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (Client) ListRevisions 

func (client Client) ListRevisions(ctx context.Context, reservationID string, reservationOrderID string) (result ListPage, err error)

ListRevisions list of all the revisions for the `Reservation`. Parameters: reservationID - id of the Reservation Item reservationOrderID - order Id of the reservation

func (Client) ListRevisionsComplete 

func (client Client) ListRevisionsComplete(ctx context.Context, reservationID string, reservationOrderID string) (result ListIterator, err error)

ListRevisionsComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListRevisionsPreparer 

func (client Client) ListRevisionsPreparer(ctx context.Context, reservationID string, reservationOrderID string) (*http.Request, error)

ListRevisionsPreparer prepares the ListRevisions request.

func (Client) ListRevisionsResponder 

func (client Client) ListRevisionsResponder(resp *http.Response) (result List, err error)

ListRevisionsResponder handles the response to the ListRevisions request. The method always closes the http.Response Body.

func (Client) ListRevisionsSender 

func (client Client) ListRevisionsSender(req *http.Request) (*http.Response, error)

ListRevisionsSender sends the ListRevisions request. The method will close the http.Response Body if it receives an error.

func (Client) ListSender 

func (client Client) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (Client) Merge 

func (client Client) Merge(ctx context.Context, reservationOrderID string, body MergeRequest) (result ReservationMergeFuture, err error)

Merge merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties. Parameters: reservationOrderID - order Id of the reservation body - information needed for commercial request for a reservation

func (Client) MergePreparer 

func (client Client) MergePreparer(ctx context.Context, reservationOrderID string, body MergeRequest) (*http.Request, error)

MergePreparer prepares the Merge request.

func (Client) MergeResponder 

func (client Client) MergeResponder(resp *http.Response) (result ListResponse, err error)

MergeResponder handles the response to the Merge request. The method always closes the http.Response Body.

func (Client) MergeSender 

func (client Client) MergeSender(req *http.Request) (future ReservationMergeFuture, err error)

MergeSender sends the Merge request. The method will close the http.Response Body if it receives an error.

func (Client) Split 

func (client Client) Split(ctx context.Context, reservationOrderID string, body SplitRequest) (result SplitFuture, err error)

Split split a `Reservation` into two `Reservation`s with specified quantity distribution. Parameters: reservationOrderID - order Id of the reservation body - information needed to Split a reservation item

func (Client) SplitPreparer 

func (client Client) SplitPreparer(ctx context.Context, reservationOrderID string, body SplitRequest) (*http.Request, error)

SplitPreparer prepares the Split request.

func (Client) SplitResponder 

func (client Client) SplitResponder(resp *http.Response) (result ListResponse, err error)

SplitResponder handles the response to the Split request. The method always closes the http.Response Body.

func (Client) SplitSender 

func (client Client) SplitSender(req *http.Request) (future SplitFuture, err error)

SplitSender sends the Split request. The method will close the http.Response Body if it receives an error.

func (Client) Unarchive 

func (client Client) Unarchive(ctx context.Context, reservationOrderID string, reservationID string) (result autorest.Response, err error)

Unarchive unarchiving a `Reservation` moves it to the state it was before archiving. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the Reservation Item

func (Client) UnarchivePreparer 

func (client Client) UnarchivePreparer(ctx context.Context, reservationOrderID string, reservationID string) (*http.Request, error)

UnarchivePreparer prepares the Unarchive request.

func (Client) UnarchiveResponder 

func (client Client) UnarchiveResponder(resp *http.Response) (result autorest.Response, err error)

UnarchiveResponder handles the response to the Unarchive request. The method always closes the http.Response Body.

func (Client) UnarchiveSender 

func (client Client) UnarchiveSender(req *http.Request) (*http.Response, error)

UnarchiveSender sends the Unarchive request. The method will close the http.Response Body if it receives an error.

func (Client) Update 

func (client Client) Update(ctx context.Context, reservationOrderID string, reservationID string, parameters Patch) (result ReservationUpdateFuture, err error)

Update updates the applied scopes of the `Reservation`. Parameters: reservationOrderID - order Id of the reservation reservationID - id of the Reservation Item parameters - information needed to patch a reservation item

func (Client) UpdatePreparer 

func (client Client) UpdatePreparer(ctx context.Context, reservationOrderID string, reservationID string, parameters Patch) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder 

func (client Client) UpdateResponder(resp *http.Response) (result Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (Client) UpdateSender 

func (client Client) UpdateSender(req *http.Request) (future ReservationUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type CreateGenericQuotaRequestParameters 

type CreateGenericQuotaRequestParameters struct {
	// Value - Quota change requests.
	Value *[]CurrentQuotaLimitBase `json:"value,omitempty"`
}

CreateGenericQuotaRequestParameters quota change requests information.

type CreatedByType 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// CreatedByTypeApplication ...
	CreatedByTypeApplication CreatedByType = "Application"
	// CreatedByTypeKey ...
	CreatedByTypeKey CreatedByType = "Key"
	// CreatedByTypeManagedIdentity ...
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	// CreatedByTypeUser ...
	CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type CurrentQuotaLimit 

type CurrentQuotaLimit struct {
	// CurrentQuotaLimitBase - Quota details.
	*CurrentQuotaLimitBase `json:"quotaInformation,omitempty"`
	// QuotaRequestStatusDetails - Additional properties for the quota status for the resource.
	*QuotaRequestStatusDetails `json:"properties,omitempty"`
}

CurrentQuotaLimit current quota limits.

func (CurrentQuotaLimit) MarshalJSON 

func (cql CurrentQuotaLimit) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CurrentQuotaLimit.

func (*CurrentQuotaLimit) UnmarshalJSON 

func (cql *CurrentQuotaLimit) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CurrentQuotaLimit struct.

type CurrentQuotaLimitBase 

type CurrentQuotaLimitBase struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The quota request ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the quota request.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Type of resource. "Microsoft.Capacity/ServiceLimits"
	Type *string `json:"type,omitempty"`
	// Properties - Quota properties for the resource.
	Properties *QuotaProperties `json:"properties,omitempty"`
}

CurrentQuotaLimitBase quota properties.

func (CurrentQuotaLimitBase) MarshalJSON 

func (cqlb CurrentQuotaLimitBase) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CurrentQuotaLimitBase.

type DisplayProvisioningState 

type DisplayProvisioningState string

DisplayProvisioningState enumerates the values for display provisioning state. 

const (
	// DisplayProvisioningStateCancelled ...
	DisplayProvisioningStateCancelled DisplayProvisioningState = "Cancelled"
	// DisplayProvisioningStateExpired ...
	DisplayProvisioningStateExpired DisplayProvisioningState = "Expired"
	// DisplayProvisioningStateExpiring ...
	DisplayProvisioningStateExpiring DisplayProvisioningState = "Expiring"
	// DisplayProvisioningStateFailed ...
	DisplayProvisioningStateFailed DisplayProvisioningState = "Failed"
	// DisplayProvisioningStatePending ...
	DisplayProvisioningStatePending DisplayProvisioningState = "Pending"
	// DisplayProvisioningStateProcessing ...
	DisplayProvisioningStateProcessing DisplayProvisioningState = "Processing"
	// DisplayProvisioningStateSucceeded ...
	DisplayProvisioningStateSucceeded DisplayProvisioningState = "Succeeded"
)

func PossibleDisplayProvisioningStateValues 

func PossibleDisplayProvisioningStateValues() []DisplayProvisioningState

PossibleDisplayProvisioningStateValues returns an array of possible values for the DisplayProvisioningState const type.

type Error 

type Error struct {
	Error *ExtendedErrorInfo `json:"error,omitempty"`
}

Error ...

type ErrorDetails 

type ErrorDetails struct {
	// Code - READ-ONLY; Error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The target of the particular error.
	Target *string `json:"target,omitempty"`
}

ErrorDetails the details of the error.

func (ErrorDetails) MarshalJSON 

func (ed ErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDetails.

type ErrorResponse 

type ErrorResponse struct {
	// Error - The details of the error.
	Error *ErrorDetails `json:"error,omitempty"`
}

ErrorResponse error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

type ErrorResponseCode 

type ErrorResponseCode string

ErrorResponseCode enumerates the values for error response code. 

const (
	// ErrorResponseCodeActivateQuoteFailed ...
	ErrorResponseCodeActivateQuoteFailed ErrorResponseCode = "ActivateQuoteFailed"
	// ErrorResponseCodeAppliedScopesNotAssociatedWithCommerceAccount ...
	ErrorResponseCodeAppliedScopesNotAssociatedWithCommerceAccount ErrorResponseCode = "AppliedScopesNotAssociatedWithCommerceAccount"
	// ErrorResponseCodeAppliedScopesSameAsExisting ...
	ErrorResponseCodeAppliedScopesSameAsExisting ErrorResponseCode = "AppliedScopesSameAsExisting"
	// ErrorResponseCodeAuthorizationFailed ...
	ErrorResponseCodeAuthorizationFailed ErrorResponseCode = "AuthorizationFailed"
	// ErrorResponseCodeBadRequest ...
	ErrorResponseCodeBadRequest ErrorResponseCode = "BadRequest"
	// ErrorResponseCodeBillingCustomerInputError ...
	ErrorResponseCodeBillingCustomerInputError ErrorResponseCode = "BillingCustomerInputError"
	// ErrorResponseCodeBillingError ...
	ErrorResponseCodeBillingError ErrorResponseCode = "BillingError"
	// ErrorResponseCodeBillingPaymentInstrumentHardError ...
	ErrorResponseCodeBillingPaymentInstrumentHardError ErrorResponseCode = "BillingPaymentInstrumentHardError"
	// ErrorResponseCodeBillingPaymentInstrumentSoftError ...
	ErrorResponseCodeBillingPaymentInstrumentSoftError ErrorResponseCode = "BillingPaymentInstrumentSoftError"
	// ErrorResponseCodeBillingScopeIDCannotBeChanged ...
	ErrorResponseCodeBillingScopeIDCannotBeChanged ErrorResponseCode = "BillingScopeIdCannotBeChanged"
	// ErrorResponseCodeBillingTransientError ...
	ErrorResponseCodeBillingTransientError ErrorResponseCode = "BillingTransientError"
	// ErrorResponseCodeCalculatePriceFailed ...
	ErrorResponseCodeCalculatePriceFailed ErrorResponseCode = "CalculatePriceFailed"
	// ErrorResponseCodeCapacityUpdateScopesFailed ...
	ErrorResponseCodeCapacityUpdateScopesFailed ErrorResponseCode = "CapacityUpdateScopesFailed"
	// ErrorResponseCodeClientCertificateThumbprintNotSet ...
	ErrorResponseCodeClientCertificateThumbprintNotSet ErrorResponseCode = "ClientCertificateThumbprintNotSet"
	// ErrorResponseCodeCreateQuoteFailed ...
	ErrorResponseCodeCreateQuoteFailed ErrorResponseCode = "CreateQuoteFailed"
	// ErrorResponseCodeForbidden ...
	ErrorResponseCodeForbidden ErrorResponseCode = "Forbidden"
	// ErrorResponseCodeFulfillmentConfigurationError ...
	ErrorResponseCodeFulfillmentConfigurationError ErrorResponseCode = "FulfillmentConfigurationError"
	// ErrorResponseCodeFulfillmentError ...
	ErrorResponseCodeFulfillmentError ErrorResponseCode = "FulfillmentError"
	// ErrorResponseCodeFulfillmentOutOfStockError ...
	ErrorResponseCodeFulfillmentOutOfStockError ErrorResponseCode = "FulfillmentOutOfStockError"
	// ErrorResponseCodeFulfillmentTransientError ...
	ErrorResponseCodeFulfillmentTransientError ErrorResponseCode = "FulfillmentTransientError"
	// ErrorResponseCodeHTTPMethodNotSupported ...
	ErrorResponseCodeHTTPMethodNotSupported ErrorResponseCode = "HttpMethodNotSupported"
	// ErrorResponseCodeInternalServerError ...
	ErrorResponseCodeInternalServerError ErrorResponseCode = "InternalServerError"
	// ErrorResponseCodeInvalidAccessToken ...
	ErrorResponseCodeInvalidAccessToken ErrorResponseCode = "InvalidAccessToken"
	// ErrorResponseCodeInvalidFulfillmentRequestParameters ...
	ErrorResponseCodeInvalidFulfillmentRequestParameters ErrorResponseCode = "InvalidFulfillmentRequestParameters"
	// ErrorResponseCodeInvalidHealthCheckType ...
	ErrorResponseCodeInvalidHealthCheckType ErrorResponseCode = "InvalidHealthCheckType"
	// ErrorResponseCodeInvalidLocationID ...
	ErrorResponseCodeInvalidLocationID ErrorResponseCode = "InvalidLocationId"
	// ErrorResponseCodeInvalidRefundQuantity ...
	ErrorResponseCodeInvalidRefundQuantity ErrorResponseCode = "InvalidRefundQuantity"
	// ErrorResponseCodeInvalidRequestContent ...
	ErrorResponseCodeInvalidRequestContent ErrorResponseCode = "InvalidRequestContent"
	// ErrorResponseCodeInvalidRequestURI ...
	ErrorResponseCodeInvalidRequestURI ErrorResponseCode = "InvalidRequestUri"
	// ErrorResponseCodeInvalidReservationID ...
	ErrorResponseCodeInvalidReservationID ErrorResponseCode = "InvalidReservationId"
	// ErrorResponseCodeInvalidReservationOrderID ...
	ErrorResponseCodeInvalidReservationOrderID ErrorResponseCode = "InvalidReservationOrderId"
	// ErrorResponseCodeInvalidSingleAppliedScopesCount ...
	ErrorResponseCodeInvalidSingleAppliedScopesCount ErrorResponseCode = "InvalidSingleAppliedScopesCount"
	// ErrorResponseCodeInvalidSubscriptionID ...
	ErrorResponseCodeInvalidSubscriptionID ErrorResponseCode = "InvalidSubscriptionId"
	// ErrorResponseCodeInvalidTenantID ...
	ErrorResponseCodeInvalidTenantID ErrorResponseCode = "InvalidTenantId"
	// ErrorResponseCodeMissingAppliedScopesForSingle ...
	ErrorResponseCodeMissingAppliedScopesForSingle ErrorResponseCode = "MissingAppliedScopesForSingle"
	// ErrorResponseCodeMissingTenantID ...
	ErrorResponseCodeMissingTenantID ErrorResponseCode = "MissingTenantId"
	// ErrorResponseCodeNonsupportedAccountID ...
	ErrorResponseCodeNonsupportedAccountID ErrorResponseCode = "NonsupportedAccountId"
	// ErrorResponseCodeNotSpecified ...
	ErrorResponseCodeNotSpecified ErrorResponseCode = "NotSpecified"
	// ErrorResponseCodeNotSupportedCountry ...
	ErrorResponseCodeNotSupportedCountry ErrorResponseCode = "NotSupportedCountry"
	// ErrorResponseCodeNoValidReservationsToReRate ...
	ErrorResponseCodeNoValidReservationsToReRate ErrorResponseCode = "NoValidReservationsToReRate"
	// ErrorResponseCodeOperationCannotBePerformedInCurrentState ...
	ErrorResponseCodeOperationCannotBePerformedInCurrentState ErrorResponseCode = "OperationCannotBePerformedInCurrentState"
	// ErrorResponseCodeOperationFailed ...
	ErrorResponseCodeOperationFailed ErrorResponseCode = "OperationFailed"
	// ErrorResponseCodePatchValuesSameAsExisting ...
	ErrorResponseCodePatchValuesSameAsExisting ErrorResponseCode = "PatchValuesSameAsExisting"
	// ErrorResponseCodePaymentInstrumentNotFound ...
	ErrorResponseCodePaymentInstrumentNotFound ErrorResponseCode = "PaymentInstrumentNotFound"
	// ErrorResponseCodePurchaseError ...
	ErrorResponseCodePurchaseError ErrorResponseCode = "PurchaseError"
	// ErrorResponseCodeRefundLimitExceeded ...
	ErrorResponseCodeRefundLimitExceeded ErrorResponseCode = "RefundLimitExceeded"
	// ErrorResponseCodeReRateOnlyAllowedForEA ...
	ErrorResponseCodeReRateOnlyAllowedForEA ErrorResponseCode = "ReRateOnlyAllowedForEA"
	// ErrorResponseCodeReservationIDNotInReservationOrder ...
	ErrorResponseCodeReservationIDNotInReservationOrder ErrorResponseCode = "ReservationIdNotInReservationOrder"
	// ErrorResponseCodeReservationOrderCreationFailed ...
	ErrorResponseCodeReservationOrderCreationFailed ErrorResponseCode = "ReservationOrderCreationFailed"
	// ErrorResponseCodeReservationOrderIDAlreadyExists ...
	ErrorResponseCodeReservationOrderIDAlreadyExists ErrorResponseCode = "ReservationOrderIdAlreadyExists"
	// ErrorResponseCodeReservationOrderNotEnabled ...
	ErrorResponseCodeReservationOrderNotEnabled ErrorResponseCode = "ReservationOrderNotEnabled"
	// ErrorResponseCodeReservationOrderNotFound ...
	ErrorResponseCodeReservationOrderNotFound ErrorResponseCode = "ReservationOrderNotFound"
	// ErrorResponseCodeRiskCheckFailed ...
	ErrorResponseCodeRiskCheckFailed ErrorResponseCode = "RiskCheckFailed"
	// ErrorResponseCodeRoleAssignmentCreationFailed ...
	ErrorResponseCodeRoleAssignmentCreationFailed ErrorResponseCode = "RoleAssignmentCreationFailed"
	// ErrorResponseCodeSelfServiceRefundNotSupported ...
	ErrorResponseCodeSelfServiceRefundNotSupported ErrorResponseCode = "SelfServiceRefundNotSupported"
	// ErrorResponseCodeServerTimeout ...
	ErrorResponseCodeServerTimeout ErrorResponseCode = "ServerTimeout"
	// ErrorResponseCodeUnauthenticatedRequestsThrottled ...
	ErrorResponseCodeUnauthenticatedRequestsThrottled ErrorResponseCode = "UnauthenticatedRequestsThrottled"
	// ErrorResponseCodeUnsupportedReservationTerm ...
	ErrorResponseCodeUnsupportedReservationTerm ErrorResponseCode = "UnsupportedReservationTerm"
)

func PossibleErrorResponseCodeValues 

func PossibleErrorResponseCodeValues() []ErrorResponseCode

PossibleErrorResponseCodeValues returns an array of possible values for the ErrorResponseCode const type.

type ExceptionResponse 

type ExceptionResponse struct {
	// Error - The API error details.
	Error *ServiceError `json:"error,omitempty"`
}

ExceptionResponse the API error.

type ExchangeClient 

type ExchangeClient struct {
	BaseClient
}

ExchangeClient is the client for the Exchange methods of the Reservations service.

func NewExchangeClient 

func NewExchangeClient() ExchangeClient

NewExchangeClient creates an instance of the ExchangeClient client.

func NewExchangeClientWithBaseURI 

func NewExchangeClientWithBaseURI(baseURI string) ExchangeClient

NewExchangeClientWithBaseURI creates an instance of the ExchangeClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ExchangeClient) Post 

func (client ExchangeClient) Post(ctx context.Context, body ExchangeRequest) (result ExchangePostFuture, err error)

Post returns one or more `Reservations` in exchange for one or more `Reservation` purchases. Parameters: body - request containing the refunds and purchases that need to be executed.

func (ExchangeClient) PostPreparer 

func (client ExchangeClient) PostPreparer(ctx context.Context, body ExchangeRequest) (*http.Request, error)

PostPreparer prepares the Post request.

func (ExchangeClient) PostResponder 

func (client ExchangeClient) PostResponder(resp *http.Response) (result ExchangeOperationResultResponse, err error)

PostResponder handles the response to the Post request. The method always closes the http.Response Body.

func (ExchangeClient) PostSender 

func (client ExchangeClient) PostSender(req *http.Request) (future ExchangePostFuture, err error)

PostSender sends the Post request. The method will close the http.Response Body if it receives an error.

type ExchangeOperationResultResponse 

type ExchangeOperationResultResponse struct {
	autorest.Response `json:"-"`
	// ID - It should match what is used to GET the operation result.
	ID *string `json:"id,omitempty"`
	// Name - It must match the last segment of the id field, and will typically be a GUID / system generated value.
	Name *string `json:"name,omitempty"`
	// Status - Status of the operation. Possible values include: 'ExchangeOperationResultStatusSucceeded', 'ExchangeOperationResultStatusFailed', 'ExchangeOperationResultStatusCancelled', 'ExchangeOperationResultStatusPendingRefunds', 'ExchangeOperationResultStatusPendingPurchases'
	Status     ExchangeOperationResultStatus `json:"status,omitempty"`
	Properties *ExchangeResponseProperties   `json:"properties,omitempty"`
	Error      *OperationResultError         `json:"error,omitempty"`
}

ExchangeOperationResultResponse exchange operation result

type ExchangeOperationResultStatus 

type ExchangeOperationResultStatus string

ExchangeOperationResultStatus enumerates the values for exchange operation result status. 

const (
	// ExchangeOperationResultStatusCancelled ...
	ExchangeOperationResultStatusCancelled ExchangeOperationResultStatus = "Cancelled"
	// ExchangeOperationResultStatusFailed ...
	ExchangeOperationResultStatusFailed ExchangeOperationResultStatus = "Failed"
	// ExchangeOperationResultStatusPendingPurchases ...
	ExchangeOperationResultStatusPendingPurchases ExchangeOperationResultStatus = "PendingPurchases"
	// ExchangeOperationResultStatusPendingRefunds ...
	ExchangeOperationResultStatusPendingRefunds ExchangeOperationResultStatus = "PendingRefunds"
	// ExchangeOperationResultStatusSucceeded ...
	ExchangeOperationResultStatusSucceeded ExchangeOperationResultStatus = "Succeeded"
)

func PossibleExchangeOperationResultStatusValues 

func PossibleExchangeOperationResultStatusValues() []ExchangeOperationResultStatus

PossibleExchangeOperationResultStatusValues returns an array of possible values for the ExchangeOperationResultStatus const type.

type ExchangePolicyError 

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

ExchangePolicyError error details

type ExchangePolicyErrors 

type ExchangePolicyErrors struct {
	// PolicyErrors - Exchange Policy errors
	PolicyErrors *[]ExchangePolicyError `json:"policyErrors,omitempty"`
}

ExchangePolicyErrors exchange policy errors

type ExchangePostFuture 

type ExchangePostFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ExchangeClient) (ExchangeOperationResultResponse, error)
}

ExchangePostFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ExchangePostFuture) UnmarshalJSON 

func (future *ExchangePostFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ExchangeRequest 

type ExchangeRequest struct {
	Properties *ExchangeRequestProperties `json:"properties,omitempty"`
}

ExchangeRequest exchange request

type ExchangeRequestProperties 

type ExchangeRequestProperties struct {
	// SessionID - SessionId that was returned by CalculateExchange API.
	SessionID *string `json:"sessionId,omitempty"`
}

ExchangeRequestProperties exchange request properties

type ExchangeResponseProperties 

type ExchangeResponseProperties struct {
	// SessionID - Exchange session identifier
	SessionID      *string `json:"sessionId,omitempty"`
	NetPayable     *Price  `json:"netPayable,omitempty"`
	RefundsTotal   *Price  `json:"refundsTotal,omitempty"`
	PurchasesTotal *Price  `json:"purchasesTotal,omitempty"`
	// ReservationsToPurchase - Details of the reservations being purchased
	ReservationsToPurchase *[]ToPurchaseExchange `json:"reservationsToPurchase,omitempty"`
	// ReservationsToExchange - Details of the reservations being returned
	ReservationsToExchange *[]ToReturnForExchange `json:"reservationsToExchange,omitempty"`
	PolicyResult           *ExchangePolicyErrors  `json:"policyResult,omitempty"`
}

ExchangeResponseProperties exchange response properties

type ExtendedErrorInfo 

type ExtendedErrorInfo struct {
	// Code - Possible values include: 'ErrorResponseCodeNotSpecified', 'ErrorResponseCodeInternalServerError', 'ErrorResponseCodeServerTimeout', 'ErrorResponseCodeAuthorizationFailed', 'ErrorResponseCodeBadRequest', 'ErrorResponseCodeClientCertificateThumbprintNotSet', 'ErrorResponseCodeInvalidRequestContent', 'ErrorResponseCodeOperationFailed', 'ErrorResponseCodeHTTPMethodNotSupported', 'ErrorResponseCodeInvalidRequestURI', 'ErrorResponseCodeMissingTenantID', 'ErrorResponseCodeInvalidTenantID', 'ErrorResponseCodeInvalidReservationOrderID', 'ErrorResponseCodeInvalidReservationID', 'ErrorResponseCodeReservationIDNotInReservationOrder', 'ErrorResponseCodeReservationOrderNotFound', 'ErrorResponseCodeInvalidSubscriptionID', 'ErrorResponseCodeInvalidAccessToken', 'ErrorResponseCodeInvalidLocationID', 'ErrorResponseCodeUnauthenticatedRequestsThrottled', 'ErrorResponseCodeInvalidHealthCheckType', 'ErrorResponseCodeForbidden', 'ErrorResponseCodeBillingScopeIDCannotBeChanged', 'ErrorResponseCodeAppliedScopesNotAssociatedWithCommerceAccount', 'ErrorResponseCodePatchValuesSameAsExisting', 'ErrorResponseCodeRoleAssignmentCreationFailed', 'ErrorResponseCodeReservationOrderCreationFailed', 'ErrorResponseCodeReservationOrderNotEnabled', 'ErrorResponseCodeCapacityUpdateScopesFailed', 'ErrorResponseCodeUnsupportedReservationTerm', 'ErrorResponseCodeReservationOrderIDAlreadyExists', 'ErrorResponseCodeRiskCheckFailed', 'ErrorResponseCodeCreateQuoteFailed', 'ErrorResponseCodeActivateQuoteFailed', 'ErrorResponseCodeNonsupportedAccountID', 'ErrorResponseCodePaymentInstrumentNotFound', 'ErrorResponseCodeMissingAppliedScopesForSingle', 'ErrorResponseCodeNoValidReservationsToReRate', 'ErrorResponseCodeReRateOnlyAllowedForEA', 'ErrorResponseCodeOperationCannotBePerformedInCurrentState', 'ErrorResponseCodeInvalidSingleAppliedScopesCount', 'ErrorResponseCodeInvalidFulfillmentRequestParameters', 'ErrorResponseCodeNotSupportedCountry', 'ErrorResponseCodeInvalidRefundQuantity', 'ErrorResponseCodePurchaseError', 'ErrorResponseCodeBillingCustomerInputError', 'ErrorResponseCodeBillingPaymentInstrumentSoftError', 'ErrorResponseCodeBillingPaymentInstrumentHardError', 'ErrorResponseCodeBillingTransientError', 'ErrorResponseCodeBillingError', 'ErrorResponseCodeFulfillmentConfigurationError', 'ErrorResponseCodeFulfillmentOutOfStockError', 'ErrorResponseCodeFulfillmentTransientError', 'ErrorResponseCodeFulfillmentError', 'ErrorResponseCodeCalculatePriceFailed', 'ErrorResponseCodeAppliedScopesSameAsExisting', 'ErrorResponseCodeSelfServiceRefundNotSupported', 'ErrorResponseCodeRefundLimitExceeded'
	Code    ErrorResponseCode `json:"code,omitempty"`
	Message *string           `json:"message,omitempty"`
}

ExtendedErrorInfo ...

type ExtendedStatusInfo 

type ExtendedStatusInfo struct {
	// StatusCode - Possible values include: 'StatusCodeNone', 'StatusCodePending', 'StatusCodeProcessing', 'StatusCodeActive', 'StatusCodePurchaseError', 'StatusCodePaymentInstrumentError', 'StatusCodeSplit', 'StatusCodeMerged', 'StatusCodeExpired', 'StatusCodeSucceeded'
	StatusCode StatusCode `json:"statusCode,omitempty"`
	// Message - The message giving detailed information about the status code.
	Message *string `json:"message,omitempty"`
}

ExtendedStatusInfo ...

type InstanceFlexibility 

type InstanceFlexibility string

InstanceFlexibility enumerates the values for instance flexibility. 

const (
	// InstanceFlexibilityOff ...
	InstanceFlexibilityOff InstanceFlexibility = "Off"
	// InstanceFlexibilityOn ...
	InstanceFlexibilityOn InstanceFlexibility = "On"
)

func PossibleInstanceFlexibilityValues 

func PossibleInstanceFlexibilityValues() []InstanceFlexibility

PossibleInstanceFlexibilityValues returns an array of possible values for the InstanceFlexibility const type.

type Kind 

type Kind string

Kind enumerates the values for kind. 

const (
	// KindMicrosoftCompute ...
	KindMicrosoftCompute Kind = "Microsoft.Compute"
)

func PossibleKindValues 

func PossibleKindValues() []Kind

PossibleKindValues returns an array of possible values for the Kind const type.

type List 

type List struct {
	autorest.Response `json:"-"`
	Value             *[]Response `json:"value,omitempty"`
	// NextLink - Url to get the next page of reservations.
	NextLink *string `json:"nextLink,omitempty"`
}

List ...

func (List) IsEmpty 

func (l List) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListCatalog 

type ListCatalog struct {
	autorest.Response `json:"-"`
	Value             *[]Catalog `json:"value,omitempty"`
}

ListCatalog ...

type ListIterator 

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

ListIterator provides access to a complete listing of Response values.

func NewListIterator 

func NewListIterator(page ListPage) ListIterator

Creates a new instance of the ListIterator type.

func (*ListIterator) Next 

func (iter *ListIterator) 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. Deprecated: Use NextWithContext() instead.

func (*ListIterator) NextWithContext 

func (iter *ListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ListIterator) NotDone 

func (iter ListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListIterator) Response 

func (iter ListIterator) Response() List

Response returns the raw server response from the last page request.

func (ListIterator) Value 

func (iter ListIterator) Value() Response

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ListPage 

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

ListPage contains a page of Response values.

func NewListPage 

func NewListPage(cur List, getNextPage func(context.Context, List) (List, error)) ListPage

Creates a new instance of the ListPage type.

func (*ListPage) Next 

func (page *ListPage) 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. Deprecated: Use NextWithContext() instead.

func (*ListPage) NextWithContext 

func (page *ListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (ListPage) NotDone 

func (page ListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListPage) Response 

func (page ListPage) Response() List

Response returns the raw server response from the last page request.

func (ListPage) Values 

func (page ListPage) Values() []Response

Values returns the slice of values for the current page or nil if there are no values.

type ListResponse 

type ListResponse struct {
	autorest.Response `json:"-"`
	Value             *[]Response `json:"value,omitempty"`
}

ListResponse ...

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of reservations.
	Value *[]Response `json:"value,omitempty"`
	// NextLink - READ-ONLY; The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
	// Summary - The roll out count summary of the reservations
	Summary *Summary `json:"summary,omitempty"`
}

ListResult the list of reservations and summary of roll out count of reservations in each state.

func (ListResult) IsEmpty 

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ListResult) MarshalJSON 

func (lr ListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListResult.

type ListResultIterator 

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

ListResultIterator provides access to a complete listing of Response values.

func NewListResultIterator 

func NewListResultIterator(page ListResultPage) ListResultIterator

Creates a new instance of the ListResultIterator type.

func (*ListResultIterator) Next 

func (iter *ListResultIterator) 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. Deprecated: Use NextWithContext() instead.

func (*ListResultIterator) NextWithContext 

func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ListResultIterator) NotDone 

func (iter ListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListResultIterator) Response 

func (iter ListResultIterator) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultIterator) Value 

func (iter ListResultIterator) Value() Response

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ListResultPage 

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

ListResultPage contains a page of Response values.

func NewListResultPage 

func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage

Creates a new instance of the ListResultPage type.

func (*ListResultPage) Next 

func (page *ListResultPage) 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. Deprecated: Use NextWithContext() instead.

func (*ListResultPage) NextWithContext 

func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (ListResultPage) NotDone 

func (page ListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListResultPage) Response 

func (page ListResultPage) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultPage) Values 

func (page ListResultPage) Values() []Response

Values returns the slice of values for the current page or nil if there are no values.

type Location 

type Location string

Location enumerates the values for location. 

const (
	// LocationAustraliaeast ...
	LocationAustraliaeast Location = "australiaeast"
	// LocationAustraliasoutheast ...
	LocationAustraliasoutheast Location = "australiasoutheast"
	// LocationBrazilsouth ...
	LocationBrazilsouth Location = "brazilsouth"
	// LocationCanadacentral ...
	LocationCanadacentral Location = "canadacentral"
	// LocationCanadaeast ...
	LocationCanadaeast Location = "canadaeast"
	// LocationCentralindia ...
	LocationCentralindia Location = "centralindia"
	// LocationCentralus ...
	LocationCentralus Location = "centralus"
	// LocationEastasia ...
	LocationEastasia Location = "eastasia"
	// LocationEastus ...
	LocationEastus Location = "eastus"
	// LocationEastus2 ...
	LocationEastus2 Location = "eastus2"
	// LocationJapaneast ...
	LocationJapaneast Location = "japaneast"
	// LocationJapanwest ...
	LocationJapanwest Location = "japanwest"
	// LocationNorthcentralus ...
	LocationNorthcentralus Location = "northcentralus"
	// LocationNortheurope ...
	LocationNortheurope Location = "northeurope"
	// LocationSouthcentralus ...
	LocationSouthcentralus Location = "southcentralus"
	// LocationSoutheastasia ...
	LocationSoutheastasia Location = "southeastasia"
	// LocationSouthindia ...
	LocationSouthindia Location = "southindia"
	// LocationUksouth ...
	LocationUksouth Location = "uksouth"
	// LocationUkwest ...
	LocationUkwest Location = "ukwest"
	// LocationWestcentralus ...
	LocationWestcentralus Location = "westcentralus"
	// LocationWesteurope ...
	LocationWesteurope Location = "westeurope"
	// LocationWestindia ...
	LocationWestindia Location = "westindia"
	// LocationWestus ...
	LocationWestus Location = "westus"
	// LocationWestus2 ...
	LocationWestus2 Location = "westus2"
)

func PossibleLocationValues 

func PossibleLocationValues() []Location

PossibleLocationValues returns an array of possible values for the Location const type.

type MergeProperties 

type MergeProperties struct {
	// Sources - Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
	Sources *[]string `json:"sources,omitempty"`
}

MergeProperties ...

type MergePropertiesType 

type MergePropertiesType struct {
	// MergeDestination - Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
	MergeDestination *string `json:"mergeDestination,omitempty"`
	// MergeSources - Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
	MergeSources *[]string `json:"mergeSources,omitempty"`
}

MergePropertiesType ...

type MergeRequest 

type MergeRequest struct {
	*MergeProperties `json:"properties,omitempty"`
}

MergeRequest ...

func (MergeRequest) MarshalJSON 

func (mr MergeRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MergeRequest.

func (*MergeRequest) UnmarshalJSON 

func (mr *MergeRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MergeRequest struct.

type OperationClient 

type OperationClient struct {
	BaseClient
}

OperationClient is the client for the Operation methods of the Reservations service.

func NewOperationClient 

func NewOperationClient() OperationClient

NewOperationClient creates an instance of the OperationClient client.

func NewOperationClientWithBaseURI 

func NewOperationClientWithBaseURI(baseURI string) OperationClient

NewOperationClientWithBaseURI creates an instance of the OperationClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationClient) List 

func (client OperationClient) List(ctx context.Context) (result OperationListPage, err error)

List list all the operations.

func (OperationClient) ListComplete 

func (client OperationClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationClient) ListPreparer 

func (client OperationClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationClient) ListResponder 

func (client OperationClient) ListResponder(resp *http.Response) (result OperationList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationClient) ListSender 

func (client OperationClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OperationDisplay 

type OperationDisplay struct {
	Provider    *string `json:"provider,omitempty"`
	Resource    *string `json:"resource,omitempty"`
	Operation   *string `json:"operation,omitempty"`
	Description *string `json:"description,omitempty"`
}

OperationDisplay ...

type OperationList 

type OperationList struct {
	autorest.Response `json:"-"`
	Value             *[]OperationResponse `json:"value,omitempty"`
	// NextLink - Url to get the next page of items.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationList ...

func (OperationList) IsEmpty 

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator 

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

OperationListIterator provides access to a complete listing of OperationResponse values.

func NewOperationListIterator 

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next 

func (iter *OperationListIterator) 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. Deprecated: Use NextWithContext() instead.

func (*OperationListIterator) NextWithContext 

func (iter *OperationListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListIterator) NotDone 

func (iter OperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListIterator) Response 

func (iter OperationListIterator) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListIterator) Value 

func (iter OperationListIterator) Value() OperationResponse

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListPage 

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

OperationListPage contains a page of OperationResponse values.

func NewOperationListPage 

func NewOperationListPage(cur OperationList, getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next 

func (page *OperationListPage) 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. Deprecated: Use NextWithContext() instead.

func (*OperationListPage) NextWithContext 

func (page *OperationListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (OperationListPage) NotDone 

func (page OperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListPage) Response 

func (page OperationListPage) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListPage) Values 

func (page OperationListPage) Values() []OperationResponse

Values returns the slice of values for the current page or nil if there are no values.

type OperationResponse 

type OperationResponse struct {
	// Name - Name of the operation
	Name *string `json:"name,omitempty"`
	// IsDataAction - Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Display - Display of the operation
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - Origin of the operation
	Origin *string `json:"origin,omitempty"`
	// Properties - Properties of the operation
	Properties interface{} `json:"properties,omitempty"`
}

OperationResponse ...

type OperationResultError 

type OperationResultError struct {
	// Code - Required if status == failed or status == cancelled. If status == failed, provide an invariant error code used for error troubleshooting, aggregation, and analysis.
	Code *string `json:"code,omitempty"`
	// Message - Required if status == failed. Localized. If status == failed, provide an actionable error message indicating what error occurred, and what the user can do to address the issue.
	Message *string `json:"message,omitempty"`
}

OperationResultError required if status == failed or status == canceled.

type OperationStatus 

type OperationStatus string

OperationStatus enumerates the values for operation status. 

const (
	// OperationStatusCancelled ...
	OperationStatusCancelled OperationStatus = "Cancelled"
	// OperationStatusFailed ...
	OperationStatusFailed OperationStatus = "Failed"
	// OperationStatusPending ...
	OperationStatusPending OperationStatus = "Pending"
	// OperationStatusSucceeded ...
	OperationStatusSucceeded OperationStatus = "Succeeded"
)

func PossibleOperationStatusValues 

func PossibleOperationStatusValues() []OperationStatus

PossibleOperationStatusValues returns an array of possible values for the OperationStatus const type.

type OrderBillingPlanInformation 

type OrderBillingPlanInformation struct {
	// PricingCurrencyTotal - Amount of money to be paid for the Order. Tax is not included.
	PricingCurrencyTotal *Price `json:"pricingCurrencyTotal,omitempty"`
	// StartDate - Date when the billing plan has started.
	StartDate *date.Date `json:"startDate,omitempty"`
	// NextPaymentDueDate - For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off.
	NextPaymentDueDate *date.Date       `json:"nextPaymentDueDate,omitempty"`
	Transactions       *[]PaymentDetail `json:"transactions,omitempty"`
}

OrderBillingPlanInformation information describing the type of billing plan for this reservation.

type OrderClient 

type OrderClient struct {
	BaseClient
}

OrderClient is the client for the Order methods of the Reservations service.

func NewOrderClient 

func NewOrderClient() OrderClient

NewOrderClient creates an instance of the OrderClient client.

func NewOrderClientWithBaseURI 

func NewOrderClientWithBaseURI(baseURI string) OrderClient

NewOrderClientWithBaseURI creates an instance of the OrderClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OrderClient) Calculate 

func (client OrderClient) Calculate(ctx context.Context, body PurchaseRequest) (result CalculatePriceResponse, err error)

Calculate calculate price for placing a `ReservationOrder`. Parameters: body - information needed for calculate or purchase reservation

func (OrderClient) CalculatePreparer 

func (client OrderClient) CalculatePreparer(ctx context.Context, body PurchaseRequest) (*http.Request, error)

CalculatePreparer prepares the Calculate request.

func (OrderClient) CalculateResponder 

func (client OrderClient) CalculateResponder(resp *http.Response) (result CalculatePriceResponse, err error)

CalculateResponder handles the response to the Calculate request. The method always closes the http.Response Body.

func (OrderClient) CalculateSender 

func (client OrderClient) CalculateSender(req *http.Request) (*http.Response, error)

CalculateSender sends the Calculate request. The method will close the http.Response Body if it receives an error.

func (OrderClient) ChangeDirectory 

func (client OrderClient) ChangeDirectory(ctx context.Context, reservationOrderID string, body ChangeDirectoryRequest) (result ChangeDirectoryResponse, err error)

ChangeDirectory change directory (tenant) of `ReservationOrder` and all `Reservation` under it to specified tenant id Parameters: reservationOrderID - order Id of the reservation body - information needed to change directory of reservation order

func (OrderClient) ChangeDirectoryPreparer 

func (client OrderClient) ChangeDirectoryPreparer(ctx context.Context, reservationOrderID string, body ChangeDirectoryRequest) (*http.Request, error)

ChangeDirectoryPreparer prepares the ChangeDirectory request.

func (OrderClient) ChangeDirectoryResponder 

func (client OrderClient) ChangeDirectoryResponder(resp *http.Response) (result ChangeDirectoryResponse, err error)

ChangeDirectoryResponder handles the response to the ChangeDirectory request. The method always closes the http.Response Body.

func (OrderClient) ChangeDirectorySender 

func (client OrderClient) ChangeDirectorySender(req *http.Request) (*http.Response, error)

ChangeDirectorySender sends the ChangeDirectory request. The method will close the http.Response Body if it receives an error.

func (OrderClient) Get 

func (client OrderClient) Get(ctx context.Context, reservationOrderID string, expand string) (result OrderResponse, err error)

Get get the details of the `ReservationOrder`. Parameters: reservationOrderID - order Id of the reservation expand - may be used to expand the planInformation.

func (OrderClient) GetPreparer 

func (client OrderClient) GetPreparer(ctx context.Context, reservationOrderID string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OrderClient) GetResponder 

func (client OrderClient) GetResponder(resp *http.Response) (result OrderResponse, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (OrderClient) GetSender 

func (client OrderClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (OrderClient) List 

func (client OrderClient) List(ctx context.Context) (result OrderListPage, err error)

List list of all the `ReservationOrder`s that the user has access to in the current tenant.

func (OrderClient) ListComplete 

func (client OrderClient) ListComplete(ctx context.Context) (result OrderListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OrderClient) ListPreparer 

func (client OrderClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OrderClient) ListResponder 

func (client OrderClient) ListResponder(resp *http.Response) (result OrderList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OrderClient) ListSender 

func (client OrderClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (OrderClient) Purchase 

func (client OrderClient) Purchase(ctx context.Context, reservationOrderID string, body PurchaseRequest) (result OrderPurchaseFuture, err error)

Purchase purchase `ReservationOrder` and create resource under the specified URI. Parameters: reservationOrderID - order Id of the reservation body - information needed for calculate or purchase reservation

func (OrderClient) PurchasePreparer 

func (client OrderClient) PurchasePreparer(ctx context.Context, reservationOrderID string, body PurchaseRequest) (*http.Request, error)

PurchasePreparer prepares the Purchase request.

func (OrderClient) PurchaseResponder 

func (client OrderClient) PurchaseResponder(resp *http.Response) (result OrderResponse, err error)

PurchaseResponder handles the response to the Purchase request. The method always closes the http.Response Body.

func (OrderClient) PurchaseSender 

func (client OrderClient) PurchaseSender(req *http.Request) (future OrderPurchaseFuture, err error)

PurchaseSender sends the Purchase request. The method will close the http.Response Body if it receives an error.

type OrderList 

type OrderList struct {
	autorest.Response `json:"-"`
	Value             *[]OrderResponse `json:"value,omitempty"`
	// NextLink - Url to get the next page of reservationOrders.
	NextLink *string `json:"nextLink,omitempty"`
}

OrderList ...

func (OrderList) IsEmpty 

func (ol OrderList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OrderListIterator 

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

OrderListIterator provides access to a complete listing of OrderResponse values.

func NewOrderListIterator 

func NewOrderListIterator(page OrderListPage) OrderListIterator

Creates a new instance of the OrderListIterator type.

func (*OrderListIterator) Next 

func (iter *OrderListIterator) 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. Deprecated: Use NextWithContext() instead.

func (*OrderListIterator) NextWithContext 

func (iter *OrderListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OrderListIterator) NotDone 

func (iter OrderListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OrderListIterator) Response 

func (iter OrderListIterator) Response() OrderList

Response returns the raw server response from the last page request.

func (OrderListIterator) Value 

func (iter OrderListIterator) Value() OrderResponse

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OrderListPage 

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

OrderListPage contains a page of OrderResponse values.

func NewOrderListPage 

func NewOrderListPage(cur OrderList, getNextPage func(context.Context, OrderList) (OrderList, error)) OrderListPage

Creates a new instance of the OrderListPage type.

func (*OrderListPage) Next 

func (page *OrderListPage) 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. Deprecated: Use NextWithContext() instead.

func (*OrderListPage) NextWithContext 

func (page *OrderListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (OrderListPage) NotDone 

func (page OrderListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OrderListPage) Response 

func (page OrderListPage) Response() OrderList

Response returns the raw server response from the last page request.

func (OrderListPage) Values 

func (page OrderListPage) Values() []OrderResponse

Values returns the slice of values for the current page or nil if there are no values.

type OrderProperties 

type OrderProperties struct {
	// DisplayName - Friendly name for user to easily identified the reservation.
	DisplayName *string `json:"displayName,omitempty"`
	// RequestDateTime - This is the DateTime when the reservation was initially requested for purchase.
	RequestDateTime *date.Time `json:"requestDateTime,omitempty"`
	// CreatedDateTime - This is the DateTime when the reservation was created.
	CreatedDateTime *date.Time `json:"createdDateTime,omitempty"`
	// ExpiryDate - This is the date when the Reservation will expire.
	ExpiryDate *date.Date `json:"expiryDate,omitempty"`
	// BenefitStartTime - This is the DateTime when the reservation benefit started.
	BenefitStartTime *date.Time `json:"benefitStartTime,omitempty"`
	// OriginalQuantity - Total Quantity of the SKUs purchased in the Reservation.
	OriginalQuantity *int32 `json:"originalQuantity,omitempty"`
	// Term - Possible values include: 'ReservationTermP1Y', 'ReservationTermP3Y', 'ReservationTermP5Y'
	Term ReservationTerm `json:"term,omitempty"`
	// ProvisioningState - Current state of the reservation. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStatePendingResourceHold', 'ProvisioningStateConfirmedResourceHold', 'ProvisioningStatePendingBilling', 'ProvisioningStateConfirmedBilling', 'ProvisioningStateCreated', 'ProvisioningStateSucceeded', 'ProvisioningStateCancelled', 'ProvisioningStateExpired', 'ProvisioningStateBillingFailed', 'ProvisioningStateFailed', 'ProvisioningStateSplit', 'ProvisioningStateMerged'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// BillingPlan - Possible values include: 'ReservationBillingPlanUpfront', 'ReservationBillingPlanMonthly'
	BillingPlan          ReservationBillingPlan       `json:"billingPlan,omitempty"`
	PlanInformation      *OrderBillingPlanInformation `json:"planInformation,omitempty"`
	ReservationsProperty *[]Response                  `json:"reservations,omitempty"`
}

OrderProperties ...

type OrderPurchaseFuture 

type OrderPurchaseFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(OrderClient) (OrderResponse, error)
}

OrderPurchaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*OrderPurchaseFuture) UnmarshalJSON 

func (future *OrderPurchaseFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type OrderResponse 

type OrderResponse struct {
	autorest.Response `json:"-"`
	Etag              *int32 `json:"etag,omitempty"`
	// ID - READ-ONLY; Identifier of the reservation
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of the reservation
	Name             *string `json:"name,omitempty"`
	*OrderProperties `json:"properties,omitempty"`
	// Type - READ-ONLY; Type of resource. "Microsoft.Capacity/reservations"
	Type *string `json:"type,omitempty"`
	// SystemData - READ-ONLY
	SystemData *SystemData `json:"systemData,omitempty"`
}

OrderResponse ...

func (OrderResponse) MarshalJSON 

func (or OrderResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderResponse.

func (*OrderResponse) UnmarshalJSON 

func (or *OrderResponse) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OrderResponse struct.

type Patch 

type Patch struct {
	*PatchProperties `json:"properties,omitempty"`
}

Patch ...

func (Patch) MarshalJSON 

func (p Patch) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Patch.

func (*Patch) UnmarshalJSON 

func (p *Patch) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Patch struct.

type PatchProperties 

type PatchProperties struct {
	// AppliedScopeType - Possible values include: 'AppliedScopeTypeSingle', 'AppliedScopeTypeShared'
	AppliedScopeType AppliedScopeType `json:"appliedScopeType,omitempty"`
	AppliedScopes    *[]string        `json:"appliedScopes,omitempty"`
	// InstanceFlexibility - Possible values include: 'InstanceFlexibilityOn', 'InstanceFlexibilityOff'
	InstanceFlexibility InstanceFlexibility `json:"instanceFlexibility,omitempty"`
	// Name - Name of the Reservation
	Name            *string                         `json:"name,omitempty"`
	Renew           *bool                           `json:"renew,omitempty"`
	RenewProperties *PatchPropertiesRenewProperties `json:"renewProperties,omitempty"`
}

PatchProperties ...

type PatchPropertiesRenewProperties 

type PatchPropertiesRenewProperties struct {
	PurchaseProperties *PurchaseRequest `json:"purchaseProperties,omitempty"`
}

PatchPropertiesRenewProperties ...

type PaymentDetail 

type PaymentDetail struct {
	// DueDate - Date when the payment needs to be done.
	DueDate *date.Date `json:"dueDate,omitempty"`
	// PaymentDate - Date when the transaction is completed. Is null when it is scheduled.
	PaymentDate *date.Date `json:"paymentDate,omitempty"`
	// PricingCurrencyTotal - Amount in pricing currency. Tax not included.
	PricingCurrencyTotal *Price `json:"pricingCurrencyTotal,omitempty"`
	// BillingCurrencyTotal - Amount charged in Billing currency. Tax not included. Is null for future payments
	BillingCurrencyTotal *Price `json:"billingCurrencyTotal,omitempty"`
	// BillingAccount - Shows the Account that is charged for this payment.
	BillingAccount *string `json:"billingAccount,omitempty"`
	// Status - Possible values include: 'PaymentStatusSucceeded', 'PaymentStatusFailed', 'PaymentStatusScheduled', 'PaymentStatusCancelled'
	Status             PaymentStatus       `json:"status,omitempty"`
	ExtendedStatusInfo *ExtendedStatusInfo `json:"extendedStatusInfo,omitempty"`
}

PaymentDetail information about payment related to a reservation order.

type PaymentStatus 

type PaymentStatus string

PaymentStatus enumerates the values for payment status. 

const (
	// PaymentStatusCancelled ...
	PaymentStatusCancelled PaymentStatus = "Cancelled"
	// PaymentStatusFailed ...
	PaymentStatusFailed PaymentStatus = "Failed"
	// PaymentStatusScheduled ...
	PaymentStatusScheduled PaymentStatus = "Scheduled"
	// PaymentStatusSucceeded ...
	PaymentStatusSucceeded PaymentStatus = "Succeeded"
)

func PossiblePaymentStatusValues 

func PossiblePaymentStatusValues() []PaymentStatus

PossiblePaymentStatusValues returns an array of possible values for the PaymentStatus const type.

type Price 

type Price struct {
	// CurrencyCode - The ISO 4217 3-letter currency code for the currency used by this purchase record.
	CurrencyCode *string  `json:"currencyCode,omitempty"`
	Amount       *float64 `json:"amount,omitempty"`
}

Price ...

type Properties 

type Properties struct {
	// ReservedResourceType - The type of the resource that is being reserved. Possible values include: 'ReservedResourceTypeVirtualMachines', 'ReservedResourceTypeSQLDatabases', 'ReservedResourceTypeSuseLinux', 'ReservedResourceTypeCosmosDb', 'ReservedResourceTypeRedHat', 'ReservedResourceTypeSQLDataWarehouse', 'ReservedResourceTypeVMwareCloudSimple', 'ReservedResourceTypeRedHatOsa', 'ReservedResourceTypeDatabricks', 'ReservedResourceTypeAppService', 'ReservedResourceTypeManagedDisk', 'ReservedResourceTypeBlockBlob', 'ReservedResourceTypeRedisCache', 'ReservedResourceTypeAzureDataExplorer', 'ReservedResourceTypeMySQL', 'ReservedResourceTypeMariaDb', 'ReservedResourceTypePostgreSQL', 'ReservedResourceTypeDedicatedHost', 'ReservedResourceTypeSapHana', 'ReservedResourceTypeSQLAzureHybridBenefit', 'ReservedResourceTypeAVS', 'ReservedResourceTypeDataFactory', 'ReservedResourceTypeNetAppStorage', 'ReservedResourceTypeAzureFiles', 'ReservedResourceTypeSQLEdge', 'ReservedResourceTypeVirtualMachineSoftware'
	ReservedResourceType ReservedResourceType `json:"reservedResourceType,omitempty"`
	// InstanceFlexibility - Allows reservation discount to be applied across skus within the same Autofit group. Not all skus support instance size flexibility. Possible values include: 'InstanceFlexibilityOn', 'InstanceFlexibilityOff'
	InstanceFlexibility InstanceFlexibility `json:"instanceFlexibility,omitempty"`
	// DisplayName - Friendly name for user to easily identify the reservation
	DisplayName *string `json:"displayName,omitempty"`
	// AppliedScopes - The list of applied scopes
	AppliedScopes *[]string `json:"appliedScopes,omitempty"`
	// AppliedScopeType - The applied scope type. Possible values include: 'AppliedScopeTypeSingle', 'AppliedScopeTypeShared'
	AppliedScopeType AppliedScopeType `json:"appliedScopeType,omitempty"`
	// Archived - Indicates if the reservation is archived
	Archived *bool `json:"archived,omitempty"`
	// Capabilities - Capabilities of the reservation
	Capabilities *string `json:"capabilities,omitempty"`
	// Quantity - Quantity of the SKUs that are part of the Reservation.
	Quantity *int32 `json:"quantity,omitempty"`
	// ProvisioningState - Current state of the reservation. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStatePendingResourceHold', 'ProvisioningStateConfirmedResourceHold', 'ProvisioningStatePendingBilling', 'ProvisioningStateConfirmedBilling', 'ProvisioningStateCreated', 'ProvisioningStateSucceeded', 'ProvisioningStateCancelled', 'ProvisioningStateExpired', 'ProvisioningStateBillingFailed', 'ProvisioningStateFailed', 'ProvisioningStateSplit', 'ProvisioningStateMerged'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// EffectiveDateTime - DateTime of the Reservation starting when this version is effective from.
	EffectiveDateTime *date.Time `json:"effectiveDateTime,omitempty"`
	// BenefitStartTime - This is the DateTime when the reservation benefit started.
	BenefitStartTime *date.Time `json:"benefitStartTime,omitempty"`
	// LastUpdatedDateTime - READ-ONLY; DateTime of the last time the Reservation was updated.
	LastUpdatedDateTime *date.Time `json:"lastUpdatedDateTime,omitempty"`
	// ExpiryDate - This is the date when the Reservation will expire.
	ExpiryDate *date.Date `json:"expiryDate,omitempty"`
	// SkuDescription - Description of the SKU in english.
	SkuDescription *string `json:"skuDescription,omitempty"`
	// ExtendedStatusInfo - The message giving detailed information about the status code.
	ExtendedStatusInfo *ExtendedStatusInfo `json:"extendedStatusInfo,omitempty"`
	// BillingPlan - The billing plan options available for this SKU. Possible values include: 'ReservationBillingPlanUpfront', 'ReservationBillingPlanMonthly'
	BillingPlan ReservationBillingPlan `json:"billingPlan,omitempty"`
	// DisplayProvisioningState - READ-ONLY; The provisioning state of the reservation for display, e.g. Succeeded
	DisplayProvisioningState *string `json:"displayProvisioningState,omitempty"`
	// ProvisioningSubState - READ-ONLY; The provisioning state of the reservation, e.g. Succeeded
	ProvisioningSubState *string `json:"provisioningSubState,omitempty"`
	// PurchaseDate - This is the date when the Reservation was purchased.
	PurchaseDate    *date.Date           `json:"purchaseDate,omitempty"`
	SplitProperties *SplitPropertiesType `json:"splitProperties,omitempty"`
	MergeProperties *MergePropertiesType `json:"mergeProperties,omitempty"`
	BillingScopeID  *string              `json:"billingScopeId,omitempty"`
	// Renew - Setting this to true will automatically purchase a new reservation on the expiration date time.
	Renew *bool `json:"renew,omitempty"`
	// RenewSource - Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
	RenewSource *string `json:"renewSource,omitempty"`
	// RenewDestination - Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
	RenewDestination *string                  `json:"renewDestination,omitempty"`
	RenewProperties  *RenewPropertiesResponse `json:"renewProperties,omitempty"`
	// Term - Represent the term of Reservation. Possible values include: 'ReservationTermP1Y', 'ReservationTermP3Y', 'ReservationTermP5Y'
	Term ReservationTerm `json:"term,omitempty"`
	// UserFriendlyAppliedScopeType - READ-ONLY; The applied scope type of the reservation for display, e.g. Shared
	UserFriendlyAppliedScopeType *string `json:"userFriendlyAppliedScopeType,omitempty"`
	// UserFriendlyRenewState - READ-ONLY; The renew state of the reservation for display, e.g. On
	UserFriendlyRenewState *string `json:"userFriendlyRenewState,omitempty"`
	// Utilization - READ-ONLY; Reservation utilization
	Utilization *PropertiesUtilization `json:"utilization,omitempty"`
}

Properties the properties of the reservations

func (Properties) MarshalJSON 

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

type PropertiesUtilization 

type PropertiesUtilization struct {
	// Trend - READ-ONLY; The number of days trend for a reservation
	Trend *string `json:"trend,omitempty"`
	// Aggregates - The array of aggregates of a reservation's utilization
	Aggregates *[]UtilizationAggregates `json:"aggregates,omitempty"`
}

PropertiesUtilization reservation utilization

func (PropertiesUtilization) MarshalJSON 

func (p PropertiesUtilization) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PropertiesUtilization.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// ProvisioningStateBillingFailed ...
	ProvisioningStateBillingFailed ProvisioningState = "BillingFailed"
	// ProvisioningStateCancelled ...
	ProvisioningStateCancelled ProvisioningState = "Cancelled"
	// ProvisioningStateConfirmedBilling ...
	ProvisioningStateConfirmedBilling ProvisioningState = "ConfirmedBilling"
	// ProvisioningStateConfirmedResourceHold ...
	ProvisioningStateConfirmedResourceHold ProvisioningState = "ConfirmedResourceHold"
	// ProvisioningStateCreated ...
	ProvisioningStateCreated ProvisioningState = "Created"
	// ProvisioningStateCreating ...
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateExpired ...
	ProvisioningStateExpired ProvisioningState = "Expired"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateMerged ...
	ProvisioningStateMerged ProvisioningState = "Merged"
	// ProvisioningStatePendingBilling ...
	ProvisioningStatePendingBilling ProvisioningState = "PendingBilling"
	// ProvisioningStatePendingResourceHold ...
	ProvisioningStatePendingResourceHold ProvisioningState = "PendingResourceHold"
	// ProvisioningStateSplit ...
	ProvisioningStateSplit ProvisioningState = "Split"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type PurchaseRequest 

type PurchaseRequest struct {
	Sku *SkuName `json:"sku,omitempty"`
	// Location - The Azure Region where the reserved resource lives.
	Location                   *string `json:"location,omitempty"`
	*PurchaseRequestProperties `json:"properties,omitempty"`
}

PurchaseRequest ...

func (PurchaseRequest) MarshalJSON 

func (pr PurchaseRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PurchaseRequest.

func (*PurchaseRequest) UnmarshalJSON 

func (pr *PurchaseRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PurchaseRequest struct.

type PurchaseRequestProperties 

type PurchaseRequestProperties struct {
	// ReservedResourceType - Possible values include: 'ReservedResourceTypeVirtualMachines', 'ReservedResourceTypeSQLDatabases', 'ReservedResourceTypeSuseLinux', 'ReservedResourceTypeCosmosDb', 'ReservedResourceTypeRedHat', 'ReservedResourceTypeSQLDataWarehouse', 'ReservedResourceTypeVMwareCloudSimple', 'ReservedResourceTypeRedHatOsa', 'ReservedResourceTypeDatabricks', 'ReservedResourceTypeAppService', 'ReservedResourceTypeManagedDisk', 'ReservedResourceTypeBlockBlob', 'ReservedResourceTypeRedisCache', 'ReservedResourceTypeAzureDataExplorer', 'ReservedResourceTypeMySQL', 'ReservedResourceTypeMariaDb', 'ReservedResourceTypePostgreSQL', 'ReservedResourceTypeDedicatedHost', 'ReservedResourceTypeSapHana', 'ReservedResourceTypeSQLAzureHybridBenefit', 'ReservedResourceTypeAVS', 'ReservedResourceTypeDataFactory', 'ReservedResourceTypeNetAppStorage', 'ReservedResourceTypeAzureFiles', 'ReservedResourceTypeSQLEdge', 'ReservedResourceTypeVirtualMachineSoftware'
	ReservedResourceType ReservedResourceType `json:"reservedResourceType,omitempty"`
	BillingScopeID       *string              `json:"billingScopeId,omitempty"`
	// Term - Possible values include: 'ReservationTermP1Y', 'ReservationTermP3Y', 'ReservationTermP5Y'
	Term ReservationTerm `json:"term,omitempty"`
	// BillingPlan - Possible values include: 'ReservationBillingPlanUpfront', 'ReservationBillingPlanMonthly'
	BillingPlan ReservationBillingPlan `json:"billingPlan,omitempty"`
	// Quantity - Quantity of the SKUs that are part of the Reservation.
	Quantity *int32 `json:"quantity,omitempty"`
	// DisplayName - Friendly name of the Reservation
	DisplayName *string `json:"displayName,omitempty"`
	// AppliedScopeType - Possible values include: 'AppliedScopeTypeSingle', 'AppliedScopeTypeShared'
	AppliedScopeType AppliedScopeType `json:"appliedScopeType,omitempty"`
	AppliedScopes    *[]string        `json:"appliedScopes,omitempty"`
	Renew            *bool            `json:"renew,omitempty"`
	// ReservedResourceProperties - Properties specific to each reserved resource type. Not required if not applicable.
	ReservedResourceProperties *PurchaseRequestPropertiesReservedResourceProperties `json:"reservedResourceProperties,omitempty"`
}

PurchaseRequestProperties ...

type PurchaseRequestPropertiesReservedResourceProperties 

type PurchaseRequestPropertiesReservedResourceProperties struct {
	// InstanceFlexibility - Possible values include: 'InstanceFlexibilityOn', 'InstanceFlexibilityOff'
	InstanceFlexibility InstanceFlexibility `json:"instanceFlexibility,omitempty"`
}

PurchaseRequestPropertiesReservedResourceProperties properties specific to each reserved resource type. Not required if not applicable.

type QuotaClient 

type QuotaClient struct {
	BaseClient
}

QuotaClient is the client for the Quota methods of the Reservations service.

func NewQuotaClient 

func NewQuotaClient() QuotaClient

NewQuotaClient creates an instance of the QuotaClient client.

func NewQuotaClientWithBaseURI 

func NewQuotaClientWithBaseURI(baseURI string) QuotaClient

NewQuotaClientWithBaseURI creates an instance of the QuotaClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (QuotaClient) CreateOrUpdate 

func (client QuotaClient) CreateOrUpdate(ctx context.Context, subscriptionID string, providerID string, location string, resourceName string, createQuotaRequest CurrentQuotaLimitBase) (result QuotaCreateOrUpdateFuture, err error)

CreateOrUpdate create or update the quota (service limits) of a resource to the requested value. Steps: 1. Make the Get request to get the quota information for specific resource. 2. To increase the quota, update the limit field in the response from Get request to new value. 3. Submit the JSON to the quota request API to update the quota. The Create quota request may be constructed as follows. The PUT operation can be used to update the quota. Parameters: subscriptionID - azure subscription ID. providerID - azure resource provider ID. location - azure region. resourceName - the resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices createQuotaRequest - quota requests payload.

func (QuotaClient) CreateOrUpdatePreparer 

func (client QuotaClient) CreateOrUpdatePreparer(ctx context.Context, subscriptionID string, providerID string, location string, resourceName string, createQuotaRequest CurrentQuotaLimitBase) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (QuotaClient) CreateOrUpdateResponder 

func (client QuotaClient) CreateOrUpdateResponder(resp *http.Response) (result SetObject, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (QuotaClient) CreateOrUpdateSender 

func (client QuotaClient) CreateOrUpdateSender(req *http.Request) (future QuotaCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (QuotaClient) Get 

func (client QuotaClient) Get(ctx context.Context, subscriptionID string, providerID string, location string, resourceName string) (result CurrentQuotaLimitBase, err error)

Get get the current quota (service limit) and usage of a resource. You can use the response from the GET operation to submit quota update request. Parameters: subscriptionID - azure subscription ID. providerID - azure resource provider ID. location - azure region. resourceName - the resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices

func (QuotaClient) GetPreparer 

func (client QuotaClient) GetPreparer(ctx context.Context, subscriptionID string, providerID string, location string, resourceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (QuotaClient) GetResponder 

func (client QuotaClient) GetResponder(resp *http.Response) (result CurrentQuotaLimitBase, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (QuotaClient) GetSender 

func (client QuotaClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (QuotaClient) List 

func (client QuotaClient) List(ctx context.Context, subscriptionID string, providerID string, location string) (result QuotaLimitsPage, err error)

List gets a list of current quotas (service limits) and usage for all resources. The response from the list quota operation can be leveraged to request quota updates. Parameters: subscriptionID - azure subscription ID. providerID - azure resource provider ID. location - azure region.

func (QuotaClient) ListComplete 

func (client QuotaClient) ListComplete(ctx context.Context, subscriptionID string, providerID string, location string) (result QuotaLimitsIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (QuotaClient) ListPreparer 

func (client QuotaClient) ListPreparer(ctx context.Context, subscriptionID string, providerID string, location string) (*http.Request, error)

ListPreparer prepares the List request.

func (QuotaClient) ListResponder 

func (client QuotaClient) ListResponder(resp *http.Response) (result QuotaLimits, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (QuotaClient) ListSender 

func (client QuotaClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (QuotaClient) Update 

func (client QuotaClient) Update(ctx context.Context, subscriptionID string, providerID string, location string, resourceName string, createQuotaRequest CurrentQuotaLimitBase) (result QuotaUpdateFuture, err error)

Update update the quota (service limits) of this resource to the requested value. • To get the quota information for specific resource, send a GET request. • To increase the quota, update the limit field from the GET response to a new value. • To update the quota value, submit the JSON response to the quota request API to update the quota. • To update the quota. use the PATCH operation. Parameters: subscriptionID - azure subscription ID. providerID - azure resource provider ID. location - azure region. resourceName - the resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices createQuotaRequest - payload for the quota request.

func (QuotaClient) UpdatePreparer 

func (client QuotaClient) UpdatePreparer(ctx context.Context, subscriptionID string, providerID string, location string, resourceName string, createQuotaRequest CurrentQuotaLimitBase) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (QuotaClient) UpdateResponder 

func (client QuotaClient) UpdateResponder(resp *http.Response) (result SetObject, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (QuotaClient) UpdateSender 

func (client QuotaClient) UpdateSender(req *http.Request) (future QuotaUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type QuotaCreateOrUpdateFuture 

type QuotaCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(QuotaClient) (SetObject, error)
}

QuotaCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*QuotaCreateOrUpdateFuture) UnmarshalJSON 

func (future *QuotaCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type QuotaLimits 

type QuotaLimits struct {
	autorest.Response `json:"-"`
	// Value - List of quotas (service limits).
	Value *[]CurrentQuotaLimitBase `json:"value,omitempty"`
	// NextLink - The URI for fetching the next page of quotas (service limits). When no more pages exist, the value is null.
	NextLink *string `json:"nextLink,omitempty"`
}

QuotaLimits quota limits.

func (QuotaLimits) IsEmpty 

func (ql QuotaLimits) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type QuotaLimitsIterator 

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

QuotaLimitsIterator provides access to a complete listing of CurrentQuotaLimitBase values.

func NewQuotaLimitsIterator 

func NewQuotaLimitsIterator(page QuotaLimitsPage) QuotaLimitsIterator

Creates a new instance of the QuotaLimitsIterator type.

func (*QuotaLimitsIterator) Next 

func (iter *QuotaLimitsIterator) 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. Deprecated: Use NextWithContext() instead.

func (*QuotaLimitsIterator) NextWithContext 

func (iter *QuotaLimitsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (QuotaLimitsIterator) NotDone 

func (iter QuotaLimitsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (QuotaLimitsIterator) Response 

func (iter QuotaLimitsIterator) Response() QuotaLimits

Response returns the raw server response from the last page request.

func (QuotaLimitsIterator) Value 

func (iter QuotaLimitsIterator) Value() CurrentQuotaLimitBase

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type QuotaLimitsPage 

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

QuotaLimitsPage contains a page of CurrentQuotaLimitBase values.

func NewQuotaLimitsPage 

func NewQuotaLimitsPage(cur QuotaLimits, getNextPage func(context.Context, QuotaLimits) (QuotaLimits, error)) QuotaLimitsPage

Creates a new instance of the QuotaLimitsPage type.

func (*QuotaLimitsPage) Next 

func (page *QuotaLimitsPage) 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. Deprecated: Use NextWithContext() instead.

func (*QuotaLimitsPage) NextWithContext 

func (page *QuotaLimitsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (QuotaLimitsPage) NotDone 

func (page QuotaLimitsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (QuotaLimitsPage) Response 

func (page QuotaLimitsPage) Response() QuotaLimits

Response returns the raw server response from the last page request.

func (QuotaLimitsPage) Values 

func (page QuotaLimitsPage) Values() []CurrentQuotaLimitBase

Values returns the slice of values for the current page or nil if there are no values.

type QuotaLimitsResponse 

type QuotaLimitsResponse struct {
	// Value - List of quotas with the quota request status.
	Value *[]CurrentQuotaLimit `json:"value,omitempty"`
	// NextLink - The URI for fetching the next page of quota limits. When no more pages exist, the value is null.
	NextLink *string `json:"nextLink,omitempty"`
}

QuotaLimitsResponse quotas (service limits) in the request response.

type QuotaProperties 

type QuotaProperties struct {
	// Limit - Quota properties.
	Limit *int32 `json:"limit,omitempty"`
	// CurrentValue - READ-ONLY; Current usage value for the resource.
	CurrentValue *int32 `json:"currentValue,omitempty"`
	// Unit -  The limit units, such as **count** and **bytes**. Use the unit field provided in the response of the GET quota operation.
	Unit *string `json:"unit,omitempty"`
	// Name - Name of the resource provide by the resource provider. Use this property for quotaRequests resource operations.
	Name *ResourceName `json:"name,omitempty"`
	// ResourceType - The name of the resource type. Possible values include: 'ResourceTypeStandard', 'ResourceTypeDedicated', 'ResourceTypeLowPriority', 'ResourceTypeShared', 'ResourceTypeServiceSpecific'
	ResourceType ResourceType `json:"resourceType,omitempty"`
	// QuotaPeriod - READ-ONLY; The time period over which the quota usage values are summarized. For example, P1D (per one day), PT1M (per one minute), and PT1S (per one second). This parameter is optional because, for some resources such as compute, the time period is irrelevant.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`
	// Properties - Additional properties for the specified resource provider.
	Properties interface{} `json:"properties,omitempty"`
}

QuotaProperties quota properties for the resource.

func (QuotaProperties) MarshalJSON 

func (qp QuotaProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaProperties.

type QuotaRequestDetails 

type QuotaRequestDetails struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Quota request ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Quota request name.
	Name *string `json:"name,omitempty"`
	// QuotaRequestProperties - Quota request details.
	*QuotaRequestProperties `json:"properties,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
}

QuotaRequestDetails quota request details.

func (QuotaRequestDetails) MarshalJSON 

func (qrd QuotaRequestDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaRequestDetails.

func (*QuotaRequestDetails) UnmarshalJSON 

func (qrd *QuotaRequestDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for QuotaRequestDetails struct.

type QuotaRequestDetailsList 

type QuotaRequestDetailsList struct {
	autorest.Response `json:"-"`
	// Value - The quota requests.
	Value *[]QuotaRequestDetails `json:"value,omitempty"`
	// NextLink - The URI to fetch the next page of quota limits. When there are no more pages, this is null.
	NextLink *string `json:"nextLink,omitempty"`
}

QuotaRequestDetailsList quota request details.

func (QuotaRequestDetailsList) IsEmpty 

func (qrdl QuotaRequestDetailsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type QuotaRequestDetailsListIterator 

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

QuotaRequestDetailsListIterator provides access to a complete listing of QuotaRequestDetails values.

func NewQuotaRequestDetailsListIterator 

func NewQuotaRequestDetailsListIterator(page QuotaRequestDetailsListPage) QuotaRequestDetailsListIterator

Creates a new instance of the QuotaRequestDetailsListIterator type.

func (*QuotaRequestDetailsListIterator) Next 

func (iter *QuotaRequestDetailsListIterator) 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. Deprecated: Use NextWithContext() instead.

func (*QuotaRequestDetailsListIterator) NextWithContext 

func (iter *QuotaRequestDetailsListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (QuotaRequestDetailsListIterator) NotDone 

func (iter QuotaRequestDetailsListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (QuotaRequestDetailsListIterator) Response 

func (iter QuotaRequestDetailsListIterator) Response() QuotaRequestDetailsList

Response returns the raw server response from the last page request.

func (QuotaRequestDetailsListIterator) Value 

func (iter QuotaRequestDetailsListIterator) Value() QuotaRequestDetails

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type QuotaRequestDetailsListPage 

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

QuotaRequestDetailsListPage contains a page of QuotaRequestDetails values.

func NewQuotaRequestDetailsListPage 

func NewQuotaRequestDetailsListPage(cur QuotaRequestDetailsList, getNextPage func(context.Context, QuotaRequestDetailsList) (QuotaRequestDetailsList, error)) QuotaRequestDetailsListPage

Creates a new instance of the QuotaRequestDetailsListPage type.

func (*QuotaRequestDetailsListPage) Next 

func (page *QuotaRequestDetailsListPage) 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. Deprecated: Use NextWithContext() instead.

func (*QuotaRequestDetailsListPage) NextWithContext 

func (page *QuotaRequestDetailsListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (QuotaRequestDetailsListPage) NotDone 

func (page QuotaRequestDetailsListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (QuotaRequestDetailsListPage) Response 

func (page QuotaRequestDetailsListPage) Response() QuotaRequestDetailsList

Response returns the raw server response from the last page request.

func (QuotaRequestDetailsListPage) Values 

func (page QuotaRequestDetailsListPage) Values() []QuotaRequestDetails

Values returns the slice of values for the current page or nil if there are no values.

type QuotaRequestOneResourceProperties 

type QuotaRequestOneResourceProperties struct {
	// ProvisioningState - READ-ONLY; The quota request status. Possible values include: 'QuotaRequestStateAccepted', 'QuotaRequestStateInvalid', 'QuotaRequestStateSucceeded', 'QuotaRequestStateFailed', 'QuotaRequestStateInProgress'
	ProvisioningState QuotaRequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; User friendly status message.
	Message *string `json:"message,omitempty"`
	// RequestSubmitTime - READ-ONLY; The time when the quota request was submitted using format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	RequestSubmitTime *date.Time `json:"requestSubmitTime,omitempty"`
	// CurrentQuotaLimitBase - The quota request addition properties.
	*CurrentQuotaLimitBase `json:"properties,omitempty"`
}

QuotaRequestOneResourceProperties the details of quota request.

func (QuotaRequestOneResourceProperties) MarshalJSON 

func (qrorp QuotaRequestOneResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaRequestOneResourceProperties.

func (*QuotaRequestOneResourceProperties) UnmarshalJSON 

func (qrorp *QuotaRequestOneResourceProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for QuotaRequestOneResourceProperties struct.

type QuotaRequestOneResourceSubmitResponse 

type QuotaRequestOneResourceSubmitResponse struct {
	// ID - READ-ONLY; The quota request ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the quota request.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Type of resource. "Microsoft.Capacity/ServiceLimits"
	Type *string `json:"type,omitempty"`
	// QuotaRequestOneResourceProperties - The details for quota request.
	*QuotaRequestOneResourceProperties `json:"properties,omitempty"`
}

QuotaRequestOneResourceSubmitResponse response for the quota submission request.

func (QuotaRequestOneResourceSubmitResponse) MarshalJSON 

func (qrorsr QuotaRequestOneResourceSubmitResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaRequestOneResourceSubmitResponse.

func (*QuotaRequestOneResourceSubmitResponse) UnmarshalJSON 

func (qrorsr *QuotaRequestOneResourceSubmitResponse) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for QuotaRequestOneResourceSubmitResponse struct.

type QuotaRequestProperties 

type QuotaRequestProperties struct {
	// ProvisioningState - The quota request status. Possible values include: 'QuotaRequestStateAccepted', 'QuotaRequestStateInvalid', 'QuotaRequestStateSucceeded', 'QuotaRequestStateFailed', 'QuotaRequestStateInProgress'
	ProvisioningState QuotaRequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; User friendly status message.
	Message *string `json:"message,omitempty"`
	// RequestSubmitTime - READ-ONLY; The time when the quota request was submitted using format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	RequestSubmitTime *date.Time `json:"requestSubmitTime,omitempty"`
	// Value - The quotaRequests.
	Value *[]SubRequest `json:"value,omitempty"`
}

QuotaRequestProperties the details of quota request.

func (QuotaRequestProperties) MarshalJSON 

func (qrp QuotaRequestProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaRequestProperties.

type QuotaRequestState 

type QuotaRequestState string

QuotaRequestState enumerates the values for quota request state. 

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

func PossibleQuotaRequestStateValues 

func PossibleQuotaRequestStateValues() []QuotaRequestState

PossibleQuotaRequestStateValues returns an array of possible values for the QuotaRequestState const type.

type QuotaRequestStatusClient 

type QuotaRequestStatusClient struct {
	BaseClient
}

QuotaRequestStatusClient is the client for the QuotaRequestStatus methods of the Reservations service.

func NewQuotaRequestStatusClient 

func NewQuotaRequestStatusClient() QuotaRequestStatusClient

NewQuotaRequestStatusClient creates an instance of the QuotaRequestStatusClient client.

func NewQuotaRequestStatusClientWithBaseURI 

func NewQuotaRequestStatusClientWithBaseURI(baseURI string) QuotaRequestStatusClient

NewQuotaRequestStatusClientWithBaseURI creates an instance of the QuotaRequestStatusClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (QuotaRequestStatusClient) Get 

func (client QuotaRequestStatusClient) Get(ctx context.Context, subscriptionID string, providerID string, location string, ID string) (result QuotaRequestDetails, err error)

Get for the specified Azure region (location), get the details and status of the quota request by the quota request ID for the resources of the resource provider. The PUT request for the quota (service limit) returns a response with the requestId parameter. Parameters: subscriptionID - azure subscription ID. providerID - azure resource provider ID. location - azure region. ID - quota Request ID.

func (QuotaRequestStatusClient) GetPreparer 

func (client QuotaRequestStatusClient) GetPreparer(ctx context.Context, subscriptionID string, providerID string, location string, ID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (QuotaRequestStatusClient) GetResponder 

func (client QuotaRequestStatusClient) GetResponder(resp *http.Response) (result QuotaRequestDetails, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (QuotaRequestStatusClient) GetSender 

func (client QuotaRequestStatusClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (QuotaRequestStatusClient) List 

func (client QuotaRequestStatusClient) List(ctx context.Context, subscriptionID string, providerID string, location string, filter string, top *int32, skiptoken string) (result QuotaRequestDetailsListPage, err error)

List for the specified Azure region (location), subscription, and resource provider, get the history of the quota requests for the past year. To select specific quota requests, use the oData filter. Parameters: subscriptionID - azure subscription ID. providerID - azure resource provider ID. location - azure region. filter - | Field | Supported operators | |---------------------|------------------------| |requestSubmitTime | ge, le, eq, gt, lt | top - number of records to return. skiptoken - skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element includes a skiptoken parameter that specifies a starting point to use for subsequent calls.

func (QuotaRequestStatusClient) ListComplete 

func (client QuotaRequestStatusClient) ListComplete(ctx context.Context, subscriptionID string, providerID string, location string, filter string, top *int32, skiptoken string) (result QuotaRequestDetailsListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (QuotaRequestStatusClient) ListPreparer 

func (client QuotaRequestStatusClient) ListPreparer(ctx context.Context, subscriptionID string, providerID string, location string, filter string, top *int32, skiptoken string) (*http.Request, error)

ListPreparer prepares the List request.

func (QuotaRequestStatusClient) ListResponder 

func (client QuotaRequestStatusClient) ListResponder(resp *http.Response) (result QuotaRequestDetailsList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (QuotaRequestStatusClient) ListSender 

func (client QuotaRequestStatusClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type QuotaRequestStatusDetails 

type QuotaRequestStatusDetails struct {
	// ProvisioningState - READ-ONLY; The details of the quota request status. Possible values include: 'QuotaRequestStateAccepted', 'QuotaRequestStateInvalid', 'QuotaRequestStateSucceeded', 'QuotaRequestStateFailed', 'QuotaRequestStateInProgress'
	ProvisioningState QuotaRequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; A user friendly message.
	Message *string `json:"message,omitempty"`
}

QuotaRequestStatusDetails quota request status details.

func (QuotaRequestStatusDetails) MarshalJSON 

func (qrsd QuotaRequestStatusDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaRequestStatusDetails.

type QuotaRequestSubmitResponse 

type QuotaRequestSubmitResponse struct {
	// ID - READ-ONLY; The quota request ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the quota request.
	Name *string `json:"name,omitempty"`
	// Properties - The quota request details.
	Properties *QuotaRequestProperties `json:"properties,omitempty"`
	// Type - READ-ONLY; Type of resource. "Microsoft.Capacity/serviceLimits"
	Type *string `json:"type,omitempty"`
}

QuotaRequestSubmitResponse response for the quota submission request.

func (QuotaRequestSubmitResponse) MarshalJSON 

func (qrsr QuotaRequestSubmitResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaRequestSubmitResponse.

type QuotaRequestSubmitResponse201 

type QuotaRequestSubmitResponse201 struct {
	// ID - READ-ONLY; The quota request ID. Use the requestId parameter to check the request status.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Operation ID
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// QuotaRequestStatusDetails - Quota request status.
	*QuotaRequestStatusDetails `json:"properties,omitempty"`
}

QuotaRequestSubmitResponse201 response with request ID that the quota request was accepted.

func (QuotaRequestSubmitResponse201) MarshalJSON 

func (qrsr2 QuotaRequestSubmitResponse201) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaRequestSubmitResponse201.

func (*QuotaRequestSubmitResponse201) UnmarshalJSON 

func (qrsr2 *QuotaRequestSubmitResponse201) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for QuotaRequestSubmitResponse201 struct.

type QuotaUpdateFuture 

type QuotaUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(QuotaClient) (SetObject, error)
}

QuotaUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*QuotaUpdateFuture) UnmarshalJSON 

func (future *QuotaUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type RefundBillingInformation 

type RefundBillingInformation struct {
	// BillingPlan - Possible values include: 'ReservationBillingPlanUpfront', 'ReservationBillingPlanMonthly'
	BillingPlan ReservationBillingPlan `json:"billingPlan,omitempty"`
	// CompletedTransactions - The number of completed transactions in this reservation's payment
	CompletedTransactions *int32 `json:"completedTransactions,omitempty"`
	// TotalTransactions - The number of total transactions in this reservation's payment
	TotalTransactions                        *int32 `json:"totalTransactions,omitempty"`
	BillingCurrencyTotalPaidAmount           *Price `json:"billingCurrencyTotalPaidAmount,omitempty"`
	BillingCurrencyProratedAmount            *Price `json:"billingCurrencyProratedAmount,omitempty"`
	BillingCurrencyRemainingCommitmentAmount *Price `json:"billingCurrencyRemainingCommitmentAmount,omitempty"`
}

RefundBillingInformation billing information

type RefundPolicyError 

type RefundPolicyError struct {
	// Code - Possible values include: 'ErrorResponseCodeNotSpecified', 'ErrorResponseCodeInternalServerError', 'ErrorResponseCodeServerTimeout', 'ErrorResponseCodeAuthorizationFailed', 'ErrorResponseCodeBadRequest', 'ErrorResponseCodeClientCertificateThumbprintNotSet', 'ErrorResponseCodeInvalidRequestContent', 'ErrorResponseCodeOperationFailed', 'ErrorResponseCodeHTTPMethodNotSupported', 'ErrorResponseCodeInvalidRequestURI', 'ErrorResponseCodeMissingTenantID', 'ErrorResponseCodeInvalidTenantID', 'ErrorResponseCodeInvalidReservationOrderID', 'ErrorResponseCodeInvalidReservationID', 'ErrorResponseCodeReservationIDNotInReservationOrder', 'ErrorResponseCodeReservationOrderNotFound', 'ErrorResponseCodeInvalidSubscriptionID', 'ErrorResponseCodeInvalidAccessToken', 'ErrorResponseCodeInvalidLocationID', 'ErrorResponseCodeUnauthenticatedRequestsThrottled', 'ErrorResponseCodeInvalidHealthCheckType', 'ErrorResponseCodeForbidden', 'ErrorResponseCodeBillingScopeIDCannotBeChanged', 'ErrorResponseCodeAppliedScopesNotAssociatedWithCommerceAccount', 'ErrorResponseCodePatchValuesSameAsExisting', 'ErrorResponseCodeRoleAssignmentCreationFailed', 'ErrorResponseCodeReservationOrderCreationFailed', 'ErrorResponseCodeReservationOrderNotEnabled', 'ErrorResponseCodeCapacityUpdateScopesFailed', 'ErrorResponseCodeUnsupportedReservationTerm', 'ErrorResponseCodeReservationOrderIDAlreadyExists', 'ErrorResponseCodeRiskCheckFailed', 'ErrorResponseCodeCreateQuoteFailed', 'ErrorResponseCodeActivateQuoteFailed', 'ErrorResponseCodeNonsupportedAccountID', 'ErrorResponseCodePaymentInstrumentNotFound', 'ErrorResponseCodeMissingAppliedScopesForSingle', 'ErrorResponseCodeNoValidReservationsToReRate', 'ErrorResponseCodeReRateOnlyAllowedForEA', 'ErrorResponseCodeOperationCannotBePerformedInCurrentState', 'ErrorResponseCodeInvalidSingleAppliedScopesCount', 'ErrorResponseCodeInvalidFulfillmentRequestParameters', 'ErrorResponseCodeNotSupportedCountry', 'ErrorResponseCodeInvalidRefundQuantity', 'ErrorResponseCodePurchaseError', 'ErrorResponseCodeBillingCustomerInputError', 'ErrorResponseCodeBillingPaymentInstrumentSoftError', 'ErrorResponseCodeBillingPaymentInstrumentHardError', 'ErrorResponseCodeBillingTransientError', 'ErrorResponseCodeBillingError', 'ErrorResponseCodeFulfillmentConfigurationError', 'ErrorResponseCodeFulfillmentOutOfStockError', 'ErrorResponseCodeFulfillmentTransientError', 'ErrorResponseCodeFulfillmentError', 'ErrorResponseCodeCalculatePriceFailed', 'ErrorResponseCodeAppliedScopesSameAsExisting', 'ErrorResponseCodeSelfServiceRefundNotSupported', 'ErrorResponseCodeRefundLimitExceeded'
	Code    ErrorResponseCode `json:"code,omitempty"`
	Message *string           `json:"message,omitempty"`
}

RefundPolicyError error details

type RefundPolicyResult 

type RefundPolicyResult struct {
	Properties *RefundPolicyResultProperty `json:"properties,omitempty"`
}

RefundPolicyResult refund policy result

type RefundPolicyResultProperty 

type RefundPolicyResultProperty struct {
	ConsumedRefundsTotal *Price `json:"consumedRefundsTotal,omitempty"`
	MaxRefundLimit       *Price `json:"maxRefundLimit,omitempty"`
	// PolicyErrors - Refund Policy errors
	PolicyErrors *[]RefundPolicyError `json:"policyErrors,omitempty"`
}

RefundPolicyResultProperty refund policy result property

type RefundRequest 

type RefundRequest struct {
	Properties *RefundRequestProperties `json:"properties,omitempty"`
}

RefundRequest ...

type RefundRequestProperties 

type RefundRequestProperties struct {
	// SessionID - SessionId that was returned by CalculateRefund API.
	SessionID *string `json:"sessionId,omitempty"`
	// Scope - The scope of the refund, e.g. Reservation
	Scope               *string   `json:"scope,omitempty"`
	ReservationToReturn *ToReturn `json:"reservationToReturn,omitempty"`
	// ReturnReason - The reason of returning the reservation
	ReturnReason *string `json:"returnReason,omitempty"`
}

RefundRequestProperties ...

type RefundResponse 

type RefundResponse struct {
	autorest.Response `json:"-"`
	// ID - Fully qualified identifier of the reservation being returned
	ID         *string                   `json:"id,omitempty"`
	Properties *RefundResponseProperties `json:"properties,omitempty"`
}

RefundResponse ...

type RefundResponseProperties 

type RefundResponseProperties struct {
	// SessionID - Refund session identifier
	SessionID *string `json:"sessionId,omitempty"`
	// Quantity - Quantity to be returned
	Quantity            *int32                    `json:"quantity,omitempty"`
	BillingRefundAmount *Price                    `json:"billingRefundAmount,omitempty"`
	PricingRefundAmount *Price                    `json:"pricingRefundAmount,omitempty"`
	PolicyResult        *RefundPolicyResult       `json:"policyResult,omitempty"`
	BillingInformation  *RefundBillingInformation `json:"billingInformation,omitempty"`
}

RefundResponseProperties ...

type RenewPropertiesResponse 

type RenewPropertiesResponse struct {
	PurchaseProperties *PurchaseRequest `json:"purchaseProperties,omitempty"`
	// PricingCurrencyTotal - Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry.
	PricingCurrencyTotal *RenewPropertiesResponsePricingCurrencyTotal `json:"pricingCurrencyTotal,omitempty"`
	// BillingCurrencyTotal - Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included.
	BillingCurrencyTotal *RenewPropertiesResponseBillingCurrencyTotal `json:"billingCurrencyTotal,omitempty"`
}

RenewPropertiesResponse ...

type RenewPropertiesResponseBillingCurrencyTotal 

type RenewPropertiesResponseBillingCurrencyTotal struct {
	// CurrencyCode - The ISO 4217 3-letter currency code for the currency used by this purchase record.
	CurrencyCode *string  `json:"currencyCode,omitempty"`
	Amount       *float64 `json:"amount,omitempty"`
}

RenewPropertiesResponseBillingCurrencyTotal currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included.

type RenewPropertiesResponsePricingCurrencyTotal 

type RenewPropertiesResponsePricingCurrencyTotal struct {
	// CurrencyCode - The ISO 4217 3-letter currency code for the currency used by this purchase record.
	CurrencyCode *string  `json:"currencyCode,omitempty"`
	Amount       *float64 `json:"amount,omitempty"`
}

RenewPropertiesResponsePricingCurrencyTotal amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry.

type ReservationAvailableScopesFuture 

type ReservationAvailableScopesFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (AvailableScopeProperties, error)
}

ReservationAvailableScopesFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ReservationAvailableScopesFuture) UnmarshalJSON 

func (future *ReservationAvailableScopesFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ReservationBillingPlan 

type ReservationBillingPlan string

ReservationBillingPlan enumerates the values for reservation billing plan. 

const (
	// ReservationBillingPlanMonthly ...
	ReservationBillingPlanMonthly ReservationBillingPlan = "Monthly"
	// ReservationBillingPlanUpfront ...
	ReservationBillingPlanUpfront ReservationBillingPlan = "Upfront"
)

func PossibleReservationBillingPlanValues 

func PossibleReservationBillingPlanValues() []ReservationBillingPlan

PossibleReservationBillingPlanValues returns an array of possible values for the ReservationBillingPlan const type.

type ReservationMergeFuture 

type ReservationMergeFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (ListResponse, error)
}

ReservationMergeFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ReservationMergeFuture) UnmarshalJSON 

func (future *ReservationMergeFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ReservationTerm 

type ReservationTerm string

ReservationTerm enumerates the values for reservation term. 

const (
	// ReservationTermP1Y ...
	ReservationTermP1Y ReservationTerm = "P1Y"
	// ReservationTermP3Y ...
	ReservationTermP3Y ReservationTerm = "P3Y"
	// ReservationTermP5Y ...
	ReservationTermP5Y ReservationTerm = "P5Y"
)

func PossibleReservationTermValues 

func PossibleReservationTermValues() []ReservationTerm

PossibleReservationTermValues returns an array of possible values for the ReservationTerm const type.

type ReservationUpdateFuture 

type ReservationUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (Response, error)
}

ReservationUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ReservationUpdateFuture) UnmarshalJSON 

func (future *ReservationUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ReservedResourceType 

type ReservedResourceType string

ReservedResourceType enumerates the values for reserved resource type. 

const (
	// ReservedResourceTypeAppService ...
	ReservedResourceTypeAppService ReservedResourceType = "AppService"
	// ReservedResourceTypeAVS ...
	ReservedResourceTypeAVS ReservedResourceType = "AVS"
	// ReservedResourceTypeAzureDataExplorer ...
	ReservedResourceTypeAzureDataExplorer ReservedResourceType = "AzureDataExplorer"
	// ReservedResourceTypeAzureFiles ...
	ReservedResourceTypeAzureFiles ReservedResourceType = "AzureFiles"
	// ReservedResourceTypeBlockBlob ...
	ReservedResourceTypeBlockBlob ReservedResourceType = "BlockBlob"
	// ReservedResourceTypeCosmosDb ...
	ReservedResourceTypeCosmosDb ReservedResourceType = "CosmosDb"
	// ReservedResourceTypeDatabricks ...
	ReservedResourceTypeDatabricks ReservedResourceType = "Databricks"
	// ReservedResourceTypeDataFactory ...
	ReservedResourceTypeDataFactory ReservedResourceType = "DataFactory"
	// ReservedResourceTypeDedicatedHost ...
	ReservedResourceTypeDedicatedHost ReservedResourceType = "DedicatedHost"
	// ReservedResourceTypeManagedDisk ...
	ReservedResourceTypeManagedDisk ReservedResourceType = "ManagedDisk"
	// ReservedResourceTypeMariaDb ...
	ReservedResourceTypeMariaDb ReservedResourceType = "MariaDb"
	// ReservedResourceTypeMySQL ...
	ReservedResourceTypeMySQL ReservedResourceType = "MySql"
	// ReservedResourceTypeNetAppStorage ...
	ReservedResourceTypeNetAppStorage ReservedResourceType = "NetAppStorage"
	// ReservedResourceTypePostgreSQL ...
	ReservedResourceTypePostgreSQL ReservedResourceType = "PostgreSql"
	// ReservedResourceTypeRedHat ...
	ReservedResourceTypeRedHat ReservedResourceType = "RedHat"
	// ReservedResourceTypeRedHatOsa ...
	ReservedResourceTypeRedHatOsa ReservedResourceType = "RedHatOsa"
	// ReservedResourceTypeRedisCache ...
	ReservedResourceTypeRedisCache ReservedResourceType = "RedisCache"
	// ReservedResourceTypeSapHana ...
	ReservedResourceTypeSapHana ReservedResourceType = "SapHana"
	// ReservedResourceTypeSQLAzureHybridBenefit ...
	ReservedResourceTypeSQLAzureHybridBenefit ReservedResourceType = "SqlAzureHybridBenefit"
	// ReservedResourceTypeSQLDatabases ...
	ReservedResourceTypeSQLDatabases ReservedResourceType = "SqlDatabases"
	// ReservedResourceTypeSQLDataWarehouse ...
	ReservedResourceTypeSQLDataWarehouse ReservedResourceType = "SqlDataWarehouse"
	// ReservedResourceTypeSQLEdge ...
	ReservedResourceTypeSQLEdge ReservedResourceType = "SqlEdge"
	// ReservedResourceTypeSuseLinux ...
	ReservedResourceTypeSuseLinux ReservedResourceType = "SuseLinux"
	// ReservedResourceTypeVirtualMachines ...
	ReservedResourceTypeVirtualMachines ReservedResourceType = "VirtualMachines"
	// ReservedResourceTypeVirtualMachineSoftware ...
	ReservedResourceTypeVirtualMachineSoftware ReservedResourceType = "VirtualMachineSoftware"
	// ReservedResourceTypeVMwareCloudSimple ...
	ReservedResourceTypeVMwareCloudSimple ReservedResourceType = "VMwareCloudSimple"
)

func PossibleReservedResourceTypeValues 

func PossibleReservedResourceTypeValues() []ReservedResourceType

PossibleReservedResourceTypeValues returns an array of possible values for the ReservedResourceType const type.

type ResourceName 

type ResourceName struct {
	// Value - Resource name.
	Value *string `json:"value,omitempty"`
	// LocalizedValue - READ-ONLY; Resource display localized name.
	LocalizedValue *string `json:"localizedValue,omitempty"`
}

ResourceName resource name provided by the resource provider. Use this property for quotaRequest parameter.

func (ResourceName) MarshalJSON 

func (rn ResourceName) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceName.

type ResourceType 

type ResourceType string

ResourceType enumerates the values for resource type. 

const (
	// ResourceTypeDedicated ...
	ResourceTypeDedicated ResourceType = "dedicated"
	// ResourceTypeLowPriority ...
	ResourceTypeLowPriority ResourceType = "lowPriority"
	// ResourceTypeServiceSpecific ...
	ResourceTypeServiceSpecific ResourceType = "serviceSpecific"
	// ResourceTypeShared ...
	ResourceTypeShared ResourceType = "shared"
	// ResourceTypeStandard ...
	ResourceTypeStandard ResourceType = "standard"
)

func PossibleResourceTypeValues 

func PossibleResourceTypeValues() []ResourceType

PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.

type Response 

type Response struct {
	autorest.Response `json:"-"`
	// Location - The Azure Region where the reserved resource lives.
	Location *string `json:"location,omitempty"`
	Etag     *int32  `json:"etag,omitempty"`
	// ID - READ-ONLY; Identifier of the reservation
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of the reservation
	Name *string `json:"name,omitempty"`
	// Sku - The sku information associated to this reservation
	Sku *SkuName `json:"sku,omitempty"`
	// Properties - The properties associated to this reservation
	Properties *Properties `json:"properties,omitempty"`
	// Type - READ-ONLY; Type of resource. "Microsoft.Capacity/reservationOrders/reservations"
	Type *string `json:"type,omitempty"`
	// Kind - Resource Provider type to be reserved. Possible values include: 'KindMicrosoftCompute'
	Kind Kind `json:"kind,omitempty"`
	// SystemData - READ-ONLY
	SystemData *SystemData `json:"systemData,omitempty"`
}

Response the definition of the reservation.

func (Response) MarshalJSON 

func (r Response) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Response.

type ReturnClient 

type ReturnClient struct {
	BaseClient
}

ReturnClient is the client for the Return methods of the Reservations service.

func NewReturnClient 

func NewReturnClient() ReturnClient

NewReturnClient creates an instance of the ReturnClient client.

func NewReturnClientWithBaseURI 

func NewReturnClientWithBaseURI(baseURI string) ReturnClient

NewReturnClientWithBaseURI creates an instance of the ReturnClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ReturnClient) Post 

func (client ReturnClient) Post(ctx context.Context, reservationOrderID string, body RefundRequest) (result RefundResponse, err error)

Post return a reservation. Parameters: reservationOrderID - order Id of the reservation body - information needed for returning reservation.

func (ReturnClient) PostPreparer 

func (client ReturnClient) PostPreparer(ctx context.Context, reservationOrderID string, body RefundRequest) (*http.Request, error)

PostPreparer prepares the Post request.

func (ReturnClient) PostResponder 

func (client ReturnClient) PostResponder(resp *http.Response) (result RefundResponse, err error)

PostResponder handles the response to the Post request. The method always closes the http.Response Body.

func (ReturnClient) PostSender 

func (client ReturnClient) PostSender(req *http.Request) (*http.Response, error)

PostSender sends the Post request. The method will close the http.Response Body if it receives an error.

type ScopeProperties 

type ScopeProperties struct {
	Scope *string `json:"scope,omitempty"`
	Valid *bool   `json:"valid,omitempty"`
}

ScopeProperties ...

type ServiceError 

type ServiceError struct {
	// Code - The error code.
	Code *string `json:"code,omitempty"`
	// Message - The error message text.
	Message *string `json:"message,omitempty"`
	// Details - READ-ONLY; The list of error details.
	Details *[]ServiceErrorDetail `json:"details,omitempty"`
}

ServiceError the API error details.

func (ServiceError) MarshalJSON 

func (se ServiceError) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceError.

type ServiceErrorDetail 

type ServiceErrorDetail struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
}

ServiceErrorDetail the error details.

func (ServiceErrorDetail) MarshalJSON 

func (sed ServiceErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceErrorDetail.

type SetObject 

type SetObject struct {
	autorest.Response `json:"-"`
	Value             interface{} `json:"value,omitempty"`
}

SetObject ...

type SkuCapability 

type SkuCapability 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"`
}

SkuCapability ...

type SkuName 

type SkuName struct {
	Name *string `json:"name,omitempty"`
}

SkuName ...

type SkuProperty 

type SkuProperty 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"`
}

SkuProperty ...

type SkuRestriction 

type SkuRestriction struct {
	// Type - The type of restrictions.
	Type *string `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"`
	// ReasonCode - The reason for restriction.
	ReasonCode *string `json:"reasonCode,omitempty"`
}

SkuRestriction ...

type SplitFuture 

type SplitFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (ListResponse, error)
}

SplitFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SplitFuture) UnmarshalJSON 

func (future *SplitFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type SplitProperties 

type SplitProperties struct {
	// Quantities - List of the quantities in the new reservations to create.
	Quantities *[]int32 `json:"quantities,omitempty"`
	// ReservationID - Resource id of the reservation to be split. Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
	ReservationID *string `json:"reservationId,omitempty"`
}

SplitProperties ...

type SplitPropertiesType 

type SplitPropertiesType struct {
	// SplitDestinations - List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
	SplitDestinations *[]string `json:"splitDestinations,omitempty"`
	// SplitSource - Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
	SplitSource *string `json:"splitSource,omitempty"`
}

SplitPropertiesType ...

type SplitRequest 

type SplitRequest struct {
	*SplitProperties `json:"properties,omitempty"`
}

SplitRequest ...

func (SplitRequest) MarshalJSON 

func (sr SplitRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SplitRequest.

func (*SplitRequest) UnmarshalJSON 

func (sr *SplitRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SplitRequest struct.

type StatusCode 

type StatusCode string

StatusCode enumerates the values for status code. 

const (
	// StatusCodeActive ...
	StatusCodeActive StatusCode = "Active"
	// StatusCodeExpired ...
	StatusCodeExpired StatusCode = "Expired"
	// StatusCodeMerged ...
	StatusCodeMerged StatusCode = "Merged"
	// StatusCodeNone ...
	StatusCodeNone StatusCode = "None"
	// StatusCodePaymentInstrumentError ...
	StatusCodePaymentInstrumentError StatusCode = "PaymentInstrumentError"
	// StatusCodePending ...
	StatusCodePending StatusCode = "Pending"
	// StatusCodeProcessing ...
	StatusCodeProcessing StatusCode = "Processing"
	// StatusCodePurchaseError ...
	StatusCodePurchaseError StatusCode = "PurchaseError"
	// StatusCodeSplit ...
	StatusCodeSplit StatusCode = "Split"
	// StatusCodeSucceeded ...
	StatusCodeSucceeded StatusCode = "Succeeded"
)

func PossibleStatusCodeValues 

func PossibleStatusCodeValues() []StatusCode

PossibleStatusCodeValues returns an array of possible values for the StatusCode const type.

type SubRequest 

type SubRequest struct {
	// Limit - READ-ONLY; Quota (resource limit).
	Limit *int32 `json:"limit,omitempty"`
	// Name - The resource name.
	Name *ResourceName `json:"name,omitempty"`
	// ResourceType - READ-ONLY; Resource type for which the quota check was made.
	ResourceType *string `json:"resourceType,omitempty"`
	// Unit -  The limit units, such as **count** and **bytes**. Use the unit field provided in the response of the GET quota operation.
	Unit *string `json:"unit,omitempty"`
	// ProvisioningState - The quota request status. Possible values include: 'QuotaRequestStateAccepted', 'QuotaRequestStateInvalid', 'QuotaRequestStateSucceeded', 'QuotaRequestStateFailed', 'QuotaRequestStateInProgress'
	ProvisioningState QuotaRequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; User-friendly status message.
	Message *string `json:"message,omitempty"`
	// SubRequestID - READ-ONLY; Sub request ID for individual request.
	SubRequestID *string `json:"subRequestId,omitempty"`
}

SubRequest the sub-request submitted with the quota request.

func (SubRequest) MarshalJSON 

func (sr SubRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubRequest.

type SubscriptionScopeProperties 

type SubscriptionScopeProperties struct {
	Scopes *[]ScopeProperties `json:"scopes,omitempty"`
}

SubscriptionScopeProperties ...

type Summary 

type Summary struct {
	// SucceededCount - READ-ONLY; The number of reservation in Succeeded state
	SucceededCount *float64 `json:"succeededCount,omitempty"`
	// FailedCount - READ-ONLY; The number of reservation in Failed state
	FailedCount *float64 `json:"failedCount,omitempty"`
	// ExpiringCount - READ-ONLY; The number of reservation in Expiring state
	ExpiringCount *float64 `json:"expiringCount,omitempty"`
	// ExpiredCount - READ-ONLY; The number of reservation in Expired state
	ExpiredCount *float64 `json:"expiredCount,omitempty"`
	// PendingCount - READ-ONLY; The number of reservation in Pending state
	PendingCount *float64 `json:"pendingCount,omitempty"`
	// CancelledCount - READ-ONLY; The number of reservation in Cancelled state
	CancelledCount *float64 `json:"cancelledCount,omitempty"`
	// ProcessingCount - READ-ONLY; The number of reservation in Processing state
	ProcessingCount *float64 `json:"processingCount,omitempty"`
}

Summary the roll up count summary of reservations in each state

func (Summary) MarshalJSON 

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

MarshalJSON is the custom marshaler for Summary.

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type ToExchange 

type ToExchange struct {
	// ReservationID - Fully qualified id of the Reservation being returned.
	ReservationID *string `json:"reservationId,omitempty"`
	// Quantity - Quantity to be returned
	Quantity            *int32              `json:"quantity,omitempty"`
	BillingRefundAmount *Price              `json:"billingRefundAmount,omitempty"`
	BillingInformation  *BillingInformation `json:"billingInformation,omitempty"`
}

ToExchange reservation refund details

type ToPurchaseCalculateExchange 

type ToPurchaseCalculateExchange struct {
	Properties           *PurchaseRequest `json:"properties,omitempty"`
	BillingCurrencyTotal *Price           `json:"billingCurrencyTotal,omitempty"`
}

ToPurchaseCalculateExchange reservation purchase details

type ToPurchaseExchange 

type ToPurchaseExchange struct {
	// ReservationOrderID - Fully qualified id of the ReservationOrder being purchased
	ReservationOrderID *string `json:"reservationOrderId,omitempty"`
	// ReservationID - Fully qualified id of the Reservation being purchased. This value is only guaranteed to be non-null if the purchase is successful.
	ReservationID        *string          `json:"reservationId,omitempty"`
	Properties           *PurchaseRequest `json:"properties,omitempty"`
	BillingCurrencyTotal *Price           `json:"billingCurrencyTotal,omitempty"`
	// Status - Possible values include: 'OperationStatusSucceeded', 'OperationStatusFailed', 'OperationStatusCancelled', 'OperationStatusPending'
	Status OperationStatus `json:"status,omitempty"`
}

ToPurchaseExchange reservation purchase details

type ToReturn 

type ToReturn struct {
	// ReservationID - Fully qualified identifier of the Reservation being returned
	ReservationID *string `json:"reservationId,omitempty"`
	// Quantity - Quantity to be returned. Must be greater than zero.
	Quantity *int32 `json:"quantity,omitempty"`
}

ToReturn reservation to return

type ToReturnForExchange 

type ToReturnForExchange struct {
	// ReservationID - Fully qualified id of the Reservation being returned.
	ReservationID *string `json:"reservationId,omitempty"`
	// Quantity - Quantity to be returned
	Quantity            *int32              `json:"quantity,omitempty"`
	BillingRefundAmount *Price              `json:"billingRefundAmount,omitempty"`
	BillingInformation  *BillingInformation `json:"billingInformation,omitempty"`
	// Status - Possible values include: 'OperationStatusSucceeded', 'OperationStatusFailed', 'OperationStatusCancelled', 'OperationStatusPending'
	Status OperationStatus `json:"status,omitempty"`
}

ToReturnForExchange reservation refund details

type UserFriendlyAppliedScopeType 

type UserFriendlyAppliedScopeType string

UserFriendlyAppliedScopeType enumerates the values for user friendly applied scope type. 

const (
	// UserFriendlyAppliedScopeTypeManagementGroup ...
	UserFriendlyAppliedScopeTypeManagementGroup UserFriendlyAppliedScopeType = "ManagementGroup"
	// UserFriendlyAppliedScopeTypeNone ...
	UserFriendlyAppliedScopeTypeNone UserFriendlyAppliedScopeType = "None"
	// UserFriendlyAppliedScopeTypeResourceGroup ...
	UserFriendlyAppliedScopeTypeResourceGroup UserFriendlyAppliedScopeType = "ResourceGroup"
	// UserFriendlyAppliedScopeTypeShared ...
	UserFriendlyAppliedScopeTypeShared UserFriendlyAppliedScopeType = "Shared"
	// UserFriendlyAppliedScopeTypeSingle ...
	UserFriendlyAppliedScopeTypeSingle UserFriendlyAppliedScopeType = "Single"
)

func PossibleUserFriendlyAppliedScopeTypeValues 

func PossibleUserFriendlyAppliedScopeTypeValues() []UserFriendlyAppliedScopeType

PossibleUserFriendlyAppliedScopeTypeValues returns an array of possible values for the UserFriendlyAppliedScopeType const type.

type UserFriendlyRenewState 

type UserFriendlyRenewState string

UserFriendlyRenewState enumerates the values for user friendly renew state. 

const (
	// UserFriendlyRenewStateNotApplicable ...
	UserFriendlyRenewStateNotApplicable UserFriendlyRenewState = "NotApplicable"
	// UserFriendlyRenewStateNotRenewed ...
	UserFriendlyRenewStateNotRenewed UserFriendlyRenewState = "NotRenewed"
	// UserFriendlyRenewStateOff ...
	UserFriendlyRenewStateOff UserFriendlyRenewState = "Off"
	// UserFriendlyRenewStateOn ...
	UserFriendlyRenewStateOn UserFriendlyRenewState = "On"
	// UserFriendlyRenewStateRenewed ...
	UserFriendlyRenewStateRenewed UserFriendlyRenewState = "Renewed"
)

func PossibleUserFriendlyRenewStateValues 

func PossibleUserFriendlyRenewStateValues() []UserFriendlyRenewState

PossibleUserFriendlyRenewStateValues returns an array of possible values for the UserFriendlyRenewState const type.

type UtilizationAggregates 

type UtilizationAggregates struct {
	// Grain - READ-ONLY; The grain of the aggregate
	Grain *float64 `json:"grain,omitempty"`
	// GrainUnit - READ-ONLY; The grain unit of the aggregate
	GrainUnit *string `json:"grainUnit,omitempty"`
	// Value - READ-ONLY; The aggregate value
	Value *float64 `json:"value,omitempty"`
	// ValueUnit - READ-ONLY; The aggregate value unit
	ValueUnit *string `json:"valueUnit,omitempty"`
}

UtilizationAggregates the aggregate values of reservation utilization

func (UtilizationAggregates) MarshalJSON 

func (ua UtilizationAggregates) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UtilizationAggregates.

Source Files

View all Source files

Directories

Path Synopsis
Deprecated: Please note, this package has been deprecated.
 Deprecated: Please note, this package has been deprecated.

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.