edgeorder

package
v65.0.0+incompatible Latest Latest
Warning

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

Go to latest
Published: May 24, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package edgeorder implements the Azure ARM Edgeorder service API version 2021-12-01.

Edge Order API's

Index

Constants

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

type ActionStatusEnum string

ActionStatusEnum enumerates the values for action status enum.

const (
	// ActionStatusEnumAllowed Allowed flag.
	ActionStatusEnumAllowed ActionStatusEnum = "Allowed"
	// ActionStatusEnumNotAllowed Not Allowed flag.
	ActionStatusEnumNotAllowed ActionStatusEnum = "NotAllowed"
)

func PossibleActionStatusEnumValues

func PossibleActionStatusEnumValues() []ActionStatusEnum

PossibleActionStatusEnumValues returns an array of possible values for the ActionStatusEnum const type.

type ActionType

type ActionType string

ActionType enumerates the values for action type.

const (
	// ActionTypeInternal ...
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns an array of possible values for the ActionType const type.

type AddressDetails

type AddressDetails struct {
	// ForwardAddress - Customer address and contact details. It should be address resource
	ForwardAddress *AddressProperties `json:"forwardAddress,omitempty"`
	// ReturnAddress - READ-ONLY; Return shipping address
	ReturnAddress *AddressProperties `json:"returnAddress,omitempty"`
}

AddressDetails address details for an order item.

func (AddressDetails) MarshalJSON

func (ad AddressDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddressDetails.

type AddressProperties

type AddressProperties struct {
	// ShippingAddress - Shipping details for the address
	ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
	// ContactDetails - Contact details for the address
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
	// AddressValidationStatus - READ-ONLY; Status of address validation. Possible values include: 'AddressValidationStatusValid', 'AddressValidationStatusInvalid', 'AddressValidationStatusAmbiguous'
	AddressValidationStatus AddressValidationStatus `json:"addressValidationStatus,omitempty"`
}

AddressProperties address Properties

func (AddressProperties) MarshalJSON

func (ap AddressProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddressProperties.

type AddressResource

type AddressResource struct {
	autorest.Response `json:"-"`
	// AddressProperties - Properties of an address.
	*AddressProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; Represents resource creation and update time
	SystemData *SystemData `json:"systemData,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AddressResource address Resource.

func (AddressResource) MarshalJSON

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

MarshalJSON is the custom marshaler for AddressResource.

func (*AddressResource) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for AddressResource struct.

type AddressResourceList

type AddressResourceList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of address resources.
	Value *[]AddressResource `json:"value,omitempty"`
	// NextLink - Link for the next set of job resources.
	NextLink *string `json:"nextLink,omitempty"`
}

AddressResourceList address Resource Collection

func (AddressResourceList) IsEmpty

func (arl AddressResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (AddressResourceList) MarshalJSON

func (arl AddressResourceList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddressResourceList.

type AddressResourceListIterator

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

AddressResourceListIterator provides access to a complete listing of AddressResource values.

func NewAddressResourceListIterator

func NewAddressResourceListIterator(page AddressResourceListPage) AddressResourceListIterator

Creates a new instance of the AddressResourceListIterator type.

func (*AddressResourceListIterator) Next

func (iter *AddressResourceListIterator) 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 (*AddressResourceListIterator) NextWithContext

func (iter *AddressResourceListIterator) 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 (AddressResourceListIterator) NotDone

func (iter AddressResourceListIterator) NotDone() bool

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

func (AddressResourceListIterator) Response

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

func (AddressResourceListIterator) Value

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

type AddressResourceListPage

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

AddressResourceListPage contains a page of AddressResource values.

func NewAddressResourceListPage

func NewAddressResourceListPage(cur AddressResourceList, getNextPage func(context.Context, AddressResourceList) (AddressResourceList, error)) AddressResourceListPage

Creates a new instance of the AddressResourceListPage type.

func (*AddressResourceListPage) Next

func (page *AddressResourceListPage) 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 (*AddressResourceListPage) NextWithContext

func (page *AddressResourceListPage) 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 (AddressResourceListPage) NotDone

func (page AddressResourceListPage) NotDone() bool

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

func (AddressResourceListPage) Response

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

func (AddressResourceListPage) Values

func (page AddressResourceListPage) Values() []AddressResource

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

type AddressType

type AddressType string

AddressType enumerates the values for address type.

const (
	// AddressTypeCommercial Commercial Address.
	AddressTypeCommercial AddressType = "Commercial"
	// AddressTypeNone Address type not known.
	AddressTypeNone AddressType = "None"
	// AddressTypeResidential Residential Address.
	AddressTypeResidential AddressType = "Residential"
)

func PossibleAddressTypeValues

func PossibleAddressTypeValues() []AddressType

PossibleAddressTypeValues returns an array of possible values for the AddressType const type.

type AddressUpdateParameter

type AddressUpdateParameter struct {
	// AddressUpdateProperties - Properties of a address to be updated.
	*AddressUpdateProperties `json:"properties,omitempty"`
	// Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
	Tags map[string]*string `json:"tags"`
}

AddressUpdateParameter the Address update parameters

func (AddressUpdateParameter) MarshalJSON

func (aup AddressUpdateParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddressUpdateParameter.

func (*AddressUpdateParameter) UnmarshalJSON

func (aup *AddressUpdateParameter) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AddressUpdateParameter struct.

type AddressUpdateProperties

type AddressUpdateProperties struct {
	// ShippingAddress - Shipping details for the address
	ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
	// ContactDetails - Contact details for the address
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
}

AddressUpdateProperties address Properties

type AddressValidationStatus

type AddressValidationStatus string

AddressValidationStatus enumerates the values for address validation status.

const (
	// AddressValidationStatusAmbiguous Address provided is ambiguous, please choose one of the alternate
	// addresses returned.
	AddressValidationStatusAmbiguous AddressValidationStatus = "Ambiguous"
	// AddressValidationStatusInvalid Address provided is invalid or not supported.
	AddressValidationStatusInvalid AddressValidationStatus = "Invalid"
	// AddressValidationStatusValid Address provided is valid.
	AddressValidationStatusValid AddressValidationStatus = "Valid"
)

func PossibleAddressValidationStatusValues

func PossibleAddressValidationStatusValues() []AddressValidationStatus

PossibleAddressValidationStatusValues returns an array of possible values for the AddressValidationStatus const type.

type AvailabilityInformation

type AvailabilityInformation struct {
	// AvailabilityStage - READ-ONLY; Current availability stage of the product. Availability stage. Possible values include: 'AvailabilityStageAvailable', 'AvailabilityStageComingSoon', 'AvailabilityStagePreview', 'AvailabilityStageDeprecated', 'AvailabilityStageSignup', 'AvailabilityStageUnavailable'
	AvailabilityStage AvailabilityStage `json:"availabilityStage,omitempty"`
	// DisabledReason - READ-ONLY; Reason why the product is disabled. Possible values include: 'DisabledReasonNone', 'DisabledReasonCountry', 'DisabledReasonRegion', 'DisabledReasonFeature', 'DisabledReasonOfferType', 'DisabledReasonNoSubscriptionInfo', 'DisabledReasonNotAvailable', 'DisabledReasonOutOfStock'
	DisabledReason DisabledReason `json:"disabledReason,omitempty"`
	// DisabledReasonMessage - READ-ONLY; Message for why the product is disabled.
	DisabledReasonMessage *string `json:"disabledReasonMessage,omitempty"`
}

AvailabilityInformation availability information of a product system.

func (AvailabilityInformation) MarshalJSON

func (ai AvailabilityInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AvailabilityInformation.

type AvailabilityStage

type AvailabilityStage string

AvailabilityStage enumerates the values for availability stage.

const (
	// AvailabilityStageAvailable Product is available.
	AvailabilityStageAvailable AvailabilityStage = "Available"
	// AvailabilityStageComingSoon Product is coming soon.
	AvailabilityStageComingSoon AvailabilityStage = "ComingSoon"
	// AvailabilityStageDeprecated Product is deprecated.
	AvailabilityStageDeprecated AvailabilityStage = "Deprecated"
	// AvailabilityStagePreview Product is in preview.
	AvailabilityStagePreview AvailabilityStage = "Preview"
	// AvailabilityStageSignup Product is available only on signup.
	AvailabilityStageSignup AvailabilityStage = "Signup"
	// AvailabilityStageUnavailable Product is not available.
	AvailabilityStageUnavailable AvailabilityStage = "Unavailable"
)

func PossibleAvailabilityStageValues

func PossibleAvailabilityStageValues() []AvailabilityStage

PossibleAvailabilityStageValues returns an array of possible values for the AvailabilityStage const type.

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Edgeorder.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client 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) CancelOrderItem

func (client BaseClient) CancelOrderItem(ctx context.Context, orderItemName string, resourceGroupName string, cancellationReason CancellationReason) (result autorest.Response, err error)

CancelOrderItem cancel order item. Parameters: orderItemName - the name of the order item resourceGroupName - the name of the resource group. The name is case insensitive. cancellationReason - reason for cancellation.

func (BaseClient) CancelOrderItemPreparer

func (client BaseClient) CancelOrderItemPreparer(ctx context.Context, orderItemName string, resourceGroupName string, cancellationReason CancellationReason) (*http.Request, error)

CancelOrderItemPreparer prepares the CancelOrderItem request.

func (BaseClient) CancelOrderItemResponder

func (client BaseClient) CancelOrderItemResponder(resp *http.Response) (result autorest.Response, err error)

CancelOrderItemResponder handles the response to the CancelOrderItem request. The method always closes the http.Response Body.

func (BaseClient) CancelOrderItemSender

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

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

func (BaseClient) CreateAddress

func (client BaseClient) CreateAddress(ctx context.Context, addressName string, resourceGroupName string, addressResource AddressResource) (result CreateAddressFuture, err error)

CreateAddress creates a new address with the specified parameters. Existing address can be updated with this API Parameters: addressName - the name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only resourceGroupName - the name of the resource group. The name is case insensitive. addressResource - address details from request body.

func (BaseClient) CreateAddressPreparer

func (client BaseClient) CreateAddressPreparer(ctx context.Context, addressName string, resourceGroupName string, addressResource AddressResource) (*http.Request, error)

CreateAddressPreparer prepares the CreateAddress request.

func (BaseClient) CreateAddressResponder

func (client BaseClient) CreateAddressResponder(resp *http.Response) (result AddressResource, err error)

CreateAddressResponder handles the response to the CreateAddress request. The method always closes the http.Response Body.

func (BaseClient) CreateAddressSender

func (client BaseClient) CreateAddressSender(req *http.Request) (future CreateAddressFuture, err error)

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

func (BaseClient) CreateOrderItem

func (client BaseClient) CreateOrderItem(ctx context.Context, orderItemName string, resourceGroupName string, orderItemResource OrderItemResource) (result CreateOrderItemFuture, err error)

CreateOrderItem creates an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API. Parameters: orderItemName - the name of the order item resourceGroupName - the name of the resource group. The name is case insensitive. orderItemResource - order item details from request body.

func (BaseClient) CreateOrderItemPreparer

func (client BaseClient) CreateOrderItemPreparer(ctx context.Context, orderItemName string, resourceGroupName string, orderItemResource OrderItemResource) (*http.Request, error)

CreateOrderItemPreparer prepares the CreateOrderItem request.

func (BaseClient) CreateOrderItemResponder

func (client BaseClient) CreateOrderItemResponder(resp *http.Response) (result OrderItemResource, err error)

CreateOrderItemResponder handles the response to the CreateOrderItem request. The method always closes the http.Response Body.

func (BaseClient) CreateOrderItemSender

func (client BaseClient) CreateOrderItemSender(req *http.Request) (future CreateOrderItemFuture, err error)

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

func (BaseClient) DeleteAddressByName

func (client BaseClient) DeleteAddressByName(ctx context.Context, addressName string, resourceGroupName string) (result DeleteAddressByNameFuture, err error)

DeleteAddressByName deletes an address. Parameters: addressName - the name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only resourceGroupName - the name of the resource group. The name is case insensitive.

func (BaseClient) DeleteAddressByNamePreparer

func (client BaseClient) DeleteAddressByNamePreparer(ctx context.Context, addressName string, resourceGroupName string) (*http.Request, error)

DeleteAddressByNamePreparer prepares the DeleteAddressByName request.

func (BaseClient) DeleteAddressByNameResponder

func (client BaseClient) DeleteAddressByNameResponder(resp *http.Response) (result autorest.Response, err error)

DeleteAddressByNameResponder handles the response to the DeleteAddressByName request. The method always closes the http.Response Body.

func (BaseClient) DeleteAddressByNameSender

func (client BaseClient) DeleteAddressByNameSender(req *http.Request) (future DeleteAddressByNameFuture, err error)

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

func (BaseClient) DeleteOrderItemByName

func (client BaseClient) DeleteOrderItemByName(ctx context.Context, orderItemName string, resourceGroupName string) (result DeleteOrderItemByNameFuture, err error)

DeleteOrderItemByName deletes an order item. Parameters: orderItemName - the name of the order item resourceGroupName - the name of the resource group. The name is case insensitive.

func (BaseClient) DeleteOrderItemByNamePreparer

func (client BaseClient) DeleteOrderItemByNamePreparer(ctx context.Context, orderItemName string, resourceGroupName string) (*http.Request, error)

DeleteOrderItemByNamePreparer prepares the DeleteOrderItemByName request.

func (BaseClient) DeleteOrderItemByNameResponder

func (client BaseClient) DeleteOrderItemByNameResponder(resp *http.Response) (result autorest.Response, err error)

DeleteOrderItemByNameResponder handles the response to the DeleteOrderItemByName request. The method always closes the http.Response Body.

func (BaseClient) DeleteOrderItemByNameSender

func (client BaseClient) DeleteOrderItemByNameSender(req *http.Request) (future DeleteOrderItemByNameFuture, err error)

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

func (BaseClient) GetAddressByName

func (client BaseClient) GetAddressByName(ctx context.Context, addressName string, resourceGroupName string) (result AddressResource, err error)

GetAddressByName gets information about the specified address. Parameters: addressName - the name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only resourceGroupName - the name of the resource group. The name is case insensitive.

func (BaseClient) GetAddressByNamePreparer

func (client BaseClient) GetAddressByNamePreparer(ctx context.Context, addressName string, resourceGroupName string) (*http.Request, error)

GetAddressByNamePreparer prepares the GetAddressByName request.

func (BaseClient) GetAddressByNameResponder

func (client BaseClient) GetAddressByNameResponder(resp *http.Response) (result AddressResource, err error)

GetAddressByNameResponder handles the response to the GetAddressByName request. The method always closes the http.Response Body.

func (BaseClient) GetAddressByNameSender

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

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

func (BaseClient) GetOrderByName

func (client BaseClient) GetOrderByName(ctx context.Context, orderName string, resourceGroupName string, location string) (result OrderResource, err error)

GetOrderByName gets an order. Parameters: orderName - the name of the order resourceGroupName - the name of the resource group. The name is case insensitive. location - the name of Azure region.

func (BaseClient) GetOrderByNamePreparer

func (client BaseClient) GetOrderByNamePreparer(ctx context.Context, orderName string, resourceGroupName string, location string) (*http.Request, error)

GetOrderByNamePreparer prepares the GetOrderByName request.

func (BaseClient) GetOrderByNameResponder

func (client BaseClient) GetOrderByNameResponder(resp *http.Response) (result OrderResource, err error)

GetOrderByNameResponder handles the response to the GetOrderByName request. The method always closes the http.Response Body.

func (BaseClient) GetOrderByNameSender

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

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

func (BaseClient) GetOrderItemByName

func (client BaseClient) GetOrderItemByName(ctx context.Context, orderItemName string, resourceGroupName string, expand string) (result OrderItemResource, err error)

GetOrderItemByName gets an order item. Parameters: orderItemName - the name of the order item resourceGroupName - the name of the resource group. The name is case insensitive. expand - $expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.

func (BaseClient) GetOrderItemByNamePreparer

func (client BaseClient) GetOrderItemByNamePreparer(ctx context.Context, orderItemName string, resourceGroupName string, expand string) (*http.Request, error)

GetOrderItemByNamePreparer prepares the GetOrderItemByName request.

func (BaseClient) GetOrderItemByNameResponder

func (client BaseClient) GetOrderItemByNameResponder(resp *http.Response) (result OrderItemResource, err error)

GetOrderItemByNameResponder handles the response to the GetOrderItemByName request. The method always closes the http.Response Body.

func (BaseClient) GetOrderItemByNameSender

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

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

func (BaseClient) ListAddressesAtResourceGroupLevel

func (client BaseClient) ListAddressesAtResourceGroupLevel(ctx context.Context, resourceGroupName string, filter string, skipToken string) (result AddressResourceListPage, err error)

ListAddressesAtResourceGroupLevel lists all the addresses available under the given resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. filter - $filter is supported to filter based on shipping address properties. Filter supports only equals operation. skipToken - $skipToken is supported on Get list of addresses, which provides the next page in the list of address.

func (BaseClient) ListAddressesAtResourceGroupLevelComplete

func (client BaseClient) ListAddressesAtResourceGroupLevelComplete(ctx context.Context, resourceGroupName string, filter string, skipToken string) (result AddressResourceListIterator, err error)

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

func (BaseClient) ListAddressesAtResourceGroupLevelPreparer

func (client BaseClient) ListAddressesAtResourceGroupLevelPreparer(ctx context.Context, resourceGroupName string, filter string, skipToken string) (*http.Request, error)

ListAddressesAtResourceGroupLevelPreparer prepares the ListAddressesAtResourceGroupLevel request.

func (BaseClient) ListAddressesAtResourceGroupLevelResponder

func (client BaseClient) ListAddressesAtResourceGroupLevelResponder(resp *http.Response) (result AddressResourceList, err error)

ListAddressesAtResourceGroupLevelResponder handles the response to the ListAddressesAtResourceGroupLevel request. The method always closes the http.Response Body.

func (BaseClient) ListAddressesAtResourceGroupLevelSender

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

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

func (BaseClient) ListAddressesAtSubscriptionLevel

func (client BaseClient) ListAddressesAtSubscriptionLevel(ctx context.Context, filter string, skipToken string) (result AddressResourceListPage, err error)

ListAddressesAtSubscriptionLevel lists all the addresses available under the subscription. Parameters: filter - $filter is supported to filter based on shipping address properties. Filter supports only equals operation. skipToken - $skipToken is supported on Get list of addresses, which provides the next page in the list of addresses.

func (BaseClient) ListAddressesAtSubscriptionLevelComplete

func (client BaseClient) ListAddressesAtSubscriptionLevelComplete(ctx context.Context, filter string, skipToken string) (result AddressResourceListIterator, err error)

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

func (BaseClient) ListAddressesAtSubscriptionLevelPreparer

func (client BaseClient) ListAddressesAtSubscriptionLevelPreparer(ctx context.Context, filter string, skipToken string) (*http.Request, error)

ListAddressesAtSubscriptionLevelPreparer prepares the ListAddressesAtSubscriptionLevel request.

func (BaseClient) ListAddressesAtSubscriptionLevelResponder

func (client BaseClient) ListAddressesAtSubscriptionLevelResponder(resp *http.Response) (result AddressResourceList, err error)

ListAddressesAtSubscriptionLevelResponder handles the response to the ListAddressesAtSubscriptionLevel request. The method always closes the http.Response Body.

func (BaseClient) ListAddressesAtSubscriptionLevelSender

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

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

func (BaseClient) ListConfigurations

func (client BaseClient) ListConfigurations(ctx context.Context, configurationsRequest ConfigurationsRequest, skipToken string) (result ConfigurationsPage, err error)

ListConfigurations this method provides the list of configurations for the given product family, product line and product under subscription. Parameters: configurationsRequest - filters for showing the configurations. skipToken - $skipToken is supported on list of configurations, which provides the next page in the list of configurations.

func (BaseClient) ListConfigurationsComplete

func (client BaseClient) ListConfigurationsComplete(ctx context.Context, configurationsRequest ConfigurationsRequest, skipToken string) (result ConfigurationsIterator, err error)

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

func (BaseClient) ListConfigurationsPreparer

func (client BaseClient) ListConfigurationsPreparer(ctx context.Context, configurationsRequest ConfigurationsRequest, skipToken string) (*http.Request, error)

ListConfigurationsPreparer prepares the ListConfigurations request.

func (BaseClient) ListConfigurationsResponder

func (client BaseClient) ListConfigurationsResponder(resp *http.Response) (result Configurations, err error)

ListConfigurationsResponder handles the response to the ListConfigurations request. The method always closes the http.Response Body.

func (BaseClient) ListConfigurationsSender

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

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

func (BaseClient) ListOperations

func (client BaseClient) ListOperations(ctx context.Context) (result OperationListResultPage, err error)

ListOperations this method gets all the operations that are exposed for customer.

func (BaseClient) ListOperationsComplete

func (client BaseClient) ListOperationsComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (BaseClient) ListOperationsPreparer

func (client BaseClient) ListOperationsPreparer(ctx context.Context) (*http.Request, error)

ListOperationsPreparer prepares the ListOperations request.

func (BaseClient) ListOperationsResponder

func (client BaseClient) ListOperationsResponder(resp *http.Response) (result OperationListResult, err error)

ListOperationsResponder handles the response to the ListOperations request. The method always closes the http.Response Body.

func (BaseClient) ListOperationsSender

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

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

func (BaseClient) ListOrderAtResourceGroupLevel

func (client BaseClient) ListOrderAtResourceGroupLevel(ctx context.Context, resourceGroupName string, skipToken string) (result OrderResourceListPage, err error)

ListOrderAtResourceGroupLevel lists order at resource group level. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. skipToken - $skipToken is supported on Get list of order, which provides the next page in the list of order.

func (BaseClient) ListOrderAtResourceGroupLevelComplete

func (client BaseClient) ListOrderAtResourceGroupLevelComplete(ctx context.Context, resourceGroupName string, skipToken string) (result OrderResourceListIterator, err error)

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

func (BaseClient) ListOrderAtResourceGroupLevelPreparer

func (client BaseClient) ListOrderAtResourceGroupLevelPreparer(ctx context.Context, resourceGroupName string, skipToken string) (*http.Request, error)

ListOrderAtResourceGroupLevelPreparer prepares the ListOrderAtResourceGroupLevel request.

func (BaseClient) ListOrderAtResourceGroupLevelResponder

func (client BaseClient) ListOrderAtResourceGroupLevelResponder(resp *http.Response) (result OrderResourceList, err error)

ListOrderAtResourceGroupLevelResponder handles the response to the ListOrderAtResourceGroupLevel request. The method always closes the http.Response Body.

func (BaseClient) ListOrderAtResourceGroupLevelSender

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

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

func (BaseClient) ListOrderAtSubscriptionLevel

func (client BaseClient) ListOrderAtSubscriptionLevel(ctx context.Context, skipToken string) (result OrderResourceListPage, err error)

ListOrderAtSubscriptionLevel lists order at subscription level. Parameters: skipToken - $skipToken is supported on Get list of order, which provides the next page in the list of order.

func (BaseClient) ListOrderAtSubscriptionLevelComplete

func (client BaseClient) ListOrderAtSubscriptionLevelComplete(ctx context.Context, skipToken string) (result OrderResourceListIterator, err error)

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

func (BaseClient) ListOrderAtSubscriptionLevelPreparer

func (client BaseClient) ListOrderAtSubscriptionLevelPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListOrderAtSubscriptionLevelPreparer prepares the ListOrderAtSubscriptionLevel request.

func (BaseClient) ListOrderAtSubscriptionLevelResponder

func (client BaseClient) ListOrderAtSubscriptionLevelResponder(resp *http.Response) (result OrderResourceList, err error)

ListOrderAtSubscriptionLevelResponder handles the response to the ListOrderAtSubscriptionLevel request. The method always closes the http.Response Body.

func (BaseClient) ListOrderAtSubscriptionLevelSender

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

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

func (BaseClient) ListOrderItemsAtResourceGroupLevel

func (client BaseClient) ListOrderItemsAtResourceGroupLevel(ctx context.Context, resourceGroupName string, filter string, expand string, skipToken string) (result OrderItemResourceListPage, err error)

ListOrderItemsAtResourceGroupLevel lists order item at resource group level. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. filter - $filter is supported to filter based on order id. Filter supports only equals operation. expand - $expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. skipToken - $skipToken is supported on Get list of order items, which provides the next page in the list of order items.

func (BaseClient) ListOrderItemsAtResourceGroupLevelComplete

func (client BaseClient) ListOrderItemsAtResourceGroupLevelComplete(ctx context.Context, resourceGroupName string, filter string, expand string, skipToken string) (result OrderItemResourceListIterator, err error)

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

func (BaseClient) ListOrderItemsAtResourceGroupLevelPreparer

func (client BaseClient) ListOrderItemsAtResourceGroupLevelPreparer(ctx context.Context, resourceGroupName string, filter string, expand string, skipToken string) (*http.Request, error)

ListOrderItemsAtResourceGroupLevelPreparer prepares the ListOrderItemsAtResourceGroupLevel request.

func (BaseClient) ListOrderItemsAtResourceGroupLevelResponder

func (client BaseClient) ListOrderItemsAtResourceGroupLevelResponder(resp *http.Response) (result OrderItemResourceList, err error)

ListOrderItemsAtResourceGroupLevelResponder handles the response to the ListOrderItemsAtResourceGroupLevel request. The method always closes the http.Response Body.

func (BaseClient) ListOrderItemsAtResourceGroupLevelSender

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

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

func (BaseClient) ListOrderItemsAtSubscriptionLevel

func (client BaseClient) ListOrderItemsAtSubscriptionLevel(ctx context.Context, filter string, expand string, skipToken string) (result OrderItemResourceListPage, err error)

ListOrderItemsAtSubscriptionLevel lists order item at subscription level. Parameters: filter - $filter is supported to filter based on order id. Filter supports only equals operation. expand - $expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. skipToken - $skipToken is supported on Get list of order items, which provides the next page in the list of order items.

func (BaseClient) ListOrderItemsAtSubscriptionLevelComplete

func (client BaseClient) ListOrderItemsAtSubscriptionLevelComplete(ctx context.Context, filter string, expand string, skipToken string) (result OrderItemResourceListIterator, err error)

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

func (BaseClient) ListOrderItemsAtSubscriptionLevelPreparer

func (client BaseClient) ListOrderItemsAtSubscriptionLevelPreparer(ctx context.Context, filter string, expand string, skipToken string) (*http.Request, error)

ListOrderItemsAtSubscriptionLevelPreparer prepares the ListOrderItemsAtSubscriptionLevel request.

func (BaseClient) ListOrderItemsAtSubscriptionLevelResponder

func (client BaseClient) ListOrderItemsAtSubscriptionLevelResponder(resp *http.Response) (result OrderItemResourceList, err error)

ListOrderItemsAtSubscriptionLevelResponder handles the response to the ListOrderItemsAtSubscriptionLevel request. The method always closes the http.Response Body.

func (BaseClient) ListOrderItemsAtSubscriptionLevelSender

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

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

func (BaseClient) ListProductFamilies

func (client BaseClient) ListProductFamilies(ctx context.Context, productFamiliesRequest ProductFamiliesRequest, expand string, skipToken string) (result ProductFamiliesPage, err error)

ListProductFamilies this method provides the list of product families for the given subscription. Parameters: productFamiliesRequest - filters for showing the product families. expand - $expand is supported on configurations parameter for product, which provides details on the configurations for the product. skipToken - $skipToken is supported on list of product families, which provides the next page in the list of product families.

func (BaseClient) ListProductFamiliesComplete

func (client BaseClient) ListProductFamiliesComplete(ctx context.Context, productFamiliesRequest ProductFamiliesRequest, expand string, skipToken string) (result ProductFamiliesIterator, err error)

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

func (BaseClient) ListProductFamiliesMetadata

func (client BaseClient) ListProductFamiliesMetadata(ctx context.Context, skipToken string) (result ProductFamiliesMetadataPage, err error)

ListProductFamiliesMetadata this method provides the list of product families metadata for the given subscription. Parameters: skipToken - $skipToken is supported on list of product families metadata, which provides the next page in the list of product families metadata.

func (BaseClient) ListProductFamiliesMetadataComplete

func (client BaseClient) ListProductFamiliesMetadataComplete(ctx context.Context, skipToken string) (result ProductFamiliesMetadataIterator, err error)

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

func (BaseClient) ListProductFamiliesMetadataPreparer

func (client BaseClient) ListProductFamiliesMetadataPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListProductFamiliesMetadataPreparer prepares the ListProductFamiliesMetadata request.

func (BaseClient) ListProductFamiliesMetadataResponder

func (client BaseClient) ListProductFamiliesMetadataResponder(resp *http.Response) (result ProductFamiliesMetadata, err error)

ListProductFamiliesMetadataResponder handles the response to the ListProductFamiliesMetadata request. The method always closes the http.Response Body.

func (BaseClient) ListProductFamiliesMetadataSender

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

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

func (BaseClient) ListProductFamiliesPreparer

func (client BaseClient) ListProductFamiliesPreparer(ctx context.Context, productFamiliesRequest ProductFamiliesRequest, expand string, skipToken string) (*http.Request, error)

ListProductFamiliesPreparer prepares the ListProductFamilies request.

func (BaseClient) ListProductFamiliesResponder

func (client BaseClient) ListProductFamiliesResponder(resp *http.Response) (result ProductFamilies, err error)

ListProductFamiliesResponder handles the response to the ListProductFamilies request. The method always closes the http.Response Body.

func (BaseClient) ListProductFamiliesSender

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

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

func (BaseClient) ReturnOrderItem

func (client BaseClient) ReturnOrderItem(ctx context.Context, orderItemName string, resourceGroupName string, returnOrderItemDetails ReturnOrderItemDetails) (result ReturnOrderItemFuture, err error)

ReturnOrderItem return order item. Parameters: orderItemName - the name of the order item resourceGroupName - the name of the resource group. The name is case insensitive. returnOrderItemDetails - return order item CurrentStatus.

func (BaseClient) ReturnOrderItemPreparer

func (client BaseClient) ReturnOrderItemPreparer(ctx context.Context, orderItemName string, resourceGroupName string, returnOrderItemDetails ReturnOrderItemDetails) (*http.Request, error)

ReturnOrderItemPreparer prepares the ReturnOrderItem request.

func (BaseClient) ReturnOrderItemResponder

func (client BaseClient) ReturnOrderItemResponder(resp *http.Response) (result autorest.Response, err error)

ReturnOrderItemResponder handles the response to the ReturnOrderItem request. The method always closes the http.Response Body.

func (BaseClient) ReturnOrderItemSender

func (client BaseClient) ReturnOrderItemSender(req *http.Request) (future ReturnOrderItemFuture, err error)

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

func (BaseClient) UpdateAddress

func (client BaseClient) UpdateAddress(ctx context.Context, addressName string, resourceGroupName string, addressUpdateParameter AddressUpdateParameter, ifMatch string) (result UpdateAddressFuture, err error)

UpdateAddress updates the properties of an existing address. Parameters: addressName - the name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only resourceGroupName - the name of the resource group. The name is case insensitive. addressUpdateParameter - address update parameters from request body. ifMatch - defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.

func (BaseClient) UpdateAddressPreparer

func (client BaseClient) UpdateAddressPreparer(ctx context.Context, addressName string, resourceGroupName string, addressUpdateParameter AddressUpdateParameter, ifMatch string) (*http.Request, error)

UpdateAddressPreparer prepares the UpdateAddress request.

func (BaseClient) UpdateAddressResponder

func (client BaseClient) UpdateAddressResponder(resp *http.Response) (result AddressResource, err error)

UpdateAddressResponder handles the response to the UpdateAddress request. The method always closes the http.Response Body.

func (BaseClient) UpdateAddressSender

func (client BaseClient) UpdateAddressSender(req *http.Request) (future UpdateAddressFuture, err error)

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

func (BaseClient) UpdateOrderItem

func (client BaseClient) UpdateOrderItem(ctx context.Context, orderItemName string, resourceGroupName string, orderItemUpdateParameter OrderItemUpdateParameter, ifMatch string) (result UpdateOrderItemFuture, err error)

UpdateOrderItem updates the properties of an existing order item. Parameters: orderItemName - the name of the order item resourceGroupName - the name of the resource group. The name is case insensitive. orderItemUpdateParameter - order item update parameters from request body. ifMatch - defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.

func (BaseClient) UpdateOrderItemPreparer

func (client BaseClient) UpdateOrderItemPreparer(ctx context.Context, orderItemName string, resourceGroupName string, orderItemUpdateParameter OrderItemUpdateParameter, ifMatch string) (*http.Request, error)

UpdateOrderItemPreparer prepares the UpdateOrderItem request.

func (BaseClient) UpdateOrderItemResponder

func (client BaseClient) UpdateOrderItemResponder(resp *http.Response) (result OrderItemResource, err error)

UpdateOrderItemResponder handles the response to the UpdateOrderItem request. The method always closes the http.Response Body.

func (BaseClient) UpdateOrderItemSender

func (client BaseClient) UpdateOrderItemSender(req *http.Request) (future UpdateOrderItemFuture, err error)

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

type BasicInformation

type BasicInformation struct {
	// DisplayName - READ-ONLY; Display Name for the product system.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - READ-ONLY; Description related to the product system.
	Description *Description `json:"description,omitempty"`
	// ImageInformation - READ-ONLY; Image information for the product system.
	ImageInformation *[]ImageInformation `json:"imageInformation,omitempty"`
	// CostInformation - READ-ONLY; Cost information for the product system.
	CostInformation *CostInformation `json:"costInformation,omitempty"`
	// AvailabilityInformation - READ-ONLY; Availability information of the product system.
	AvailabilityInformation *AvailabilityInformation `json:"availabilityInformation,omitempty"`
	// HierarchyInformation - READ-ONLY; Hierarchy information of a product.
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
}

BasicInformation basic information for any product system

func (BasicInformation) MarshalJSON

func (bi BasicInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BasicInformation.

type BasicMeterDetails

type BasicMeterDetails interface {
	AsPav2MeterDetails() (*Pav2MeterDetails, bool)
	AsPurchaseMeterDetails() (*PurchaseMeterDetails, bool)
	AsMeterDetails() (*MeterDetails, bool)
}

BasicMeterDetails holds details about billing type and its meter guids

type BillingMeterDetails

type BillingMeterDetails struct {
	// Name - READ-ONLY; Represents Billing type name
	Name *string `json:"name,omitempty"`
	// MeterDetails - READ-ONLY; Represents MeterDetails
	MeterDetails BasicMeterDetails `json:"meterDetails,omitempty"`
	// MeteringType - READ-ONLY; Represents Metering type (eg one-time or recurrent). Possible values include: 'MeteringTypeOneTime', 'MeteringTypeRecurring', 'MeteringTypeAdhoc'
	MeteringType MeteringType `json:"meteringType,omitempty"`
	// Frequency - READ-ONLY; Frequency of recurrence
	Frequency *string `json:"frequency,omitempty"`
}

BillingMeterDetails holds billing meter details for each type of billing

func (BillingMeterDetails) MarshalJSON

func (bmd BillingMeterDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BillingMeterDetails.

func (*BillingMeterDetails) UnmarshalJSON

func (bmd *BillingMeterDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BillingMeterDetails struct.

type BillingType

type BillingType string

BillingType enumerates the values for billing type.

const (
	// BillingTypeMeterDetails ...
	BillingTypeMeterDetails BillingType = "MeterDetails"
	// BillingTypePav2 ...
	BillingTypePav2 BillingType = "Pav2"
	// BillingTypePurchase ...
	BillingTypePurchase BillingType = "Purchase"
)

func PossibleBillingTypeValues

func PossibleBillingTypeValues() []BillingType

PossibleBillingTypeValues returns an array of possible values for the BillingType const type.

type CancellationReason

type CancellationReason struct {
	// Reason - Reason for cancellation.
	Reason *string `json:"reason,omitempty"`
}

CancellationReason reason for cancellation.

type ChargingType

type ChargingType string

ChargingType enumerates the values for charging type.

const (
	// ChargingTypePerDevice Per device charging type.
	ChargingTypePerDevice ChargingType = "PerDevice"
	// ChargingTypePerOrder Per order charging type.
	ChargingTypePerOrder ChargingType = "PerOrder"
)

func PossibleChargingTypeValues

func PossibleChargingTypeValues() []ChargingType

PossibleChargingTypeValues returns an array of possible values for the ChargingType const type.

type CommonProperties

type CommonProperties struct {
	// FilterableProperties - READ-ONLY; list of filters supported for a product
	FilterableProperties *[]FilterableProperty `json:"filterableProperties,omitempty"`
	// DisplayName - READ-ONLY; Display Name for the product system.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - READ-ONLY; Description related to the product system.
	Description *Description `json:"description,omitempty"`
	// ImageInformation - READ-ONLY; Image information for the product system.
	ImageInformation *[]ImageInformation `json:"imageInformation,omitempty"`
	// CostInformation - READ-ONLY; Cost information for the product system.
	CostInformation *CostInformation `json:"costInformation,omitempty"`
	// AvailabilityInformation - READ-ONLY; Availability information of the product system.
	AvailabilityInformation *AvailabilityInformation `json:"availabilityInformation,omitempty"`
	// HierarchyInformation - READ-ONLY; Hierarchy information of a product.
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
}

CommonProperties represents common properties across product hierarchy

func (CommonProperties) MarshalJSON

func (cp CommonProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CommonProperties.

type Configuration

type Configuration struct {
	// ConfigurationProperties - READ-ONLY; Properties of configuration
	*ConfigurationProperties `json:"properties,omitempty"`
}

Configuration configuration object.

func (Configuration) MarshalJSON

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

MarshalJSON is the custom marshaler for Configuration.

func (*Configuration) UnmarshalJSON

func (c *Configuration) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Configuration struct.

type ConfigurationFilters

type ConfigurationFilters struct {
	// HierarchyInformation - Product hierarchy information
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
	// FilterableProperty - Filters specific to product
	FilterableProperty *[]FilterableProperty `json:"filterableProperty,omitempty"`
}

ConfigurationFilters configuration filters

type ConfigurationProperties

type ConfigurationProperties struct {
	// Specifications - READ-ONLY; Specifications of the configuration
	Specifications *[]Specification `json:"specifications,omitempty"`
	// Dimensions - READ-ONLY; Dimensions of the configuration
	Dimensions *Dimensions `json:"dimensions,omitempty"`
	// FilterableProperties - READ-ONLY; list of filters supported for a product
	FilterableProperties *[]FilterableProperty `json:"filterableProperties,omitempty"`
	// DisplayName - READ-ONLY; Display Name for the product system.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - READ-ONLY; Description related to the product system.
	Description *Description `json:"description,omitempty"`
	// ImageInformation - READ-ONLY; Image information for the product system.
	ImageInformation *[]ImageInformation `json:"imageInformation,omitempty"`
	// CostInformation - READ-ONLY; Cost information for the product system.
	CostInformation *CostInformation `json:"costInformation,omitempty"`
	// AvailabilityInformation - READ-ONLY; Availability information of the product system.
	AvailabilityInformation *AvailabilityInformation `json:"availabilityInformation,omitempty"`
	// HierarchyInformation - READ-ONLY; Hierarchy information of a product.
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
}

ConfigurationProperties properties of configuration

func (ConfigurationProperties) MarshalJSON

func (cp ConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ConfigurationProperties.

type Configurations

type Configurations struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of configurations.
	Value *[]Configuration `json:"value,omitempty"`
	// NextLink - Link for the next set of configurations.
	NextLink *string `json:"nextLink,omitempty"`
}

Configurations the list of configurations.

func (Configurations) IsEmpty

func (c Configurations) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (Configurations) MarshalJSON

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

MarshalJSON is the custom marshaler for Configurations.

type ConfigurationsIterator

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

ConfigurationsIterator provides access to a complete listing of Configuration values.

func NewConfigurationsIterator

func NewConfigurationsIterator(page ConfigurationsPage) ConfigurationsIterator

Creates a new instance of the ConfigurationsIterator type.

func (*ConfigurationsIterator) Next

func (iter *ConfigurationsIterator) 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 (*ConfigurationsIterator) NextWithContext

func (iter *ConfigurationsIterator) 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 (ConfigurationsIterator) NotDone

func (iter ConfigurationsIterator) NotDone() bool

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

func (ConfigurationsIterator) Response

func (iter ConfigurationsIterator) Response() Configurations

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

func (ConfigurationsIterator) Value

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

type ConfigurationsPage

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

ConfigurationsPage contains a page of Configuration values.

func NewConfigurationsPage

func NewConfigurationsPage(cur Configurations, getNextPage func(context.Context, Configurations) (Configurations, error)) ConfigurationsPage

Creates a new instance of the ConfigurationsPage type.

func (*ConfigurationsPage) Next

func (page *ConfigurationsPage) 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 (*ConfigurationsPage) NextWithContext

func (page *ConfigurationsPage) 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 (ConfigurationsPage) NotDone

func (page ConfigurationsPage) NotDone() bool

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

func (ConfigurationsPage) Response

func (page ConfigurationsPage) Response() Configurations

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

func (ConfigurationsPage) Values

func (page ConfigurationsPage) Values() []Configuration

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

type ConfigurationsRequest

type ConfigurationsRequest struct {
	// ConfigurationFilters - Holds details about product hierarchy information and filterable property.
	ConfigurationFilters *[]ConfigurationFilters `json:"configurationFilters,omitempty"`
	// CustomerSubscriptionDetails - Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details
	CustomerSubscriptionDetails *CustomerSubscriptionDetails `json:"customerSubscriptionDetails,omitempty"`
}

ConfigurationsRequest configuration request object.

type ContactDetails

type ContactDetails struct {
	// ContactName - Contact name of the person.
	ContactName *string `json:"contactName,omitempty"`
	// Phone - Phone number of the contact person.
	Phone *string `json:"phone,omitempty"`
	// PhoneExtension - Phone extension number of the contact person.
	PhoneExtension *string `json:"phoneExtension,omitempty"`
	// Mobile - Mobile number of the contact person.
	Mobile *string `json:"mobile,omitempty"`
	// EmailList - List of Email-ids to be notified about job progress.
	EmailList *[]string `json:"emailList,omitempty"`
}

ContactDetails contact Details.

type CostInformation

type CostInformation struct {
	// BillingMeterDetails - READ-ONLY; Details on the various billing aspects for the product system.
	BillingMeterDetails *[]BillingMeterDetails `json:"billingMeterDetails,omitempty"`
	// BillingInfoURL - READ-ONLY; Default url to display billing information
	BillingInfoURL *string `json:"billingInfoUrl,omitempty"`
}

CostInformation cost information for the product system

func (CostInformation) MarshalJSON

func (ci CostInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CostInformation.

type CreateAddressFuture

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

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

func (*CreateAddressFuture) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CreateOrderItemFuture

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

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

func (*CreateOrderItemFuture) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

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 CustomerSubscriptionDetails

type CustomerSubscriptionDetails struct {
	// RegisteredFeatures - List of registered feature flags for subscription
	RegisteredFeatures *[]CustomerSubscriptionRegisteredFeatures `json:"registeredFeatures,omitempty"`
	// LocationPlacementID - Location placement Id of a subscription
	LocationPlacementID *string `json:"locationPlacementId,omitempty"`
	// QuotaID - Quota ID of a subscription
	QuotaID *string `json:"quotaId,omitempty"`
}

CustomerSubscriptionDetails holds Customer subscription details. Clients can display available products to unregistered customers by explicitly passing subscription details

type CustomerSubscriptionRegisteredFeatures

type CustomerSubscriptionRegisteredFeatures struct {
	// Name - Name of subscription registered feature
	Name *string `json:"name,omitempty"`
	// State - State of subscription registered feature
	State *string `json:"state,omitempty"`
}

CustomerSubscriptionRegisteredFeatures represents subscription registered features

type DeleteAddressByNameFuture

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

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

func (*DeleteAddressByNameFuture) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DeleteOrderItemByNameFuture

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

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

func (*DeleteOrderItemByNameFuture) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Description

type Description struct {
	// DescriptionType - READ-ONLY; Type of description. Possible values include: 'DescriptionTypeBase'
	DescriptionType DescriptionType `json:"descriptionType,omitempty"`
	// ShortDescription - READ-ONLY; Short description of the product system.
	ShortDescription *string `json:"shortDescription,omitempty"`
	// LongDescription - READ-ONLY; Long description of the product system.
	LongDescription *string `json:"longDescription,omitempty"`
	// Keywords - READ-ONLY; Keywords for the product system.
	Keywords *[]string `json:"keywords,omitempty"`
	// Attributes - READ-ONLY; Attributes for the product system.
	Attributes *[]string `json:"attributes,omitempty"`
	// Links - READ-ONLY; Links for the product system.
	Links *[]Link `json:"links,omitempty"`
}

Description description related properties of a product system.

func (Description) MarshalJSON

func (d Description) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Description.

type DescriptionType

type DescriptionType string

DescriptionType enumerates the values for description type.

const (
	// DescriptionTypeBase Base description.
	DescriptionTypeBase DescriptionType = "Base"
)

func PossibleDescriptionTypeValues

func PossibleDescriptionTypeValues() []DescriptionType

PossibleDescriptionTypeValues returns an array of possible values for the DescriptionType const type.

type DeviceDetails

type DeviceDetails struct {
	// SerialNumber - READ-ONLY; device serial number
	SerialNumber *string `json:"serialNumber,omitempty"`
	// ManagementResourceID - READ-ONLY; Management Resource Id
	ManagementResourceID *string `json:"managementResourceId,omitempty"`
	// ManagementResourceTenantID - READ-ONLY; Management Resource Tenant ID
	ManagementResourceTenantID *string `json:"managementResourceTenantId,omitempty"`
}

DeviceDetails device details.

func (DeviceDetails) MarshalJSON

func (dd DeviceDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceDetails.

type Dimensions

type Dimensions struct {
	// Length - READ-ONLY; Length of the device.
	Length *float64 `json:"length,omitempty"`
	// Height - READ-ONLY; Height of the device.
	Height *float64 `json:"height,omitempty"`
	// Width - READ-ONLY; Width of the device.
	Width *float64 `json:"width,omitempty"`
	// LengthHeightUnit - READ-ONLY; Unit for the dimensions of length, height and width. Possible values include: 'LengthHeightUnitIN', 'LengthHeightUnitCM'
	LengthHeightUnit LengthHeightUnit `json:"lengthHeightUnit,omitempty"`
	// Weight - READ-ONLY; Weight of the device.
	Weight *float64 `json:"weight,omitempty"`
	// Depth - READ-ONLY; Depth of the device.
	Depth *float64 `json:"depth,omitempty"`
	// WeightUnit - READ-ONLY; Unit for the dimensions of weight. Possible values include: 'WeightMeasurementUnitLBS', 'WeightMeasurementUnitKGS'
	WeightUnit WeightMeasurementUnit `json:"weightUnit,omitempty"`
}

Dimensions dimensions of a configuration.

func (Dimensions) MarshalJSON

func (d Dimensions) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Dimensions.

type DisabledReason

type DisabledReason string

DisabledReason enumerates the values for disabled reason.

const (
	// DisabledReasonCountry Not available in the requested country.
	DisabledReasonCountry DisabledReason = "Country"
	// DisabledReasonFeature Required features are not enabled.
	DisabledReasonFeature DisabledReason = "Feature"
	// DisabledReasonNone Not disabled.
	DisabledReasonNone DisabledReason = "None"
	// DisabledReasonNoSubscriptionInfo Subscription has not registered to Microsoft.DataBox and Service does
	// not have the subscription notification.
	DisabledReasonNoSubscriptionInfo DisabledReason = "NoSubscriptionInfo"
	// DisabledReasonNotAvailable The product is not yet available.
	DisabledReasonNotAvailable DisabledReason = "NotAvailable"
	// DisabledReasonOfferType Subscription does not have required offer types.
	DisabledReasonOfferType DisabledReason = "OfferType"
	// DisabledReasonOutOfStock The product is out of stock.
	DisabledReasonOutOfStock DisabledReason = "OutOfStock"
	// DisabledReasonRegion Not available to push data to the requested Azure region.
	DisabledReasonRegion DisabledReason = "Region"
)

func PossibleDisabledReasonValues

func PossibleDisabledReasonValues() []DisabledReason

PossibleDisabledReasonValues returns an array of possible values for the DisabledReason const type.

type DisplayInfo

type DisplayInfo struct {
	// ProductFamilyDisplayName - READ-ONLY; Product family display name
	ProductFamilyDisplayName *string `json:"productFamilyDisplayName,omitempty"`
	// ConfigurationDisplayName - READ-ONLY; Configuration display name
	ConfigurationDisplayName *string `json:"configurationDisplayName,omitempty"`
}

DisplayInfo describes product display information

func (DisplayInfo) MarshalJSON

func (di DisplayInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DisplayInfo.

type DoubleEncryptionStatus

type DoubleEncryptionStatus string

DoubleEncryptionStatus enumerates the values for double encryption status.

const (
	// DoubleEncryptionStatusDisabled Double encryption is disabled
	DoubleEncryptionStatusDisabled DoubleEncryptionStatus = "Disabled"
	// DoubleEncryptionStatusEnabled Double encryption is enabled
	DoubleEncryptionStatusEnabled DoubleEncryptionStatus = "Enabled"
)

func PossibleDoubleEncryptionStatusValues

func PossibleDoubleEncryptionStatusValues() []DoubleEncryptionStatus

PossibleDoubleEncryptionStatusValues returns an array of possible values for the DoubleEncryptionStatus const type.

type EncryptionPreferences

type EncryptionPreferences struct {
	// DoubleEncryptionStatus - Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. Possible values include: 'DoubleEncryptionStatusDisabled', 'DoubleEncryptionStatusEnabled'
	DoubleEncryptionStatus DoubleEncryptionStatus `json:"doubleEncryptionStatus,omitempty"`
}

EncryptionPreferences preferences related to the double encryption

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// Type - READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty"`
	// Info - READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON

func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorAdditionalInfo.

type ErrorDetail

type ErrorDetail struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]ErrorDetail `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorDetail the error detail.

func (ErrorDetail) MarshalJSON

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

MarshalJSON is the custom marshaler for ErrorDetail.

type ErrorResponse

type ErrorResponse struct {
	// Error - The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type FilterableProperty

type FilterableProperty struct {
	// Type - Type of product filter. Possible values include: 'SupportedFilterTypesShipToCountries', 'SupportedFilterTypesDoubleEncryptionStatus'
	Type SupportedFilterTypes `json:"type,omitempty"`
	// SupportedValues - Values to be filtered.
	SupportedValues *[]string `json:"supportedValues,omitempty"`
}

FilterableProperty different types of filters supported and its values.

type ForwardShippingDetails

type ForwardShippingDetails struct {
	// CarrierName - READ-ONLY; Name of the carrier.
	CarrierName *string `json:"carrierName,omitempty"`
	// CarrierDisplayName - READ-ONLY; Carrier Name for display purpose. Not to be used for any processing.
	CarrierDisplayName *string `json:"carrierDisplayName,omitempty"`
	// TrackingID - READ-ONLY; TrackingId of the package
	TrackingID *string `json:"trackingId,omitempty"`
	// TrackingURL - READ-ONLY; TrackingUrl of the package.
	TrackingURL *string `json:"trackingUrl,omitempty"`
}

ForwardShippingDetails forward shipment details.

func (ForwardShippingDetails) MarshalJSON

func (fsd ForwardShippingDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ForwardShippingDetails.

type HierarchyInformation

type HierarchyInformation struct {
	// ProductFamilyName - Represents product family name that uniquely identifies product family
	ProductFamilyName *string `json:"productFamilyName,omitempty"`
	// ProductLineName - Represents product line name that uniquely identifies product line
	ProductLineName *string `json:"productLineName,omitempty"`
	// ProductName - Represents product name that uniquely identifies product
	ProductName *string `json:"productName,omitempty"`
	// ConfigurationName - Represents configuration name that uniquely identifies configuration
	ConfigurationName *string `json:"configurationName,omitempty"`
}

HierarchyInformation holds details about product hierarchy information

type ImageInformation

type ImageInformation struct {
	// ImageType - READ-ONLY; Type of the image. Possible values include: 'ImageTypeMainImage', 'ImageTypeBulletImage', 'ImageTypeGenericImage'
	ImageType ImageType `json:"imageType,omitempty"`
	// ImageURL - READ-ONLY; Url of the image
	ImageURL *string `json:"imageUrl,omitempty"`
}

ImageInformation image for the product

func (ImageInformation) MarshalJSON

func (ii ImageInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ImageInformation.

type ImageType

type ImageType string

ImageType enumerates the values for image type.

const (
	// ImageTypeBulletImage Bullet image.
	ImageTypeBulletImage ImageType = "BulletImage"
	// ImageTypeGenericImage Generic image.
	ImageTypeGenericImage ImageType = "GenericImage"
	// ImageTypeMainImage Main image.
	ImageTypeMainImage ImageType = "MainImage"
)

func PossibleImageTypeValues

func PossibleImageTypeValues() []ImageType

PossibleImageTypeValues returns an array of possible values for the ImageType const type.

type LengthHeightUnit

type LengthHeightUnit string

LengthHeightUnit enumerates the values for length height unit.

const (
	// LengthHeightUnitCM Centimeter.
	LengthHeightUnitCM LengthHeightUnit = "CM"
	// LengthHeightUnitIN Inch, applicable for West US.
	LengthHeightUnitIN LengthHeightUnit = "IN"
)

func PossibleLengthHeightUnitValues

func PossibleLengthHeightUnitValues() []LengthHeightUnit

PossibleLengthHeightUnitValues returns an array of possible values for the LengthHeightUnit const type.

type Link struct {
	// LinkType - READ-ONLY; Type of link. Possible values include: 'LinkTypeGeneric', 'LinkTypeTermsAndConditions', 'LinkTypeSpecification', 'LinkTypeDocumentation', 'LinkTypeKnowMore', 'LinkTypeSignUp'
	LinkType LinkType `json:"linkType,omitempty"`
	// LinkURL - READ-ONLY; Url of the link
	LinkURL *string `json:"linkUrl,omitempty"`
}

Link returns link related to the product

func (Link) MarshalJSON

func (l Link) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Link.

type LinkType

type LinkType string

LinkType enumerates the values for link type.

const (
	// LinkTypeDocumentation Link to product documentation
	LinkTypeDocumentation LinkType = "Documentation"
	// LinkTypeGeneric Generic link.
	LinkTypeGeneric LinkType = "Generic"
	// LinkTypeKnowMore Link to know more
	LinkTypeKnowMore LinkType = "KnowMore"
	// LinkTypeSignUp Link to sign up for products
	LinkTypeSignUp LinkType = "SignUp"
	// LinkTypeSpecification Link to product specification.
	LinkTypeSpecification LinkType = "Specification"
	// LinkTypeTermsAndConditions Terms and conditions link.
	LinkTypeTermsAndConditions LinkType = "TermsAndConditions"
)

func PossibleLinkTypeValues

func PossibleLinkTypeValues() []LinkType

PossibleLinkTypeValues returns an array of possible values for the LinkType const type.

type ManagementResourcePreferences

type ManagementResourcePreferences struct {
	// PreferredManagementResourceID - Customer preferred Management resource ARM ID
	PreferredManagementResourceID *string `json:"preferredManagementResourceId,omitempty"`
}

ManagementResourcePreferences management resource preference to link device

type MeterDetails

type MeterDetails struct {
	// Multiplier - READ-ONLY; Billing unit applicable for Pav2 billing
	Multiplier *float64 `json:"multiplier,omitempty"`
	// ChargingType - READ-ONLY; Charging type. Possible values include: 'ChargingTypePerOrder', 'ChargingTypePerDevice'
	ChargingType ChargingType `json:"chargingType,omitempty"`
	// BillingType - Possible values include: 'BillingTypeMeterDetails', 'BillingTypePav2', 'BillingTypePurchase'
	BillingType BillingType `json:"billingType,omitempty"`
}

MeterDetails holds details about billing type and its meter guids

func (MeterDetails) AsBasicMeterDetails

func (md MeterDetails) AsBasicMeterDetails() (BasicMeterDetails, bool)

AsBasicMeterDetails is the BasicMeterDetails implementation for MeterDetails.

func (MeterDetails) AsMeterDetails

func (md MeterDetails) AsMeterDetails() (*MeterDetails, bool)

AsMeterDetails is the BasicMeterDetails implementation for MeterDetails.

func (MeterDetails) AsPav2MeterDetails

func (md MeterDetails) AsPav2MeterDetails() (*Pav2MeterDetails, bool)

AsPav2MeterDetails is the BasicMeterDetails implementation for MeterDetails.

func (MeterDetails) AsPurchaseMeterDetails

func (md MeterDetails) AsPurchaseMeterDetails() (*PurchaseMeterDetails, bool)

AsPurchaseMeterDetails is the BasicMeterDetails implementation for MeterDetails.

func (MeterDetails) MarshalJSON

func (md MeterDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MeterDetails.

type MeteringType

type MeteringType string

MeteringType enumerates the values for metering type.

const (
	// MeteringTypeAdhoc Adhoc billing.
	MeteringTypeAdhoc MeteringType = "Adhoc"
	// MeteringTypeOneTime One time billing.
	MeteringTypeOneTime MeteringType = "OneTime"
	// MeteringTypeRecurring Recurring billing.
	MeteringTypeRecurring MeteringType = "Recurring"
)

func PossibleMeteringTypeValues

func PossibleMeteringTypeValues() []MeteringType

PossibleMeteringTypeValues returns an array of possible values for the MeteringType const type.

type NotificationPreference

type NotificationPreference struct {
	// StageName - Name of the stage. Possible values include: 'NotificationStageNameShipped', 'NotificationStageNameDelivered'
	StageName NotificationStageName `json:"stageName,omitempty"`
	// SendNotification - Notification is required or not.
	SendNotification *bool `json:"sendNotification,omitempty"`
}

NotificationPreference notification preference for a job stage.

type NotificationStageName

type NotificationStageName string

NotificationStageName enumerates the values for notification stage name.

const (
	// NotificationStageNameDelivered Notification at order item delivered to customer.
	NotificationStageNameDelivered NotificationStageName = "Delivered"
	// NotificationStageNameShipped Notification at order item shipped from microsoft datacenter.
	NotificationStageNameShipped NotificationStageName = "Shipped"
)

func PossibleNotificationStageNameValues

func PossibleNotificationStageNameValues() []NotificationStageName

PossibleNotificationStageNameValues returns an array of possible values for the NotificationStageName const type.

type Operation

type Operation struct {
	// Name - READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
	Name *string `json:"name,omitempty"`
	// IsDataAction - READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Display - Localized display information for this particular operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system". Possible values include: 'OriginUser', 'OriginSystem', 'OriginUsersystem'
	Origin Origin `json:"origin,omitempty"`
	// ActionType - READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Possible values include: 'ActionTypeInternal'
	ActionType ActionType `json:"actionType,omitempty"`
}

Operation details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay

type OperationDisplay struct {
	// Provider - READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
	Operation *string `json:"operation,omitempty"`
	// Description - READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string `json:"description,omitempty"`
}

OperationDisplay localized display information for this particular operation.

func (OperationDisplay) MarshalJSON

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of operations supported by the resource provider
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult a list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) IsEmpty

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON

func (olr OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next

func (iter *OperationListResultIterator) 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 (*OperationListResultIterator) NextWithContext

func (iter *OperationListResultIterator) 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 (OperationListResultIterator) NotDone

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response

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

func (OperationListResultIterator) Value

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

type OperationListResultPage

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next

func (page *OperationListResultPage) 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 (*OperationListResultPage) NextWithContext

func (page *OperationListResultPage) 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 (OperationListResultPage) NotDone

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response

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

func (OperationListResultPage) Values

func (page OperationListResultPage) Values() []Operation

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

type OrderItemCancellationEnum

type OrderItemCancellationEnum string

OrderItemCancellationEnum enumerates the values for order item cancellation enum.

const (
	// OrderItemCancellationEnumCancellable Order item can be cancelled without fee.
	OrderItemCancellationEnumCancellable OrderItemCancellationEnum = "Cancellable"
	// OrderItemCancellationEnumCancellableWithFee Order item can be cancelled with fee.
	OrderItemCancellationEnumCancellableWithFee OrderItemCancellationEnum = "CancellableWithFee"
	// OrderItemCancellationEnumNotCancellable Order item not cancellable.
	OrderItemCancellationEnumNotCancellable OrderItemCancellationEnum = "NotCancellable"
)

func PossibleOrderItemCancellationEnumValues

func PossibleOrderItemCancellationEnumValues() []OrderItemCancellationEnum

PossibleOrderItemCancellationEnumValues returns an array of possible values for the OrderItemCancellationEnum const type.

type OrderItemDetails

type OrderItemDetails struct {
	// ProductDetails - Unique identifier for configuration.
	ProductDetails *ProductDetails `json:"productDetails,omitempty"`
	// OrderItemType - Order item type. Possible values include: 'OrderItemTypePurchase', 'OrderItemTypeRental'
	OrderItemType OrderItemType `json:"orderItemType,omitempty"`
	// CurrentStage - READ-ONLY; Current Order item Status
	CurrentStage *StageDetails `json:"currentStage,omitempty"`
	// OrderItemStageHistory - READ-ONLY; Order item status history
	OrderItemStageHistory *[]StageDetails `json:"orderItemStageHistory,omitempty"`
	// Preferences - Customer notification Preferences
	Preferences *Preferences `json:"preferences,omitempty"`
	// ForwardShippingDetails - READ-ONLY; Forward Package Shipping details
	ForwardShippingDetails *ForwardShippingDetails `json:"forwardShippingDetails,omitempty"`
	// ReverseShippingDetails - READ-ONLY; Reverse Package Shipping details
	ReverseShippingDetails *ReverseShippingDetails `json:"reverseShippingDetails,omitempty"`
	// NotificationEmailList - Additional notification email list
	NotificationEmailList *[]string `json:"notificationEmailList,omitempty"`
	// CancellationReason - READ-ONLY; Cancellation reason.
	CancellationReason *string `json:"cancellationReason,omitempty"`
	// CancellationStatus - READ-ONLY; Describes whether the order item is cancellable or not. Possible values include: 'OrderItemCancellationEnumCancellable', 'OrderItemCancellationEnumCancellableWithFee', 'OrderItemCancellationEnumNotCancellable'
	CancellationStatus OrderItemCancellationEnum `json:"cancellationStatus,omitempty"`
	// DeletionStatus - READ-ONLY; Describes whether the order item is deletable or not. Possible values include: 'ActionStatusEnumAllowed', 'ActionStatusEnumNotAllowed'
	DeletionStatus ActionStatusEnum `json:"deletionStatus,omitempty"`
	// ReturnReason - READ-ONLY; Return reason.
	ReturnReason *string `json:"returnReason,omitempty"`
	// ReturnStatus - READ-ONLY; Describes whether the order item is returnable or not. Possible values include: 'OrderItemReturnEnumReturnable', 'OrderItemReturnEnumReturnableWithFee', 'OrderItemReturnEnumNotReturnable'
	ReturnStatus OrderItemReturnEnum `json:"returnStatus,omitempty"`
	// ManagementRpDetails - READ-ONLY; Parent RP details - this returns only the first or default parent RP from the entire list
	ManagementRpDetails *ResourceProviderDetails `json:"managementRpDetails,omitempty"`
	// ManagementRpDetailsList - READ-ONLY; List of parent RP details supported for configuration.
	ManagementRpDetailsList *[]ResourceProviderDetails `json:"managementRpDetailsList,omitempty"`
	// Error - READ-ONLY; Top level error for the job.
	Error *ErrorDetail `json:"error,omitempty"`
}

OrderItemDetails order item details

func (OrderItemDetails) MarshalJSON

func (oid OrderItemDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderItemDetails.

type OrderItemProperties

type OrderItemProperties struct {
	// OrderItemDetails - Represents order item details.
	OrderItemDetails *OrderItemDetails `json:"orderItemDetails,omitempty"`
	// AddressDetails - Represents shipping and return address for order item
	AddressDetails *AddressDetails `json:"addressDetails,omitempty"`
	// StartTime - READ-ONLY; Start time of order item
	StartTime *date.Time `json:"startTime,omitempty"`
	// OrderID - Id of the order to which order item belongs to
	OrderID *string `json:"orderId,omitempty"`
}

OrderItemProperties represents order item details.

func (OrderItemProperties) MarshalJSON

func (oip OrderItemProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderItemProperties.

type OrderItemResource

type OrderItemResource struct {
	autorest.Response `json:"-"`
	// OrderItemProperties - Order item properties
	*OrderItemProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; Represents resource creation and update time
	SystemData *SystemData `json:"systemData,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

OrderItemResource represents order item contract

func (OrderItemResource) MarshalJSON

func (oir OrderItemResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderItemResource.

func (*OrderItemResource) UnmarshalJSON

func (oir *OrderItemResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OrderItemResource struct.

type OrderItemResourceList

type OrderItemResourceList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of order item resources.
	Value *[]OrderItemResource `json:"value,omitempty"`
	// NextLink - Link for the next set of order item resources.
	NextLink *string `json:"nextLink,omitempty"`
}

OrderItemResourceList list of orderItems.

func (OrderItemResourceList) IsEmpty

func (oirl OrderItemResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OrderItemResourceList) MarshalJSON

func (oirl OrderItemResourceList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderItemResourceList.

type OrderItemResourceListIterator

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

OrderItemResourceListIterator provides access to a complete listing of OrderItemResource values.

func NewOrderItemResourceListIterator

func NewOrderItemResourceListIterator(page OrderItemResourceListPage) OrderItemResourceListIterator

Creates a new instance of the OrderItemResourceListIterator type.

func (*OrderItemResourceListIterator) Next

func (iter *OrderItemResourceListIterator) 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 (*OrderItemResourceListIterator) NextWithContext

func (iter *OrderItemResourceListIterator) 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 (OrderItemResourceListIterator) NotDone

func (iter OrderItemResourceListIterator) NotDone() bool

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

func (OrderItemResourceListIterator) Response

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

func (OrderItemResourceListIterator) Value

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

type OrderItemResourceListPage

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

OrderItemResourceListPage contains a page of OrderItemResource values.

func NewOrderItemResourceListPage

Creates a new instance of the OrderItemResourceListPage type.

func (*OrderItemResourceListPage) Next

func (page *OrderItemResourceListPage) 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 (*OrderItemResourceListPage) NextWithContext

func (page *OrderItemResourceListPage) 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 (OrderItemResourceListPage) NotDone

func (page OrderItemResourceListPage) NotDone() bool

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

func (OrderItemResourceListPage) Response

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

func (OrderItemResourceListPage) Values

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

type OrderItemReturnEnum

type OrderItemReturnEnum string

OrderItemReturnEnum enumerates the values for order item return enum.

const (
	// OrderItemReturnEnumNotReturnable Order item not returnable.
	OrderItemReturnEnumNotReturnable OrderItemReturnEnum = "NotReturnable"
	// OrderItemReturnEnumReturnable Order item can be returned without fee.
	OrderItemReturnEnumReturnable OrderItemReturnEnum = "Returnable"
	// OrderItemReturnEnumReturnableWithFee Order item can be returned with fee.
	OrderItemReturnEnumReturnableWithFee OrderItemReturnEnum = "ReturnableWithFee"
)

func PossibleOrderItemReturnEnumValues

func PossibleOrderItemReturnEnumValues() []OrderItemReturnEnum

PossibleOrderItemReturnEnumValues returns an array of possible values for the OrderItemReturnEnum const type.

type OrderItemType

type OrderItemType string

OrderItemType enumerates the values for order item type.

const (
	// OrderItemTypePurchase Purchase OrderItem.
	OrderItemTypePurchase OrderItemType = "Purchase"
	// OrderItemTypeRental Rental OrderItem.
	OrderItemTypeRental OrderItemType = "Rental"
)

func PossibleOrderItemTypeValues

func PossibleOrderItemTypeValues() []OrderItemType

PossibleOrderItemTypeValues returns an array of possible values for the OrderItemType const type.

type OrderItemUpdateParameter

type OrderItemUpdateParameter struct {
	// OrderItemUpdateProperties - Order item update properties
	*OrderItemUpdateProperties `json:"properties,omitempty"`
	// Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
	Tags map[string]*string `json:"tags"`
}

OrderItemUpdateParameter updates order item parameters.

func (OrderItemUpdateParameter) MarshalJSON

func (oiup OrderItemUpdateParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderItemUpdateParameter.

func (*OrderItemUpdateParameter) UnmarshalJSON

func (oiup *OrderItemUpdateParameter) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OrderItemUpdateParameter struct.

type OrderItemUpdateProperties

type OrderItemUpdateProperties struct {
	// ForwardAddress - Updates forward shipping address and contact details.
	ForwardAddress *AddressProperties `json:"forwardAddress,omitempty"`
	// Preferences - Customer preference.
	Preferences *Preferences `json:"preferences,omitempty"`
	// NotificationEmailList - Additional notification email list.
	NotificationEmailList *[]string `json:"notificationEmailList,omitempty"`
}

OrderItemUpdateProperties order item update properties.

type OrderProperties

type OrderProperties struct {
	// OrderItemIds - READ-ONLY; List of order item ARM Ids which are part of an order.
	OrderItemIds *[]string `json:"orderItemIds,omitempty"`
	// CurrentStage - READ-ONLY; Order current status.
	CurrentStage *StageDetails `json:"currentStage,omitempty"`
	// OrderStageHistory - READ-ONLY; Order status history.
	OrderStageHistory *[]StageDetails `json:"orderStageHistory,omitempty"`
}

OrderProperties represents order details.

func (OrderProperties) MarshalJSON

func (op OrderProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderProperties.

type OrderResource

type OrderResource struct {
	autorest.Response `json:"-"`
	// OrderProperties - Order properties
	*OrderProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; Represents resource creation and update time
	SystemData *SystemData `json:"systemData,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

OrderResource specifies the properties or parameters for an order. Order is a grouping of one or more order items.

func (OrderResource) MarshalJSON

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

MarshalJSON is the custom marshaler for OrderResource.

func (*OrderResource) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for OrderResource struct.

type OrderResourceList

type OrderResourceList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of order resources.
	Value *[]OrderResource `json:"value,omitempty"`
	// NextLink - Link for the next set of order resources.
	NextLink *string `json:"nextLink,omitempty"`
}

OrderResourceList list of orders.

func (OrderResourceList) IsEmpty

func (orl OrderResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OrderResourceList) MarshalJSON

func (orl OrderResourceList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderResourceList.

type OrderResourceListIterator

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

OrderResourceListIterator provides access to a complete listing of OrderResource values.

func NewOrderResourceListIterator

func NewOrderResourceListIterator(page OrderResourceListPage) OrderResourceListIterator

Creates a new instance of the OrderResourceListIterator type.

func (*OrderResourceListIterator) Next

func (iter *OrderResourceListIterator) 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 (*OrderResourceListIterator) NextWithContext

func (iter *OrderResourceListIterator) 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 (OrderResourceListIterator) NotDone

func (iter OrderResourceListIterator) NotDone() bool

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

func (OrderResourceListIterator) Response

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

func (OrderResourceListIterator) Value

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

type OrderResourceListPage

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

OrderResourceListPage contains a page of OrderResource values.

func NewOrderResourceListPage

func NewOrderResourceListPage(cur OrderResourceList, getNextPage func(context.Context, OrderResourceList) (OrderResourceList, error)) OrderResourceListPage

Creates a new instance of the OrderResourceListPage type.

func (*OrderResourceListPage) Next

func (page *OrderResourceListPage) 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 (*OrderResourceListPage) NextWithContext

func (page *OrderResourceListPage) 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 (OrderResourceListPage) NotDone

func (page OrderResourceListPage) NotDone() bool

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

func (OrderResourceListPage) Response

func (page OrderResourceListPage) Response() OrderResourceList

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

func (OrderResourceListPage) Values

func (page OrderResourceListPage) Values() []OrderResource

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

type Origin

type Origin string

Origin enumerates the values for origin.

const (
	// OriginSystem ...
	OriginSystem Origin = "system"
	// OriginUser ...
	OriginUser Origin = "user"
	// OriginUsersystem ...
	OriginUsersystem Origin = "user,system"
)

func PossibleOriginValues

func PossibleOriginValues() []Origin

PossibleOriginValues returns an array of possible values for the Origin const type.

type Pav2MeterDetails

type Pav2MeterDetails struct {
	// MeterGUID - READ-ONLY; Validation status of requested data center and transport.
	MeterGUID *string `json:"meterGuid,omitempty"`
	// Multiplier - READ-ONLY; Billing unit applicable for Pav2 billing
	Multiplier *float64 `json:"multiplier,omitempty"`
	// ChargingType - READ-ONLY; Charging type. Possible values include: 'ChargingTypePerOrder', 'ChargingTypePerDevice'
	ChargingType ChargingType `json:"chargingType,omitempty"`
	// BillingType - Possible values include: 'BillingTypeMeterDetails', 'BillingTypePav2', 'BillingTypePurchase'
	BillingType BillingType `json:"billingType,omitempty"`
}

Pav2MeterDetails billing type PAV2 meter details

func (Pav2MeterDetails) AsBasicMeterDetails

func (p2md Pav2MeterDetails) AsBasicMeterDetails() (BasicMeterDetails, bool)

AsBasicMeterDetails is the BasicMeterDetails implementation for Pav2MeterDetails.

func (Pav2MeterDetails) AsMeterDetails

func (p2md Pav2MeterDetails) AsMeterDetails() (*MeterDetails, bool)

AsMeterDetails is the BasicMeterDetails implementation for Pav2MeterDetails.

func (Pav2MeterDetails) AsPav2MeterDetails

func (p2md Pav2MeterDetails) AsPav2MeterDetails() (*Pav2MeterDetails, bool)

AsPav2MeterDetails is the BasicMeterDetails implementation for Pav2MeterDetails.

func (Pav2MeterDetails) AsPurchaseMeterDetails

func (p2md Pav2MeterDetails) AsPurchaseMeterDetails() (*PurchaseMeterDetails, bool)

AsPurchaseMeterDetails is the BasicMeterDetails implementation for Pav2MeterDetails.

func (Pav2MeterDetails) MarshalJSON

func (p2md Pav2MeterDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Pav2MeterDetails.

type Preferences

type Preferences struct {
	// NotificationPreferences - Notification preferences.
	NotificationPreferences *[]NotificationPreference `json:"notificationPreferences,omitempty"`
	// TransportPreferences - Preferences related to the shipment logistics of the order.
	TransportPreferences *TransportPreferences `json:"transportPreferences,omitempty"`
	// EncryptionPreferences - Preferences related to the Encryption.
	EncryptionPreferences *EncryptionPreferences `json:"encryptionPreferences,omitempty"`
	// ManagementResourcePreferences - Preferences related to the Management resource.
	ManagementResourcePreferences *ManagementResourcePreferences `json:"managementResourcePreferences,omitempty"`
}

Preferences preferences related to the order

type Product

type Product struct {
	// ProductProperties - READ-ONLY; Properties of product
	*ProductProperties `json:"properties,omitempty"`
}

Product list of Products

func (Product) MarshalJSON

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

MarshalJSON is the custom marshaler for Product.

func (*Product) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for Product struct.

type ProductDetails

type ProductDetails struct {
	// DisplayInfo - Display details of the product
	DisplayInfo *DisplayInfo `json:"displayInfo,omitempty"`
	// HierarchyInformation - Hierarchy of the product which uniquely identifies the product
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
	// Count - READ-ONLY; Quantity of the product
	Count *int32 `json:"count,omitempty"`
	// ProductDoubleEncryptionStatus - READ-ONLY; Double encryption status of the configuration. Read-only field. Possible values include: 'DoubleEncryptionStatusDisabled', 'DoubleEncryptionStatusEnabled'
	ProductDoubleEncryptionStatus DoubleEncryptionStatus `json:"productDoubleEncryptionStatus,omitempty"`
	// DeviceDetails - READ-ONLY; list of device details
	DeviceDetails *[]DeviceDetails `json:"deviceDetails,omitempty"`
}

ProductDetails represents product details

func (ProductDetails) MarshalJSON

func (pd ProductDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductDetails.

type ProductFamilies

type ProductFamilies struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of product families.
	Value *[]ProductFamily `json:"value,omitempty"`
	// NextLink - Link for the next set of product families.
	NextLink *string `json:"nextLink,omitempty"`
}

ProductFamilies the list of product families.

func (ProductFamilies) IsEmpty

func (pf ProductFamilies) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ProductFamilies) MarshalJSON

func (pf ProductFamilies) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductFamilies.

type ProductFamiliesIterator

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

ProductFamiliesIterator provides access to a complete listing of ProductFamily values.

func NewProductFamiliesIterator

func NewProductFamiliesIterator(page ProductFamiliesPage) ProductFamiliesIterator

Creates a new instance of the ProductFamiliesIterator type.

func (*ProductFamiliesIterator) Next

func (iter *ProductFamiliesIterator) 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 (*ProductFamiliesIterator) NextWithContext

func (iter *ProductFamiliesIterator) 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 (ProductFamiliesIterator) NotDone

func (iter ProductFamiliesIterator) NotDone() bool

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

func (ProductFamiliesIterator) Response

func (iter ProductFamiliesIterator) Response() ProductFamilies

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

func (ProductFamiliesIterator) Value

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

type ProductFamiliesMetadata

type ProductFamiliesMetadata struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of product family metadata details.
	Value *[]ProductFamiliesMetadataDetails `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link for the next set of product families.
	NextLink *string `json:"nextLink,omitempty"`
}

ProductFamiliesMetadata holds details about product family metadata

func (ProductFamiliesMetadata) IsEmpty

func (pfm ProductFamiliesMetadata) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ProductFamiliesMetadata) MarshalJSON

func (pfm ProductFamiliesMetadata) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductFamiliesMetadata.

type ProductFamiliesMetadataDetails

type ProductFamiliesMetadataDetails struct {
	// ProductFamilyProperties - READ-ONLY; Product family properties
	*ProductFamilyProperties `json:"properties,omitempty"`
}

ProductFamiliesMetadataDetails product families metadata details.

func (ProductFamiliesMetadataDetails) MarshalJSON

func (pfmd ProductFamiliesMetadataDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductFamiliesMetadataDetails.

func (*ProductFamiliesMetadataDetails) UnmarshalJSON

func (pfmd *ProductFamiliesMetadataDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ProductFamiliesMetadataDetails struct.

type ProductFamiliesMetadataIterator

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

ProductFamiliesMetadataIterator provides access to a complete listing of ProductFamiliesMetadataDetails values.

func NewProductFamiliesMetadataIterator

func NewProductFamiliesMetadataIterator(page ProductFamiliesMetadataPage) ProductFamiliesMetadataIterator

Creates a new instance of the ProductFamiliesMetadataIterator type.

func (*ProductFamiliesMetadataIterator) Next

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 (*ProductFamiliesMetadataIterator) NextWithContext

func (iter *ProductFamiliesMetadataIterator) 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 (ProductFamiliesMetadataIterator) NotDone

func (iter ProductFamiliesMetadataIterator) NotDone() bool

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

func (ProductFamiliesMetadataIterator) Response

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

func (ProductFamiliesMetadataIterator) Value

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

type ProductFamiliesMetadataPage

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

ProductFamiliesMetadataPage contains a page of ProductFamiliesMetadataDetails values.

func NewProductFamiliesMetadataPage

Creates a new instance of the ProductFamiliesMetadataPage type.

func (*ProductFamiliesMetadataPage) Next

func (page *ProductFamiliesMetadataPage) 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 (*ProductFamiliesMetadataPage) NextWithContext

func (page *ProductFamiliesMetadataPage) 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 (ProductFamiliesMetadataPage) NotDone

func (page ProductFamiliesMetadataPage) NotDone() bool

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

func (ProductFamiliesMetadataPage) Response

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

func (ProductFamiliesMetadataPage) Values

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

type ProductFamiliesPage

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

ProductFamiliesPage contains a page of ProductFamily values.

func NewProductFamiliesPage

func NewProductFamiliesPage(cur ProductFamilies, getNextPage func(context.Context, ProductFamilies) (ProductFamilies, error)) ProductFamiliesPage

Creates a new instance of the ProductFamiliesPage type.

func (*ProductFamiliesPage) Next

func (page *ProductFamiliesPage) 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 (*ProductFamiliesPage) NextWithContext

func (page *ProductFamiliesPage) 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 (ProductFamiliesPage) NotDone

func (page ProductFamiliesPage) NotDone() bool

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

func (ProductFamiliesPage) Response

func (page ProductFamiliesPage) Response() ProductFamilies

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

func (ProductFamiliesPage) Values

func (page ProductFamiliesPage) Values() []ProductFamily

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

type ProductFamiliesRequest

type ProductFamiliesRequest struct {
	// FilterableProperties - Dictionary of filterable properties on product family.
	FilterableProperties map[string][]FilterableProperty `json:"filterableProperties"`
	// CustomerSubscriptionDetails - Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details
	CustomerSubscriptionDetails *CustomerSubscriptionDetails `json:"customerSubscriptionDetails,omitempty"`
}

ProductFamiliesRequest the filters for showing the product families.

func (ProductFamiliesRequest) MarshalJSON

func (pfr ProductFamiliesRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductFamiliesRequest.

type ProductFamily

type ProductFamily struct {
	// ProductFamilyProperties - READ-ONLY; Properties of product family
	*ProductFamilyProperties `json:"properties,omitempty"`
}

ProductFamily product Family

func (ProductFamily) MarshalJSON

func (pf ProductFamily) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductFamily.

func (*ProductFamily) UnmarshalJSON

func (pf *ProductFamily) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ProductFamily struct.

type ProductFamilyProperties

type ProductFamilyProperties struct {
	// ProductLines - READ-ONLY; List of product lines supported in the product family
	ProductLines *[]ProductLine `json:"productLines,omitempty"`
	// ResourceProviderDetails - Contains details related to resource provider
	ResourceProviderDetails *[]ResourceProviderDetails `json:"resourceProviderDetails,omitempty"`
	// FilterableProperties - READ-ONLY; list of filters supported for a product
	FilterableProperties *[]FilterableProperty `json:"filterableProperties,omitempty"`
	// DisplayName - READ-ONLY; Display Name for the product system.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - READ-ONLY; Description related to the product system.
	Description *Description `json:"description,omitempty"`
	// ImageInformation - READ-ONLY; Image information for the product system.
	ImageInformation *[]ImageInformation `json:"imageInformation,omitempty"`
	// CostInformation - READ-ONLY; Cost information for the product system.
	CostInformation *CostInformation `json:"costInformation,omitempty"`
	// AvailabilityInformation - READ-ONLY; Availability information of the product system.
	AvailabilityInformation *AvailabilityInformation `json:"availabilityInformation,omitempty"`
	// HierarchyInformation - READ-ONLY; Hierarchy information of a product.
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
}

ProductFamilyProperties properties of product family

func (ProductFamilyProperties) MarshalJSON

func (pfp ProductFamilyProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductFamilyProperties.

type ProductLine

type ProductLine struct {
	// ProductLineProperties - READ-ONLY; Properties of product line
	*ProductLineProperties `json:"properties,omitempty"`
}

ProductLine product line

func (ProductLine) MarshalJSON

func (pl ProductLine) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductLine.

func (*ProductLine) UnmarshalJSON

func (pl *ProductLine) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ProductLine struct.

type ProductLineProperties

type ProductLineProperties struct {
	// Products - READ-ONLY; List of products in the product line
	Products *[]Product `json:"products,omitempty"`
	// FilterableProperties - READ-ONLY; list of filters supported for a product
	FilterableProperties *[]FilterableProperty `json:"filterableProperties,omitempty"`
	// DisplayName - READ-ONLY; Display Name for the product system.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - READ-ONLY; Description related to the product system.
	Description *Description `json:"description,omitempty"`
	// ImageInformation - READ-ONLY; Image information for the product system.
	ImageInformation *[]ImageInformation `json:"imageInformation,omitempty"`
	// CostInformation - READ-ONLY; Cost information for the product system.
	CostInformation *CostInformation `json:"costInformation,omitempty"`
	// AvailabilityInformation - READ-ONLY; Availability information of the product system.
	AvailabilityInformation *AvailabilityInformation `json:"availabilityInformation,omitempty"`
	// HierarchyInformation - READ-ONLY; Hierarchy information of a product.
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
}

ProductLineProperties properties of product line

func (ProductLineProperties) MarshalJSON

func (plp ProductLineProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductLineProperties.

type ProductProperties

type ProductProperties struct {
	// Configurations - READ-ONLY; List of configurations for the product
	Configurations *[]Configuration `json:"configurations,omitempty"`
	// FilterableProperties - READ-ONLY; list of filters supported for a product
	FilterableProperties *[]FilterableProperty `json:"filterableProperties,omitempty"`
	// DisplayName - READ-ONLY; Display Name for the product system.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - READ-ONLY; Description related to the product system.
	Description *Description `json:"description,omitempty"`
	// ImageInformation - READ-ONLY; Image information for the product system.
	ImageInformation *[]ImageInformation `json:"imageInformation,omitempty"`
	// CostInformation - READ-ONLY; Cost information for the product system.
	CostInformation *CostInformation `json:"costInformation,omitempty"`
	// AvailabilityInformation - READ-ONLY; Availability information of the product system.
	AvailabilityInformation *AvailabilityInformation `json:"availabilityInformation,omitempty"`
	// HierarchyInformation - READ-ONLY; Hierarchy information of a product.
	HierarchyInformation *HierarchyInformation `json:"hierarchyInformation,omitempty"`
}

ProductProperties properties of products

func (ProductProperties) MarshalJSON

func (pp ProductProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductProperties.

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON

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

MarshalJSON is the custom marshaler for ProxyResource.

type PurchaseMeterDetails

type PurchaseMeterDetails struct {
	// ProductID - READ-ONLY; Product Id
	ProductID *string `json:"productId,omitempty"`
	// SkuID - READ-ONLY; Sku Id
	SkuID *string `json:"skuId,omitempty"`
	// TermID - READ-ONLY; Term Id
	TermID *string `json:"termId,omitempty"`
	// Multiplier - READ-ONLY; Billing unit applicable for Pav2 billing
	Multiplier *float64 `json:"multiplier,omitempty"`
	// ChargingType - READ-ONLY; Charging type. Possible values include: 'ChargingTypePerOrder', 'ChargingTypePerDevice'
	ChargingType ChargingType `json:"chargingType,omitempty"`
	// BillingType - Possible values include: 'BillingTypeMeterDetails', 'BillingTypePav2', 'BillingTypePurchase'
	BillingType BillingType `json:"billingType,omitempty"`
}

PurchaseMeterDetails billing type Purchase meter details

func (PurchaseMeterDetails) AsBasicMeterDetails

func (pmd PurchaseMeterDetails) AsBasicMeterDetails() (BasicMeterDetails, bool)

AsBasicMeterDetails is the BasicMeterDetails implementation for PurchaseMeterDetails.

func (PurchaseMeterDetails) AsMeterDetails

func (pmd PurchaseMeterDetails) AsMeterDetails() (*MeterDetails, bool)

AsMeterDetails is the BasicMeterDetails implementation for PurchaseMeterDetails.

func (PurchaseMeterDetails) AsPav2MeterDetails

func (pmd PurchaseMeterDetails) AsPav2MeterDetails() (*Pav2MeterDetails, bool)

AsPav2MeterDetails is the BasicMeterDetails implementation for PurchaseMeterDetails.

func (PurchaseMeterDetails) AsPurchaseMeterDetails

func (pmd PurchaseMeterDetails) AsPurchaseMeterDetails() (*PurchaseMeterDetails, bool)

AsPurchaseMeterDetails is the BasicMeterDetails implementation for PurchaseMeterDetails.

func (PurchaseMeterDetails) MarshalJSON

func (pmd PurchaseMeterDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PurchaseMeterDetails.

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON

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

MarshalJSON is the custom marshaler for Resource.

type ResourceIdentity

type ResourceIdentity struct {
	// Type - Identity type
	Type *string `json:"type,omitempty"`
	// PrincipalID - READ-ONLY; Service Principal Id backing the Msi
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; Home Tenant Id
	TenantID *string `json:"tenantId,omitempty"`
}

ResourceIdentity msi identity details of the resource

func (ResourceIdentity) MarshalJSON

func (ri ResourceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceIdentity.

type ResourceProviderDetails

type ResourceProviderDetails struct {
	// ResourceProviderNamespace - READ-ONLY; Resource provider namespace
	ResourceProviderNamespace *string `json:"resourceProviderNamespace,omitempty"`
}

ResourceProviderDetails management RP details

func (ResourceProviderDetails) MarshalJSON

func (rpd ResourceProviderDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceProviderDetails.

type ReturnOrderItemDetails

type ReturnOrderItemDetails struct {
	// ReturnAddress - customer return address.
	ReturnAddress *AddressProperties `json:"returnAddress,omitempty"`
	// ReturnReason - Return Reason.
	ReturnReason *string `json:"returnReason,omitempty"`
	// ServiceTag - Service tag (located on the bottom-right corner of the device)
	ServiceTag *string `json:"serviceTag,omitempty"`
	// ShippingBoxRequired - Shipping Box required
	ShippingBoxRequired *bool `json:"shippingBoxRequired,omitempty"`
}

ReturnOrderItemDetails return order item request body

type ReturnOrderItemFuture

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

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

func (*ReturnOrderItemFuture) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ReverseShippingDetails

type ReverseShippingDetails struct {
	// SasKeyForLabel - READ-ONLY; SAS key to download the reverse shipment label of the package.
	SasKeyForLabel *string `json:"sasKeyForLabel,omitempty"`
	// CarrierName - READ-ONLY; Name of the carrier.
	CarrierName *string `json:"carrierName,omitempty"`
	// CarrierDisplayName - READ-ONLY; Carrier Name for display purpose. Not to be used for any processing.
	CarrierDisplayName *string `json:"carrierDisplayName,omitempty"`
	// TrackingID - READ-ONLY; TrackingId of the package
	TrackingID *string `json:"trackingId,omitempty"`
	// TrackingURL - READ-ONLY; TrackingUrl of the package.
	TrackingURL *string `json:"trackingUrl,omitempty"`
}

ReverseShippingDetails reverse shipment details.

func (ReverseShippingDetails) MarshalJSON

func (rsd ReverseShippingDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ReverseShippingDetails.

type ShippingAddress

type ShippingAddress struct {
	// StreetAddress1 - Street Address line 1.
	StreetAddress1 *string `json:"streetAddress1,omitempty"`
	// StreetAddress2 - Street Address line 2.
	StreetAddress2 *string `json:"streetAddress2,omitempty"`
	// StreetAddress3 - Street Address line 3.
	StreetAddress3 *string `json:"streetAddress3,omitempty"`
	// City - Name of the City.
	City *string `json:"city,omitempty"`
	// StateOrProvince - Name of the State or Province.
	StateOrProvince *string `json:"stateOrProvince,omitempty"`
	// Country - Name of the Country.
	Country *string `json:"country,omitempty"`
	// PostalCode - Postal code.
	PostalCode *string `json:"postalCode,omitempty"`
	// ZipExtendedCode - Extended Zip Code.
	ZipExtendedCode *string `json:"zipExtendedCode,omitempty"`
	// CompanyName - Name of the company.
	CompanyName *string `json:"companyName,omitempty"`
	// AddressType - Type of address. Possible values include: 'AddressTypeNone', 'AddressTypeResidential', 'AddressTypeCommercial'
	AddressType AddressType `json:"addressType,omitempty"`
}

ShippingAddress shipping address where customer wishes to receive the device.

type ShippingDetails

type ShippingDetails struct {
	// CarrierName - READ-ONLY; Name of the carrier.
	CarrierName *string `json:"carrierName,omitempty"`
	// CarrierDisplayName - READ-ONLY; Carrier Name for display purpose. Not to be used for any processing.
	CarrierDisplayName *string `json:"carrierDisplayName,omitempty"`
	// TrackingID - READ-ONLY; TrackingId of the package
	TrackingID *string `json:"trackingId,omitempty"`
	// TrackingURL - READ-ONLY; TrackingUrl of the package.
	TrackingURL *string `json:"trackingUrl,omitempty"`
}

ShippingDetails package shipping details

func (ShippingDetails) MarshalJSON

func (sd ShippingDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ShippingDetails.

type Specification

type Specification struct {
	// Name - READ-ONLY; Name of the specification
	Name *string `json:"name,omitempty"`
	// Value - READ-ONLY; Value of the specification
	Value *string `json:"value,omitempty"`
}

Specification specifications of the configurations

func (Specification) MarshalJSON

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

MarshalJSON is the custom marshaler for Specification.

type StageDetails

type StageDetails struct {
	// StageStatus - READ-ONLY; Stage status. Possible values include: 'StageStatusNone', 'StageStatusInProgress', 'StageStatusSucceeded', 'StageStatusFailed', 'StageStatusCancelled', 'StageStatusCancelling'
	StageStatus StageStatus `json:"stageStatus,omitempty"`
	// StageName - READ-ONLY; Stage name. Possible values include: 'StageNamePlaced', 'StageNameInReview', 'StageNameConfirmed', 'StageNameReadyToShip', 'StageNameShipped', 'StageNameDelivered', 'StageNameInUse', 'StageNameReturnInitiated', 'StageNameReturnPickedUp', 'StageNameReturnedToMicrosoft', 'StageNameReturnCompleted', 'StageNameCancelled'
	StageName StageName `json:"stageName,omitempty"`
	// DisplayName - READ-ONLY; Display name of the resource stage.
	DisplayName *string `json:"displayName,omitempty"`
	// StartTime - READ-ONLY; Stage start time
	StartTime *date.Time `json:"startTime,omitempty"`
}

StageDetails resource stage details.

func (StageDetails) MarshalJSON

func (sd StageDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StageDetails.

type StageName

type StageName string

StageName enumerates the values for stage name.

const (
	// StageNameCancelled Order has been cancelled.
	StageNameCancelled StageName = "Cancelled"
	// StageNameConfirmed Order is confirmed
	StageNameConfirmed StageName = "Confirmed"
	// StageNameDelivered Order is delivered to customer
	StageNameDelivered StageName = "Delivered"
	// StageNameInReview Order is currently in draft mode and can still be cancelled
	StageNameInReview StageName = "InReview"
	// StageNameInUse Order is in use at customer site
	StageNameInUse StageName = "InUse"
	// StageNamePlaced Currently in draft mode and can still be cancelled
	StageNamePlaced StageName = "Placed"
	// StageNameReadyToShip Order is ready to ship
	StageNameReadyToShip StageName = "ReadyToShip"
	// StageNameReturnCompleted Return has now completed.
	StageNameReturnCompleted StageName = "ReturnCompleted"
	// StageNameReturnedToMicrosoft Order has been received back to microsoft.
	StageNameReturnedToMicrosoft StageName = "ReturnedToMicrosoft"
	// StageNameReturnInitiated Return has been initiated by customer.
	StageNameReturnInitiated StageName = "ReturnInitiated"
	// StageNameReturnPickedUp Order is in transit from customer to microsoft.
	StageNameReturnPickedUp StageName = "ReturnPickedUp"
	// StageNameShipped Order is in transit to customer
	StageNameShipped StageName = "Shipped"
)

func PossibleStageNameValues

func PossibleStageNameValues() []StageName

PossibleStageNameValues returns an array of possible values for the StageName const type.

type StageStatus

type StageStatus string

StageStatus enumerates the values for stage status.

const (
	// StageStatusCancelled Stage has been cancelled.
	StageStatusCancelled StageStatus = "Cancelled"
	// StageStatusCancelling Stage is cancelling.
	StageStatusCancelling StageStatus = "Cancelling"
	// StageStatusFailed Stage has failed.
	StageStatusFailed StageStatus = "Failed"
	// StageStatusInProgress Stage is in progress.
	StageStatusInProgress StageStatus = "InProgress"
	// StageStatusNone No status available yet.
	StageStatusNone StageStatus = "None"
	// StageStatusSucceeded Stage has succeeded.
	StageStatusSucceeded StageStatus = "Succeeded"
)

func PossibleStageStatusValues

func PossibleStageStatusValues() []StageStatus

PossibleStageStatusValues returns an array of possible values for the StageStatus const type.

type SupportedFilterTypes

type SupportedFilterTypes string

SupportedFilterTypes enumerates the values for supported filter types.

const (
	// SupportedFilterTypesDoubleEncryptionStatus Double encryption status
	SupportedFilterTypesDoubleEncryptionStatus SupportedFilterTypes = "DoubleEncryptionStatus"
	// SupportedFilterTypesShipToCountries Ship to country
	SupportedFilterTypesShipToCountries SupportedFilterTypes = "ShipToCountries"
)

func PossibleSupportedFilterTypesValues

func PossibleSupportedFilterTypesValues() []SupportedFilterTypes

PossibleSupportedFilterTypesValues returns an array of possible values for the SupportedFilterTypes const type.

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 TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type TransportPreferences

type TransportPreferences struct {
	// PreferredShipmentType - Indicates Shipment Logistics type that the customer preferred. Possible values include: 'TransportShipmentTypesCustomerManaged', 'TransportShipmentTypesMicrosoftManaged'
	PreferredShipmentType TransportShipmentTypes `json:"preferredShipmentType,omitempty"`
}

TransportPreferences preferences related to the shipment logistics of the sku

type TransportShipmentTypes

type TransportShipmentTypes string

TransportShipmentTypes enumerates the values for transport shipment types.

const (
	// TransportShipmentTypesCustomerManaged Shipment Logistics is handled by the customer.
	TransportShipmentTypesCustomerManaged TransportShipmentTypes = "CustomerManaged"
	// TransportShipmentTypesMicrosoftManaged Shipment Logistics is handled by Microsoft.
	TransportShipmentTypesMicrosoftManaged TransportShipmentTypes = "MicrosoftManaged"
)

func PossibleTransportShipmentTypesValues

func PossibleTransportShipmentTypesValues() []TransportShipmentTypes

PossibleTransportShipmentTypesValues returns an array of possible values for the TransportShipmentTypes const type.

type UpdateAddressFuture

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

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

func (*UpdateAddressFuture) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type UpdateOrderItemFuture

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

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

func (*UpdateOrderItemFuture) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type WeightMeasurementUnit

type WeightMeasurementUnit string

WeightMeasurementUnit enumerates the values for weight measurement unit.

const (
	// WeightMeasurementUnitKGS Kilograms.
	WeightMeasurementUnitKGS WeightMeasurementUnit = "KGS"
	// WeightMeasurementUnitLBS Pounds.
	WeightMeasurementUnitLBS WeightMeasurementUnit = "LBS"
)

func PossibleWeightMeasurementUnitValues

func PossibleWeightMeasurementUnitValues() []WeightMeasurementUnit

PossibleWeightMeasurementUnitValues returns an array of possible values for the WeightMeasurementUnit const type.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL