Package version:

Interface DevBoxDefinitions

Interface representing a DevBoxDefinitions.

Hierarchy

DevBoxDefinitions

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getByProject listByDevCenter listByProject

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinition, options?: DevBoxDefinitionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DevBoxDefinition>, DevBoxDefinition>>
Creates or updates a Dev Box definition.
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.
- Optional options: DevBoxDefinitionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DevBoxDefinition>, DevBoxDefinition>>
- Defined in operationsInterfaces/devBoxDefinitions.ts:73

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinition, options?: DevBoxDefinitionsCreateOrUpdateOptionalParams): Promise<DevBoxDefinition>
Creates or updates a Dev Box definition.
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.
- Optional options: DevBoxDefinitionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DevBoxDefinition>
- Defined in operationsInterfaces/devBoxDefinitions.ts:93

beginDelete

beginDelete(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a Dev Box definition
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.
- Optional options: DevBoxDefinitionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/devBoxDefinitions.ts:142

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsDeleteOptionalParams): Promise<void>
Deletes a Dev Box definition
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.
- Optional options: DevBoxDefinitionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devBoxDefinitions.ts:155

beginUpdate

beginUpdate(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinitionUpdate, options?: DevBoxDefinitionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DevBoxDefinition>, DevBoxDefinition>>
Partially updates a Dev Box definition.
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.
- Optional options: DevBoxDefinitionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DevBoxDefinition>, DevBoxDefinition>>
- Defined in operationsInterfaces/devBoxDefinitions.ts:108

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinitionUpdate, options?: DevBoxDefinitionsUpdateOptionalParams): Promise<DevBoxDefinition>
Partially updates a Dev Box definition.
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.
- Optional options: DevBoxDefinitionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<DevBoxDefinition>
- Defined in operationsInterfaces/devBoxDefinitions.ts:128

get

get(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsGetOptionalParams): Promise<DevBoxDefinition>
Gets a Dev Box definition
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.
- Optional options: DevBoxDefinitionsGetOptionalParams
  
  The options parameters.
Returns Promise<DevBoxDefinition>
- Defined in operationsInterfaces/devBoxDefinitions.ts:59

getByProject

getByProject(resourceGroupName: string, projectName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsGetByProjectOptionalParams): Promise<DevBoxDefinition>
Gets a Dev Box definition configured for a project
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.
- Optional options: DevBoxDefinitionsGetByProjectOptionalParams
  
  The options parameters.
Returns Promise<DevBoxDefinition>
- Defined in operationsInterfaces/devBoxDefinitions.ts:168

listByDevCenter

listByDevCenter(resourceGroupName: string, devCenterName: string, options?: DevBoxDefinitionsListByDevCenterOptionalParams): PagedAsyncIterableIterator<DevBoxDefinition>
List Dev Box definitions for a devcenter.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- devCenterName: string
  
  The name of the devcenter.
- Optional options: DevBoxDefinitionsListByDevCenterOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DevBoxDefinition>
- Defined in operationsInterfaces/devBoxDefinitions.ts:36

listByProject

listByProject(resourceGroupName: string, projectName: string, options?: DevBoxDefinitionsListByProjectOptionalParams): PagedAsyncIterableIterator<DevBoxDefinition>
List Dev Box definitions configured for a project.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- Optional options: DevBoxDefinitionsListByProjectOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DevBoxDefinition>
- Defined in operationsInterfaces/devBoxDefinitions.ts:47

Interface DevBoxDefinitions

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

body: DevBoxDefinition

Optional options: DevBoxDefinitionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DevBoxDefinition>, DevBoxDefinition>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

body: DevBoxDefinition

Optional options: DevBoxDefinitionsCreateOrUpdateOptionalParams

Returns Promise<DevBoxDefinition>

beginDelete

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

Optional options: DevBoxDefinitionsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

Optional options: DevBoxDefinitionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

body: DevBoxDefinitionUpdate

Optional options: DevBoxDefinitionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DevBoxDefinition>, DevBoxDefinition>>

beginUpdateAndWait

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

body: DevBoxDefinitionUpdate

Optional options: DevBoxDefinitionsUpdateOptionalParams

Returns Promise<DevBoxDefinition>

get

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

Optional options: DevBoxDefinitionsGetOptionalParams

Returns Promise<DevBoxDefinition>

getByProject

Parameters

resourceGroupName: string

projectName: string

devBoxDefinitionName: string

Optional options: DevBoxDefinitionsGetByProjectOptionalParams

Returns Promise<DevBoxDefinition>

listByDevCenter

Parameters

resourceGroupName: string

devCenterName: string

Optional options: DevBoxDefinitionsListByDevCenterOptionalParams

Returns PagedAsyncIterableIterator<DevBoxDefinition>

listByProject

Parameters

resourceGroupName: string

projectName: string

Optional options: DevBoxDefinitionsListByProjectOptionalParams

Returns PagedAsyncIterableIterator<DevBoxDefinition>

Settings

Member Visibility

Theme

`Optional` options: DevBoxDefinitionsCreateOrUpdateOptionalParams

`Optional` options: DevBoxDefinitionsCreateOrUpdateOptionalParams

`Optional` options: DevBoxDefinitionsDeleteOptionalParams

`Optional` options: DevBoxDefinitionsDeleteOptionalParams

`Optional` options: DevBoxDefinitionsUpdateOptionalParams

`Optional` options: DevBoxDefinitionsUpdateOptionalParams

`Optional` options: DevBoxDefinitionsGetOptionalParams

`Optional` options: DevBoxDefinitionsGetByProjectOptionalParams

`Optional` options: DevBoxDefinitionsListByDevCenterOptionalParams

`Optional` options: DevBoxDefinitionsListByProjectOptionalParams