Feedback Edit

AgreementsOperations Class

  • Reference

AgreementsOperations 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
AgreementsOperations

Constructor

AgreementsOperations(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

get

Gets an agreement by ID.
list_by_billing_account

Lists the agreements for a billing account.

get

Gets an agreement by ID.

get(billing_account_name: str, agreement_name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.Agreement

Parameters

billing_account_name
str
Required

The ID that uniquely identifies a billing account.

agreement_name
str
Required

The ID that uniquely identifies an agreement.

expand
str
default value: None

May be used to expand the participants.

cls
callable

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

Returns

Agreement, or the result of cls(response)

Return type

Agreement

Exceptions

HttpResponseError

list_by_billing_account

Lists the agreements for a billing account.

list_by_billing_account(billing_account_name: str, expand: Optional[str] = None, **kwargs: Any) -> Iterable[_models.AgreementListResult]

Parameters

billing_account_name
str
Required

The ID that uniquely identifies a billing account.

expand
str
default value: None

May be used to expand the participants.

cls
callable

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

Returns

An iterator like instance of either AgreementListResult or the result of cls(response)

Return type

ItemPaged[AgreementListResult]

Exceptions

HttpResponseError

Attributes

models 

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