Documentation ¶
Overview ¶
Package marketplaceordering implements the Azure ARM Marketplaceordering service API version 2015-06-01.
REST API for MarketplaceOrdering Agreements.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AgreementProperties
- type AgreementTerms
- type BaseClient
- type ErrorResponse
- type ErrorResponseError
- type MarketplaceAgreementsClient
- func (client MarketplaceAgreementsClient) Create(ctx context.Context, publisherID string, offerID string, planID string, ...) (result AgreementTerms, err error)
- func (client MarketplaceAgreementsClient) CreatePreparer(ctx context.Context, publisherID string, offerID string, planID string, ...) (*http.Request, error)
- func (client MarketplaceAgreementsClient) CreateResponder(resp *http.Response) (result AgreementTerms, err error)
- func (client MarketplaceAgreementsClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client MarketplaceAgreementsClient) Get(ctx context.Context, publisherID string, offerID string, planID string) (result AgreementTerms, err error)
- func (client MarketplaceAgreementsClient) GetPreparer(ctx context.Context, publisherID string, offerID string, planID string) (*http.Request, error)
- func (client MarketplaceAgreementsClient) GetResponder(resp *http.Response) (result AgreementTerms, err error)
- func (client MarketplaceAgreementsClient) GetSender(req *http.Request) (*http.Response, error)
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- type OperationListResultPage
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type Resource
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Marketplaceordering
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 AgreementProperties ¶
type AgreementProperties struct { // Publisher - Publisher identifier string of image being deployed. Publisher *string `json:"publisher,omitempty"` // Product - Offer identifier string of image being deployed. Product *string `json:"product,omitempty"` // Plan - Plan identifier string of image being deployed. Plan *string `json:"plan,omitempty"` // LicenseTextLink - Link to HTML with Microsoft and Publisher terms. LicenseTextLink *string `json:"licenseTextLink,omitempty"` // PrivacyPolicyLink - Link to the privacy policy of the publisher. PrivacyPolicyLink *string `json:"privacyPolicyLink,omitempty"` // RetrieveDatetime - Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. RetrieveDatetime *date.Time `json:"retrieveDatetime,omitempty"` // Signature - Terms signature. Signature *string `json:"signature,omitempty"` // Accepted - If any version of the terms have been accepted, otherwise false. Accepted *bool `json:"accepted,omitempty"` }
AgreementProperties agreement Terms definition
type AgreementTerms ¶
type AgreementTerms struct { autorest.Response `json:"-"` // AgreementProperties - Represents the properties of the resource. *AgreementProperties `json:"properties,omitempty"` // ID - Resource ID. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` }
AgreementTerms terms properties for provided Publisher/Offer/Plan tuple
func (AgreementTerms) MarshalJSON ¶
func (at AgreementTerms) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AgreementTerms.
func (*AgreementTerms) UnmarshalJSON ¶
func (at *AgreementTerms) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AgreementTerms struct.
type BaseClient ¶
BaseClient is the base client for Marketplaceordering.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type ErrorResponse ¶
type ErrorResponse struct { // Error - The details of the error. Error *ErrorResponseError `json:"error,omitempty"` }
ErrorResponse error reponse indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message.
type ErrorResponseError ¶
type ErrorResponseError struct { // Code - Error code. Code *string `json:"code,omitempty"` // Message - Error message indicating why the operation failed. Message *string `json:"message,omitempty"` }
ErrorResponseError the details of the error.
type MarketplaceAgreementsClient ¶
type MarketplaceAgreementsClient struct {
BaseClient
}
MarketplaceAgreementsClient is the REST API for MarketplaceOrdering Agreements.
func NewMarketplaceAgreementsClient ¶
func NewMarketplaceAgreementsClient(subscriptionID string) MarketplaceAgreementsClient
NewMarketplaceAgreementsClient creates an instance of the MarketplaceAgreementsClient client.
func NewMarketplaceAgreementsClientWithBaseURI ¶
func NewMarketplaceAgreementsClientWithBaseURI(baseURI string, subscriptionID string) MarketplaceAgreementsClient
NewMarketplaceAgreementsClientWithBaseURI creates an instance of the MarketplaceAgreementsClient client.
func (MarketplaceAgreementsClient) Create ¶
func (client MarketplaceAgreementsClient) Create(ctx context.Context, publisherID string, offerID string, planID string, parameters AgreementTerms) (result AgreementTerms, err error)
Create save marketplace terms. Parameters: publisherID - publisher identifier string of image being deployed. offerID - offer identifier string of image being deployed. planID - plan identifier string of image being deployed. parameters - parameters supplied to the Create Marketplace Terms operation.
func (MarketplaceAgreementsClient) CreatePreparer ¶
func (client MarketplaceAgreementsClient) CreatePreparer(ctx context.Context, publisherID string, offerID string, planID string, parameters AgreementTerms) (*http.Request, error)
CreatePreparer prepares the Create request.
func (MarketplaceAgreementsClient) CreateResponder ¶
func (client MarketplaceAgreementsClient) CreateResponder(resp *http.Response) (result AgreementTerms, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (MarketplaceAgreementsClient) CreateSender ¶
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (MarketplaceAgreementsClient) Get ¶
func (client MarketplaceAgreementsClient) Get(ctx context.Context, publisherID string, offerID string, planID string) (result AgreementTerms, err error)
Get get marketplace terms. Parameters: publisherID - publisher identifier string of image being deployed. offerID - offer identifier string of image being deployed. planID - plan identifier string of image being deployed.
func (MarketplaceAgreementsClient) GetPreparer ¶
func (client MarketplaceAgreementsClient) GetPreparer(ctx context.Context, publisherID string, offerID string, planID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (MarketplaceAgreementsClient) GetResponder ¶
func (client MarketplaceAgreementsClient) GetResponder(resp *http.Response) (result AgreementTerms, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
type Operation ¶
type Operation struct { // Name - Operation name: {provider}/{resource}/{operation} Name *string `json:"name,omitempty"` // Display - The object that represents the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation microsoft.MarketplaceOrdering REST API operation
type OperationDisplay ¶
type OperationDisplay struct { // Provider - Service provider: Microsoft.MarketplaceOrdering Provider *string `json:"provider,omitempty"` // Resource - Resource on which the operation is performed: Agreement, virtualmachine, etc. Resource *string `json:"resource,omitempty"` // Operation - Operation type: Get Agreement, Sign Agreement, Cancel Agreement etc. Operation *string `json:"operation,omitempty"` }
OperationDisplay the object that represents the operation.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - List of Microsoft.MarketplaceOrdering operations supported by the Microsoft.MarketplaceOrdering resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - URL to get the next set of operation list results if there are any. NextLink *string `json:"nextLink,omitempty"` }
OperationListResult result of the request to list MarketplaceOrdering operations. It contains a list of operations and a 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.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
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.
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 ¶
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultIterator) Value ¶
func (iter OperationListResultIterator) Value() Operation
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 (*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.
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 ¶
func (page OperationListResultPage) Response() OperationListResult
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 OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the REST API for MarketplaceOrdering Agreements.
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Microsoft.MarketplaceOrdering REST API operations.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.