MarketplaceAgreementsOperations Class

MarketplaceAgreementsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

MarketplaceAgreementsOperations

Constructor

MarketplaceAgreementsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

cancel	Cancel marketplace terms.
create	Save marketplace terms.
get	Get marketplace terms.
get_agreement	Get marketplace agreement.
list	List marketplace agreements in the subscription.
sign	Sign marketplace terms.

cancel

Cancel marketplace terms.

async cancel(publisher_id: str, offer_id: str, plan_id: str, **kwargs) -> azure.mgmt.marketplaceordering.models._models_py3.AgreementTerms

Parameters

publisher_id

str

Required

Publisher identifier string of image being deployed.

offer_id

str

Required

Offer identifier string of image being deployed.

plan_id

str

Required

Plan identifier string of image being deployed.

cls

callable

A custom type or function that will be passed the direct response

Returns

AgreementTerms, or the result of cls(response)

Return type

AgreementTerms

Exceptions

HttpResponseError

create

Save marketplace terms.

async create(offer_type: Union[str, azure.mgmt.marketplaceordering.models._marketplace_ordering_agreements_enums.OfferType], publisher_id: str, offer_id: str, plan_id: str, parameters: azure.mgmt.marketplaceordering.models._models_py3.AgreementTerms, **kwargs) -> azure.mgmt.marketplaceordering.models._models_py3.AgreementTerms

Parameters

offer_type

str or OfferType

Required

Offer Type, currently only virtualmachine type is supported.

publisher_id

str

Required

Publisher identifier string of image being deployed.

offer_id

str

Required

Offer identifier string of image being deployed.

plan_id

str

Required

Plan identifier string of image being deployed.

parameters

AgreementTerms

Required

Parameters supplied to the Create Marketplace Terms operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

AgreementTerms, or the result of cls(response)

Return type

AgreementTerms

Exceptions

HttpResponseError

get

Get marketplace terms.

async get(offer_type: Union[str, azure.mgmt.marketplaceordering.models._marketplace_ordering_agreements_enums.OfferType], publisher_id: str, offer_id: str, plan_id: str, **kwargs) -> azure.mgmt.marketplaceordering.models._models_py3.AgreementTerms

Parameters

offer_type

str or OfferType

Required

Offer Type, currently only virtualmachine type is supported.

publisher_id

str

Required

Publisher identifier string of image being deployed.

offer_id

str

Required

Offer identifier string of image being deployed.

plan_id

str

Required

Plan identifier string of image being deployed.

cls

callable

A custom type or function that will be passed the direct response

Returns

AgreementTerms, or the result of cls(response)

Return type

AgreementTerms

Exceptions

HttpResponseError

get_agreement

Get marketplace agreement.

async get_agreement(publisher_id: str, offer_id: str, plan_id: str, **kwargs) -> azure.mgmt.marketplaceordering.models._models_py3.AgreementTerms

Parameters

publisher_id

str

Required

Publisher identifier string of image being deployed.

offer_id

str

Required

Offer identifier string of image being deployed.

plan_id

str

Required

Plan identifier string of image being deployed.

cls

callable

A custom type or function that will be passed the direct response

Returns

AgreementTerms, or the result of cls(response)

Return type

AgreementTerms

Exceptions

HttpResponseError

list

List marketplace agreements in the subscription.

async list(**kwargs) -> List[azure.mgmt.marketplaceordering.models._models_py3.AgreementTerms]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

list of AgreementTerms, or the result of cls(response)

Return type

list[AgreementTerms]

Exceptions

HttpResponseError

sign

Sign marketplace terms.

async sign(publisher_id: str, offer_id: str, plan_id: str, **kwargs) -> azure.mgmt.marketplaceordering.models._models_py3.AgreementTerms

Parameters

publisher_id

str

Required

Publisher identifier string of image being deployed.

offer_id

str

Required

Offer identifier string of image being deployed.

plan_id

str

Required

Plan identifier string of image being deployed.

cls

callable

A custom type or function that will be passed the direct response

Returns

AgreementTerms, or the result of cls(response)

Return type

AgreementTerms

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.marketplaceordering.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\marketplaceordering\\models\\__init__.py'>