Controllers interface

Package:

@azure/arm-devspaces

Interface representing a Controllers.

Methods

beginCreate(string, string, Controller, ControllersCreateOptionalParams)	Creates an Azure Dev Spaces Controller with the specified create parameters.
beginCreateAndWait(string, string, Controller, ControllersCreateOptionalParams)	Creates an Azure Dev Spaces Controller with the specified create parameters.
beginDelete(string, string, ControllersDeleteOptionalParams)	Deletes an existing Azure Dev Spaces Controller.
beginDeleteAndWait(string, string, ControllersDeleteOptionalParams)	Deletes an existing Azure Dev Spaces Controller.
get(string, string, ControllersGetOptionalParams)	Gets the properties for an Azure Dev Spaces Controller.
list(ControllersListOptionalParams)	Lists all the Azure Dev Spaces Controllers with their properties in the subscription.
listByResourceGroup(string, ControllersListByResourceGroupOptionalParams)	Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.
listConnectionDetails(string, string, ListConnectionDetailsParameters, ControllersListConnectionDetailsOptionalParams)	Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.
update(string, string, ControllerUpdateParameters, ControllersUpdateOptionalParams)	Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.

Method Details

beginCreate(string, string, Controller, ControllersCreateOptionalParams)

Creates an Azure Dev Spaces Controller with the specified create parameters.

function beginCreate(resourceGroupName: string, name: string, controller: Controller, options?: ControllersCreateOptionalParams): Promise<PollerLike<PollOperationState<Controller>, Controller>>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

name

string

Name of the resource.

controller

Controller

Controller create parameters.

options

ControllersCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<Controller>, Controller>>

beginCreateAndWait(string, string, Controller, ControllersCreateOptionalParams)

Creates an Azure Dev Spaces Controller with the specified create parameters.

function beginCreateAndWait(resourceGroupName: string, name: string, controller: Controller, options?: ControllersCreateOptionalParams): Promise<Controller>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

name

string

Name of the resource.

controller

Controller

Controller create parameters.

options

ControllersCreateOptionalParams

The options parameters.

Returns

Promise<Controller>

beginDelete(string, string, ControllersDeleteOptionalParams)

Deletes an existing Azure Dev Spaces Controller.

function beginDelete(resourceGroupName: string, name: string, options?: ControllersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

name

string

Name of the resource.

options

ControllersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ControllersDeleteOptionalParams)

Deletes an existing Azure Dev Spaces Controller.

function beginDeleteAndWait(resourceGroupName: string, name: string, options?: ControllersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

name

string

Name of the resource.

options

ControllersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ControllersGetOptionalParams)

Gets the properties for an Azure Dev Spaces Controller.

function get(resourceGroupName: string, name: string, options?: ControllersGetOptionalParams): Promise<Controller>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

name

string

Name of the resource.

options

ControllersGetOptionalParams

The options parameters.

Returns

Promise<Controller>

list(ControllersListOptionalParams)

Lists all the Azure Dev Spaces Controllers with their properties in the subscription.

function list(options?: ControllersListOptionalParams): PagedAsyncIterableIterator<Controller, Controller[], PageSettings>

Parameters

options

ControllersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Controller, Controller[], PageSettings>

listByResourceGroup(string, ControllersListByResourceGroupOptionalParams)

Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.

function listByResourceGroup(resourceGroupName: string, options?: ControllersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Controller, Controller[], PageSettings>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

options

ControllersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Controller, Controller[], PageSettings>

listConnectionDetails(string, string, ListConnectionDetailsParameters, ControllersListConnectionDetailsOptionalParams)

Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.

function listConnectionDetails(resourceGroupName: string, name: string, listConnectionDetailsParameters: ListConnectionDetailsParameters, options?: ControllersListConnectionDetailsOptionalParams): Promise<ControllerConnectionDetailsList>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

name

string

Name of the resource.

listConnectionDetailsParameters

ListConnectionDetailsParameters

Parameters for listing connection details of Azure Dev Spaces Controller.

options

ControllersListConnectionDetailsOptionalParams

The options parameters.

Returns

Promise<ControllerConnectionDetailsList>

update(string, string, ControllerUpdateParameters, ControllersUpdateOptionalParams)

Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.

function update(resourceGroupName: string, name: string, controllerUpdateParameters: ControllerUpdateParameters, options?: ControllersUpdateOptionalParams): Promise<Controller>

Parameters

resourceGroupName

string

Resource group to which the resource belongs.

name

string

Name of the resource.

controllerUpdateParameters

ControllerUpdateParameters

Parameters for updating the Azure Dev Spaces Controller.

options

ControllersUpdateOptionalParams

The options parameters.

Returns

Promise<Controller>