FormulasOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DevTestLabsClient's

<xref:formulas> attribute.

Constructor

FormulasOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or replace an existing formula. This operation can take a while to complete.
delete

Delete formula.
get

Get formula.
list

List formulas in a given lab.
update

Allows modifying tags of formulas. All other properties will be ignored.

begin_create_or_update

Create or replace an existing formula. This operation can take a while to complete.

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, formula: _models.Formula, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Formula]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the formula. Required.
formula
Required
Formula or IO[bytes]

A formula for creating a VM, specifying an image base and other parameters. Is either a Formula type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Formula]

An instance of LROPoller that returns either Formula or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete formula.

delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the formula. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get formula.

get(resource_group_name: str, lab_name: str, name: str, expand: str | None = None, **kwargs: Any) -> Formula

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the formula. Required.
expand
str

Specify the $expand query. Example: 'properties($select=description)'. Default value is None.

Default value: None

Returns

Type Description
Formula

Formula or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List formulas in a given lab.

list(resource_group_name: str, lab_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[Formula]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
expand
str

Specify the $expand query. Example: 'properties($select=description)'. Default value is None.

Default value: None
filter
str

The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.

Default value: None
top
int

The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

Default value: None
orderby
str

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[Formula]

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

Exceptions

Type Description
HttpResponseError

update

Allows modifying tags of formulas. All other properties will be ignored.

update(resource_group_name: str, lab_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> Formula

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the formula. Required.
tags
dict[str, str]

The tags of the resource. Default value is None.

Default value: None

Returns

Type Description
Formula

Formula or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv125\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>