FormulasOperations Class

FormulasOperations 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

FormulasOperations

Constructor

FormulasOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

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', **kwargs: Any) -> LROPoller['_models.Formula']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the formula.
formula Required	Formula A formula for creating a VM, specifying an image base and other parameters.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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.
lab_name Required	str The name of the lab.
name Required	str The name of the formula.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> _models.Formula

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the formula.
expand	str Specify the $expand query. Example: 'properties($select=description)'. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> Iterable['_models.FormulaList']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
expand	str Specify the $expand query. Example: 'properties($select=description)'. Default value: None
filter	str The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value: None
top	int The maximum number of resources to return from the operation. Example: '$top=10'. Default value: None
orderby	str The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[FormulaList]	An iterator like instance of either FormulaList 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, formula: '_models.FormulaFragment', **kwargs: Any) -> _models.Formula

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the formula.
formula Required	FormulaFragment A formula for creating a VM, specifying an image base and other parameters.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>