Formulas interface

Interface representing a Formulas.

Methods

beginCreateOrUpdate(string, string, string, Formula, FormulasCreateOrUpdateOptionalParams)

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

beginCreateOrUpdateAndWait(string, string, string, Formula, FormulasCreateOrUpdateOptionalParams)

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

delete(string, string, string, FormulasDeleteOptionalParams)

Delete formula.

get(string, string, string, FormulasGetOptionalParams)

Get formula.

list(string, string, FormulasListOptionalParams)

List formulas in a given lab.

update(string, string, string, FormulaFragment, FormulasUpdateOptionalParams)

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

Method Details

beginCreateOrUpdate(string, string, string, Formula, FormulasCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, labName: string, name: string, formula: Formula, options?: FormulasCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Formula>, Formula>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the formula.

formula
Formula

A formula for creating a VM, specifying an image base and other parameters

options
FormulasCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Formula>, Formula>>

beginCreateOrUpdateAndWait(string, string, string, Formula, FormulasCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, name: string, formula: Formula, options?: FormulasCreateOrUpdateOptionalParams): Promise<Formula>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the formula.

formula
Formula

A formula for creating a VM, specifying an image base and other parameters

options
FormulasCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Formula>

delete(string, string, string, FormulasDeleteOptionalParams)

Delete formula.

function delete(resourceGroupName: string, labName: string, name: string, options?: FormulasDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the formula.

options
FormulasDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, FormulasGetOptionalParams)

Get formula.

function get(resourceGroupName: string, labName: string, name: string, options?: FormulasGetOptionalParams): Promise<Formula>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the formula.

options
FormulasGetOptionalParams

The options parameters.

Returns

Promise<Formula>

list(string, string, FormulasListOptionalParams)

List formulas in a given lab.

function list(resourceGroupName: string, labName: string, options?: FormulasListOptionalParams): PagedAsyncIterableIterator<Formula, Formula[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

options
FormulasListOptionalParams

The options parameters.

Returns

update(string, string, string, FormulaFragment, FormulasUpdateOptionalParams)

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

function update(resourceGroupName: string, labName: string, name: string, formula: FormulaFragment, options?: FormulasUpdateOptionalParams): Promise<Formula>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the formula.

formula
FormulaFragment

A formula for creating a VM, specifying an image base and other parameters

options
FormulasUpdateOptionalParams

The options parameters.

Returns

Promise<Formula>