AgreementsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:agreements> attribute.
Constructor
AgreementsOperations(*args, **kwargs)Methods
| get |
Gets an agreement by ID. |
| list_by_billing_account |
Lists the agreements for a billing account. |
get
Gets an agreement by ID.
async get(billing_account_name: str, agreement_name: str, **kwargs: Any) -> AgreementParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
agreement_name
Required
|
The ID that uniquely identifies an agreement. Required. |
Returns
| Type | Description |
|---|---|
|
Agreement. The Agreement is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list_by_billing_account
Lists the agreements for a billing account.
list_by_billing_account(billing_account_name: str, *, expand: str | None = None, **kwargs: Any) -> AsyncItemPaged[Agreement]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
expand
|
May be used to expand the participants. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of Agreement |
Exceptions
| Type | Description |
|---|---|
