azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/marketplaceordering/mgmt/2015-06-01/marketplaceordering Index | Files | Directories

package marketplaceordering

import "github.com/Azure/azure-sdk-for-go/services/marketplaceordering/mgmt/2015-06-01/marketplaceordering"

Package marketplaceordering implements the Azure ARM Marketplaceordering service API version 2015-06-01.

REST API for MarketplaceOrdering Agreements.

Index

Package Files

client.go marketplaceagreements.go models.go operations.go version.go

Constants

❖
const (
    // DefaultBaseURI is the default URI used for the service Marketplaceordering
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent Uses

❖
func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version Uses

❖
func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type AgreementProperties Uses

❖
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 Uses

❖
type AgreementTerms struct {
    autorest.Response `json:"-"`
    // AgreementProperties - Represents the properties of the resource.
    *AgreementProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; Resource ID.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type.
    Type *string `json:"type,omitempty"`
}

AgreementTerms terms properties for provided Publisher/Offer/Plan tuple

func (AgreementTerms) MarshalJSON Uses

❖
func (at AgreementTerms) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AgreementTerms.

func (*AgreementTerms) UnmarshalJSON Uses

❖
func (at *AgreementTerms) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AgreementTerms struct.

type BaseClient Uses

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

BaseClient is the base client for Marketplaceordering.

func New Uses

❖
func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

❖
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).

type ErrorResponse Uses

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

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

type ErrorResponseError Uses

❖
type ErrorResponseError struct {
    // Code - READ-ONLY; Error code.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; Error message indicating why the operation failed.
    Message *string `json:"message,omitempty"`
}

ErrorResponseError the details of the error.

type ListAgreementTerms Uses

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

ListAgreementTerms ...

type MarketplaceAgreementsClient Uses

❖
type MarketplaceAgreementsClient struct {
    BaseClient
}

MarketplaceAgreementsClient is the REST API for MarketplaceOrdering Agreements.

func NewMarketplaceAgreementsClient Uses

❖
func NewMarketplaceAgreementsClient(subscriptionID string) MarketplaceAgreementsClient

NewMarketplaceAgreementsClient creates an instance of the MarketplaceAgreementsClient client.

func NewMarketplaceAgreementsClientWithBaseURI Uses

❖
func NewMarketplaceAgreementsClientWithBaseURI(baseURI string, subscriptionID string) MarketplaceAgreementsClient

NewMarketplaceAgreementsClientWithBaseURI creates an instance of the MarketplaceAgreementsClient 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 (MarketplaceAgreementsClient) Cancel Uses

❖
func (client MarketplaceAgreementsClient) Cancel(ctx context.Context, publisherID string, offerID string, planID string) (result AgreementTerms, err error)

Cancel cancel 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) CancelPreparer Uses

❖
func (client MarketplaceAgreementsClient) CancelPreparer(ctx context.Context, publisherID string, offerID string, planID string) (*http.Request, error)

CancelPreparer prepares the Cancel request.

func (MarketplaceAgreementsClient) CancelResponder Uses

❖
func (client MarketplaceAgreementsClient) CancelResponder(resp *http.Response) (result AgreementTerms, err error)

CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.

func (MarketplaceAgreementsClient) CancelSender Uses

❖
func (client MarketplaceAgreementsClient) CancelSender(req *http.Request) (*http.Response, error)

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

func (MarketplaceAgreementsClient) Create Uses

❖
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 Uses

❖
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 Uses

❖
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 Uses

❖
func (client MarketplaceAgreementsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (MarketplaceAgreementsClient) Get Uses

❖
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) GetAgreement Uses

❖
func (client MarketplaceAgreementsClient) GetAgreement(ctx context.Context, publisherID string, offerID string, planID string) (result AgreementTerms, err error)

GetAgreement get marketplace agreement. 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) GetAgreementPreparer Uses

❖
func (client MarketplaceAgreementsClient) GetAgreementPreparer(ctx context.Context, publisherID string, offerID string, planID string) (*http.Request, error)

GetAgreementPreparer prepares the GetAgreement request.

func (MarketplaceAgreementsClient) GetAgreementResponder Uses

❖
func (client MarketplaceAgreementsClient) GetAgreementResponder(resp *http.Response) (result AgreementTerms, err error)

GetAgreementResponder handles the response to the GetAgreement request. The method always closes the http.Response Body.

func (MarketplaceAgreementsClient) GetAgreementSender Uses

❖
func (client MarketplaceAgreementsClient) GetAgreementSender(req *http.Request) (*http.Response, error)

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

func (MarketplaceAgreementsClient) GetPreparer Uses

❖
func (client MarketplaceAgreementsClient) GetPreparer(ctx context.Context, publisherID string, offerID string, planID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (MarketplaceAgreementsClient) GetResponder Uses

❖
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.

func (MarketplaceAgreementsClient) GetSender Uses

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

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

func (MarketplaceAgreementsClient) List Uses

❖
func (client MarketplaceAgreementsClient) List(ctx context.Context) (result ListAgreementTerms, err error)

List list marketplace agreements in the subscription.

func (MarketplaceAgreementsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (MarketplaceAgreementsClient) ListResponder Uses

❖
func (client MarketplaceAgreementsClient) ListResponder(resp *http.Response) (result ListAgreementTerms, err error)

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

func (MarketplaceAgreementsClient) ListSender Uses

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

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

func (MarketplaceAgreementsClient) Sign Uses

❖
func (client MarketplaceAgreementsClient) Sign(ctx context.Context, publisherID string, offerID string, planID string) (result AgreementTerms, err error)

Sign sign 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) SignPreparer Uses

❖
func (client MarketplaceAgreementsClient) SignPreparer(ctx context.Context, publisherID string, offerID string, planID string) (*http.Request, error)

SignPreparer prepares the Sign request.

func (MarketplaceAgreementsClient) SignResponder Uses

❖
func (client MarketplaceAgreementsClient) SignResponder(resp *http.Response) (result AgreementTerms, err error)

SignResponder handles the response to the Sign request. The method always closes the http.Response Body.

func (MarketplaceAgreementsClient) SignSender Uses

❖
func (client MarketplaceAgreementsClient) SignSender(req *http.Request) (*http.Response, error)

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

type Operation Uses

❖
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 Uses

❖
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 Uses

❖
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 - READ-ONLY; 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 Uses

❖
func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator Uses

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator Uses

❖
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next Uses

❖
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 Uses

❖
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 Uses

❖
func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response Uses

❖
func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value Uses

❖
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 Uses

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage Uses

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next Uses

❖
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 Uses

❖
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 Uses

❖
func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response Uses

❖
func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values Uses

❖
func (page OperationListResultPage) Values() []Operation

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

type OperationsClient Uses

❖
type OperationsClient struct {
    BaseClient
}

OperationsClient is the REST API for MarketplaceOrdering Agreements.

func NewOperationsClient Uses

❖
func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

❖
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 (OperationsClient) List Uses

❖
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 Uses

❖
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

❖
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 Uses

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

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

type Resource Uses

❖
type Resource struct {
    // ID - READ-ONLY; Resource ID.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type.
    Type *string `json:"type,omitempty"`
}

Resource ARM resource.

Directories

PathSynopsis
marketplaceorderingapi

Package marketplaceordering imports 9 packages (graph) and is imported by 7 packages. Updated 2021-01-20. Refresh now. Tools for package owners.