DevBoxDefinitions | @azure/arm-devcenter

Interface representing a DevBoxDefinitions.

Hierarchy

DevBoxDefinitions

Implemented by

DevBoxDefinitionsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinition, options?: DevBoxDefinitionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DevBoxDefinitionsCreateOrUpdateResponse>, DevBoxDefinitionsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/devBoxDefinitions.ts:73
Creates or updates a Dev Box definition.

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- 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<DevBoxDefinitionsCreateOrUpdateResponse>, DevBoxDefinitionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/devBoxDefinitions.ts:93
Creates or updates a Dev Box definition.

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- 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<DevBoxDefinitionsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, options?: DevBoxDefinitionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/devBoxDefinitions.ts:142
Deletes a Dev Box definition

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- 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>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/devBoxDefinitions.ts:155
Deletes a Dev Box definition

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- 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>

beginUpdate

beginUpdate(resourceGroupName: string, devCenterName: string, devBoxDefinitionName: string, body: DevBoxDefinitionUpdate, options?: DevBoxDefinitionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DevBoxDefinitionsUpdateResponse>, DevBoxDefinitionsUpdateResponse>>

- Defined in operationsInterfaces/devBoxDefinitions.ts:108
Partially updates a Dev Box definition.

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- 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<DevBoxDefinitionsUpdateResponse>, DevBoxDefinitionsUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/devBoxDefinitions.ts:128
Partially updates a Dev Box definition.

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- 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<DevBoxDefinitionsUpdateResponse>

get

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

- Defined in operationsInterfaces/devBoxDefinitions.ts:59
Gets a Dev Box definition

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- devCenterName: string
  
  The name of the devcenter.
- devBoxDefinitionName: string
  
  The name of the Dev Box definition.
- Optional options: DevBoxDefinitionsGetOptionalParams
  
  The options parameters.
Returns Promise<DevBoxDefinitionsGetResponse>

getByProject

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

- Defined in operationsInterfaces/devBoxDefinitions.ts:168
Gets a Dev Box definition configured for a project

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- projectName: string
  
  The name of the project.
- devBoxDefinitionName: string
  
  The name of the Dev Box definition.
- Optional options: DevBoxDefinitionsGetByProjectOptionalParams
  
  The options parameters.
Returns Promise<DevBoxDefinitionsGetByProjectResponse>

listByDevCenter

listByDevCenter(resourceGroupName: string, devCenterName: string, options?: DevBoxDefinitionsListByDevCenterOptionalParams): PagedAsyncIterableIterator<DevBoxDefinition>

- Defined in operationsInterfaces/devBoxDefinitions.ts:36
List Dev Box definitions for a devcenter.

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- devCenterName: string
  
  The name of the devcenter.
- Optional options: DevBoxDefinitionsListByDevCenterOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DevBoxDefinition>

listByProject

listByProject(resourceGroupName: string, projectName: string, options?: DevBoxDefinitionsListByProjectOptionalParams): PagedAsyncIterableIterator<DevBoxDefinition>

- Defined in operationsInterfaces/devBoxDefinitions.ts:47
List Dev Box definitions configured for a project.

Parameters
- resourceGroupName: string
  
  Name of the resource group within the Azure subscription.
- projectName: string
  
  The name of the project.
- Optional options: DevBoxDefinitionsListByProjectOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DevBoxDefinition>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

body: DevBoxDefinition

Optional options: DevBoxDefinitionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DevBoxDefinitionsCreateOrUpdateResponse>, DevBoxDefinitionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

body: DevBoxDefinition

Optional options: DevBoxDefinitionsCreateOrUpdateOptionalParams

Returns Promise<DevBoxDefinitionsCreateOrUpdateResponse>

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<DevBoxDefinitionsUpdateResponse>, DevBoxDefinitionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

body: DevBoxDefinitionUpdate

Optional options: DevBoxDefinitionsUpdateOptionalParams

Returns Promise<DevBoxDefinitionsUpdateResponse>

get

Parameters

resourceGroupName: string

devCenterName: string

devBoxDefinitionName: string

Optional options: DevBoxDefinitionsGetOptionalParams

Returns Promise<DevBoxDefinitionsGetResponse>

getByProject

Parameters

resourceGroupName: string

projectName: string

devBoxDefinitionName: string

Optional options: DevBoxDefinitionsGetByProjectOptionalParams

Returns Promise<DevBoxDefinitionsGetByProjectResponse>

listByDevCenter

Parameters

resourceGroupName: string

devCenterName: string

Optional options: DevBoxDefinitionsListByDevCenterOptionalParams

Returns PagedAsyncIterableIterator<DevBoxDefinition>

listByProject

Parameters

resourceGroupName: string

projectName: string

Optional options: DevBoxDefinitionsListByProjectOptionalParams

Returns PagedAsyncIterableIterator<DevBoxDefinition>