DevBoxDefinitions interface

Package:

@azure/arm-devcenter

Interface representing a DevBoxDefinitions.

Methods

beginCreateOrUpdate(string, string, string, DevBoxDefinition, DevBoxDefinitionsCreateOrUpdateOptionalParams)	Creates or updates a Dev Box definition.
beginCreateOrUpdateAndWait(string, string, string, DevBoxDefinition, DevBoxDefinitionsCreateOrUpdateOptionalParams)	Creates or updates a Dev Box definition.
beginDelete(string, string, string, DevBoxDefinitionsDeleteOptionalParams)	Deletes a Dev Box definition
beginDeleteAndWait(string, string, string, DevBoxDefinitionsDeleteOptionalParams)	Deletes a Dev Box definition
beginUpdate(string, string, string, DevBoxDefinitionUpdate, DevBoxDefinitionsUpdateOptionalParams)	Partially updates a Dev Box definition.
beginUpdateAndWait(string, string, string, DevBoxDefinitionUpdate, DevBoxDefinitionsUpdateOptionalParams)	Partially updates a Dev Box definition.
get(string, string, string, DevBoxDefinitionsGetOptionalParams)	Gets a Dev Box definition
getByProject(string, string, string, DevBoxDefinitionsGetByProjectOptionalParams)	Gets a Dev Box definition configured for a project
listByDevCenter(string, string, DevBoxDefinitionsListByDevCenterOptionalParams)	List Dev Box definitions for a devcenter.
listByProject(string, string, DevBoxDefinitionsListByProjectOptionalParams)	List Dev Box definitions configured for a project.

Method Details

beginCreateOrUpdate(string, string, string, DevBoxDefinition, DevBoxDefinitionsCreateOrUpdateOptionalParams)

Creates or updates a Dev Box definition.

function beginCreateOrUpdate(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinition, options?: DevBoxDefinitionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DevBoxDefinition>, DevBoxDefinition>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

devBoxDefinitionName

string

The name of the Dev Box definition.

body

DevBoxDefinition

Represents a Dev Box definition.

options

DevBoxDefinitionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DevBoxDefinition>, DevBoxDefinition>>

beginCreateOrUpdateAndWait(string, string, string, DevBoxDefinition, DevBoxDefinitionsCreateOrUpdateOptionalParams)

Creates or updates a Dev Box definition.

function beginCreateOrUpdateAndWait(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinition, options?: DevBoxDefinitionsCreateOrUpdateOptionalParams): Promise<DevBoxDefinition>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

devBoxDefinitionName

string

The name of the Dev Box definition.

body

DevBoxDefinition

Represents a Dev Box definition.

options

DevBoxDefinitionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DevBoxDefinition>

beginDelete(string, string, string, DevBoxDefinitionsDeleteOptionalParams)

Deletes a Dev Box definition

function beginDelete(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DevBoxDefinitionsDeleteHeaders>, DevBoxDefinitionsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

devBoxDefinitionName

string

The name of the Dev Box definition.

options

DevBoxDefinitionsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DevBoxDefinitionsDeleteHeaders>, DevBoxDefinitionsDeleteHeaders>>

beginDeleteAndWait(string, string, string, DevBoxDefinitionsDeleteOptionalParams)

Deletes a Dev Box definition

function beginDeleteAndWait(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsDeleteOptionalParams): Promise<DevBoxDefinitionsDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

devBoxDefinitionName

string

The name of the Dev Box definition.

options

DevBoxDefinitionsDeleteOptionalParams

The options parameters.

Returns

Promise<DevBoxDefinitionsDeleteHeaders>

beginUpdate(string, string, string, DevBoxDefinitionUpdate, DevBoxDefinitionsUpdateOptionalParams)

Partially updates a Dev Box definition.

function beginUpdate(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinitionUpdate, options?: DevBoxDefinitionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DevBoxDefinition>, DevBoxDefinition>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

devBoxDefinitionName

string

The name of the Dev Box definition.

body

DevBoxDefinitionUpdate

Represents a Dev Box definition.

options

DevBoxDefinitionsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DevBoxDefinition>, DevBoxDefinition>>

beginUpdateAndWait(string, string, string, DevBoxDefinitionUpdate, DevBoxDefinitionsUpdateOptionalParams)

Partially updates a Dev Box definition.

function beginUpdateAndWait(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinitionUpdate, options?: DevBoxDefinitionsUpdateOptionalParams): Promise<DevBoxDefinition>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

devBoxDefinitionName

string

The name of the Dev Box definition.

body

DevBoxDefinitionUpdate

Represents a Dev Box definition.

options

DevBoxDefinitionsUpdateOptionalParams

The options parameters.

Returns

Promise<DevBoxDefinition>

get(string, string, string, DevBoxDefinitionsGetOptionalParams)

Gets a Dev Box definition

function get(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsGetOptionalParams): Promise<DevBoxDefinition>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

devBoxDefinitionName

string

The name of the Dev Box definition.

options

DevBoxDefinitionsGetOptionalParams

The options parameters.

Returns

Promise<DevBoxDefinition>

getByProject(string, string, string, DevBoxDefinitionsGetByProjectOptionalParams)

Gets a Dev Box definition configured for a project

function getByProject(resourceGroupName: string, projectName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsGetByProjectOptionalParams): Promise<DevBoxDefinition>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

devBoxDefinitionName

string

The name of the Dev Box definition.

options

DevBoxDefinitionsGetByProjectOptionalParams

The options parameters.

Returns

Promise<DevBoxDefinition>

listByDevCenter(string, string, DevBoxDefinitionsListByDevCenterOptionalParams)

List Dev Box definitions for a devcenter.

function listByDevCenter(resourceGroupName: string, devCenterName: string, options?: DevBoxDefinitionsListByDevCenterOptionalParams): PagedAsyncIterableIterator<DevBoxDefinition, DevBoxDefinition[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

options

DevBoxDefinitionsListByDevCenterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DevBoxDefinition, DevBoxDefinition[], PageSettings>

listByProject(string, string, DevBoxDefinitionsListByProjectOptionalParams)

List Dev Box definitions configured for a project.

function listByProject(resourceGroupName: string, projectName: string, options?: DevBoxDefinitionsListByProjectOptionalParams): PagedAsyncIterableIterator<DevBoxDefinition, DevBoxDefinition[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

options

DevBoxDefinitionsListByProjectOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DevBoxDefinition, DevBoxDefinition[], PageSettings>