@azure-rest/developer-devcenter package

Interfaces

CatalogOutput

A catalog.
CreateDevBox200Response

The request has succeeded.
CreateDevBox201Headers
CreateDevBox201Response

The request has succeeded and a new resource has been created as a result.
CreateDevBoxBodyParam
CreateDevBoxDefaultHeaders
CreateDevBoxDefaultResponse
CreateDevBoxLogicalResponse

The final response for long-running CreateDevBox operation
CreateOrUpdateEnvironment201Headers
CreateOrUpdateEnvironment201Response

The request has succeeded and a new resource has been created as a result.
CreateOrUpdateEnvironmentBodyParam
CreateOrUpdateEnvironmentDefaultHeaders
CreateOrUpdateEnvironmentDefaultResponse
CreateOrUpdateEnvironmentLogicalResponse

The final response for long-running CreateOrUpdateEnvironment operation
DelayAction
DelayAction200Response

The request has succeeded.
DelayActionDefaultHeaders
DelayActionDefaultResponse
DelayActionQueryParam
DelayActionQueryParamProperties
DelayAllActions
DelayAllActions200Response

The request has succeeded.
DelayAllActionsDefaultHeaders
DelayAllActionsDefaultResponse
DelayAllActionsQueryParam
DelayAllActionsQueryParamProperties
DeleteDevBox202Headers
DeleteDevBox202Response

The request has been accepted for processing, but processing has not yet completed.
DeleteDevBox204Response

There is no content to send for this request, but the headers may be useful.
DeleteDevBoxDefaultHeaders
DeleteDevBoxDefaultResponse
DeleteDevBoxLogicalResponse

The final response for long-running DeleteDevBox operation
DeleteEnvironment202Headers
DeleteEnvironment202Response

The request has been accepted for processing, but processing has not yet completed.
DeleteEnvironment204Response

There is no content to send for this request, but the headers may be useful.
DeleteEnvironmentDefaultHeaders
DeleteEnvironmentDefaultResponse
DeleteEnvironmentLogicalResponse

The final response for long-running DeleteEnvironment operation
DevBox

A Dev Box
DevBoxActionDelayResultOutput

The action delay result
DevBoxActionOutput

An action which will take place on a Dev Box.
DevBoxNextActionOutput

Details about the next run of an action.
DevBoxOutput

A Dev Box
Environment

Properties of an environment.
EnvironmentDefinitionOutput

An environment definition.
EnvironmentDefinitionParameterOutput

Properties of an Environment Definition parameter
EnvironmentOutput

Properties of an environment.
EnvironmentTypeOutput

Properties of an environment type.
GetCatalog
GetCatalog200Response

The request has succeeded.
GetCatalogDefaultHeaders
GetCatalogDefaultResponse
GetDevBox
GetDevBox200Response

The request has succeeded.
GetDevBoxAction
GetDevBoxAction200Response

The request has succeeded.
GetDevBoxActionDefaultHeaders
GetDevBoxActionDefaultResponse
GetDevBoxDefaultHeaders
GetDevBoxDefaultResponse
GetEnvironment
GetEnvironment200Response

The request has succeeded.
GetEnvironmentDefaultHeaders
GetEnvironmentDefaultResponse
GetEnvironmentDefinition
GetEnvironmentDefinition200Response

The request has succeeded.
GetEnvironmentDefinitionDefaultHeaders
GetEnvironmentDefinitionDefaultResponse
GetPool
GetPool200Response

The request has succeeded.
GetPoolDefaultHeaders
GetPoolDefaultResponse
GetProject
GetProject200Response

The request has succeeded.
GetProjectDefaultHeaders
GetProjectDefaultResponse
GetProjectOperationStatus
GetProjectOperationStatus200Response

The request has succeeded.
GetProjectOperationStatusDefaultHeaders
GetProjectOperationStatusDefaultResponse
GetRemoteConnection
GetRemoteConnection200Response

The request has succeeded.
GetRemoteConnectionDefaultHeaders
GetRemoteConnectionDefaultResponse
GetSchedule
GetSchedule200Response

The request has succeeded.
GetScheduleDefaultHeaders
GetScheduleDefaultResponse
HardwareProfile

Hardware specifications for the Dev Box.
HardwareProfileOutput

Hardware specifications for the Dev Box.
ImageReference

Specifies information about the image used
ImageReferenceOutput

Specifies information about the image used
ListAllDevBoxes
ListAllDevBoxes200Response

The request has succeeded.
ListAllDevBoxesByUser
ListAllDevBoxesByUser200Response

The request has succeeded.
ListAllDevBoxesByUserDefaultHeaders
ListAllDevBoxesByUserDefaultResponse
ListAllDevBoxesByUserQueryParam
ListAllDevBoxesByUserQueryParamProperties
ListAllDevBoxesDefaultHeaders
ListAllDevBoxesDefaultResponse
ListAllDevBoxesQueryParam
ListAllDevBoxesQueryParamProperties
ListAllEnvironments
ListAllEnvironments200Response

The request has succeeded.
ListAllEnvironmentsDefaultHeaders
ListAllEnvironmentsDefaultResponse
ListAllEnvironmentsQueryParam
ListAllEnvironmentsQueryParamProperties
ListCatalogs
ListCatalogs200Response

The request has succeeded.
ListCatalogsDefaultHeaders
ListCatalogsDefaultResponse
ListCatalogsQueryParam
ListCatalogsQueryParamProperties
ListDevBoxActions
ListDevBoxActions200Response

The request has succeeded.
ListDevBoxActionsDefaultHeaders
ListDevBoxActionsDefaultResponse
ListDevBoxes
ListDevBoxes200Response

The request has succeeded.
ListDevBoxesDefaultHeaders
ListDevBoxesDefaultResponse
ListDevBoxesQueryParam
ListDevBoxesQueryParamProperties
ListEnvironmentDefinitions
ListEnvironmentDefinitions200Response

The request has succeeded.
ListEnvironmentDefinitionsByCatalog
ListEnvironmentDefinitionsByCatalog200Response

The request has succeeded.
ListEnvironmentDefinitionsByCatalogDefaultHeaders
ListEnvironmentDefinitionsByCatalogDefaultResponse
ListEnvironmentDefinitionsByCatalogQueryParam
ListEnvironmentDefinitionsByCatalogQueryParamProperties
ListEnvironmentDefinitionsDefaultHeaders
ListEnvironmentDefinitionsDefaultResponse
ListEnvironmentDefinitionsQueryParam
ListEnvironmentDefinitionsQueryParamProperties
ListEnvironmentTypes
ListEnvironmentTypes200Response

The request has succeeded.
ListEnvironmentTypesDefaultHeaders
ListEnvironmentTypesDefaultResponse
ListEnvironmentTypesQueryParam
ListEnvironmentTypesQueryParamProperties
ListEnvironments
ListEnvironments200Response

The request has succeeded.
ListEnvironmentsDefaultHeaders
ListEnvironmentsDefaultResponse
ListEnvironmentsQueryParam
ListEnvironmentsQueryParamProperties
ListPools
ListPools200Response

The request has succeeded.
ListPoolsDefaultHeaders
ListPoolsDefaultResponse
ListPoolsQueryParam
ListPoolsQueryParamProperties
ListProjects
ListProjects200Response

The request has succeeded.
ListProjectsDefaultHeaders
ListProjectsDefaultResponse
ListProjectsQueryParam
ListProjectsQueryParamProperties
ListSchedules
ListSchedules200Response

The request has succeeded.
ListSchedulesDefaultHeaders
ListSchedulesDefaultResponse
ListSchedulesQueryParam
ListSchedulesQueryParamProperties
OSDisk

Settings for the operating system disk.
OSDiskOutput

Settings for the operating system disk.
OperationStatusErrorOutput

Operation Error message
OperationStatusOutput

The current status of an async operation
PagingOptions

Options for the paging helper
PoolOutput

A pool of Dev Boxes.
ProjectOutput

Project details.
RemoteConnectionOutput

Provides remote connection information for a Dev Box.
RestartDevBox
RestartDevBox202Headers
RestartDevBox202Response

The request has been accepted for processing, but processing has not yet completed.
RestartDevBoxDefaultHeaders
RestartDevBoxDefaultResponse
RestartDevBoxLogicalResponse

The final response for long-running RestartDevBox operation
Routes
ScheduleOutput

A Schedule to execute action.
SkipAction
SkipAction204Response

There is no content to send for this request, but the headers may be useful.
SkipActionDefaultHeaders
SkipActionDefaultResponse
StartDevBox
StartDevBox202Headers
StartDevBox202Response

The request has been accepted for processing, but processing has not yet completed.
StartDevBoxDefaultHeaders
StartDevBoxDefaultResponse
StartDevBoxLogicalResponse

The final response for long-running StartDevBox operation
StopDevBox
StopDevBox202Headers
StopDevBox202Response

The request has been accepted for processing, but processing has not yet completed.
StopDevBoxDefaultHeaders
StopDevBoxDefaultResponse
StopDevBoxLogicalResponse

The final response for long-running StopDevBox operation
StopDevBoxQueryParam
StopDevBoxQueryParamProperties
StopOnDisconnectConfigurationOutput

Stop on disconnect configuration settings for Dev Boxes created in this pool.
StorageProfile

Storage settings for the Dev Box's disks
StorageProfileOutput

Storage settings for the Dev Box's disks

Type Aliases

AzureDeveloperDevCenterClient
CreateDevBoxParameters
CreateOrUpdateEnvironmentParameters
DelayActionParameters
DelayAllActionsParameters
DeleteDevBoxParameters
DeleteEnvironmentParameters
GetArrayType

Helper type to extract the type of an array
GetCatalogParameters
GetDevBoxActionParameters
GetDevBoxParameters
GetEnvironmentDefinitionParameters
GetEnvironmentParameters
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.
GetPoolParameters
GetProjectOperationStatusParameters
GetProjectParameters
GetRemoteConnectionParameters
GetScheduleParameters
ListAllDevBoxesByUserParameters
ListAllDevBoxesParameters
ListAllEnvironmentsParameters
ListCatalogsParameters
ListDevBoxActionsParameters
ListDevBoxesParameters
ListEnvironmentDefinitionsByCatalogParameters
ListEnvironmentDefinitionsParameters
ListEnvironmentTypesParameters
ListEnvironmentsParameters
ListPoolsParameters
ListProjectsParameters
ListSchedulesParameters
PagedCatalogOutput

Results of the catalog list operation.
PagedDevBoxActionDelayResultOutput

The actions list result
PagedDevBoxActionOutput

The actions list result
PagedDevBoxOutput

The Dev Box list result
PagedEnvironmentDefinitionOutput

Results of the environment definition list operation.
PagedEnvironmentOutput

Results of the environment list operation.
PagedEnvironmentTypeOutput

Result of the environment type list operation.
PagedPoolOutput

The Pool list result
PagedProjectOutput

Results of the project list operation.
PagedScheduleOutput

The Schedule list result
PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
RestartDevBoxParameters
SkipActionParameters
StartDevBoxParameters
StopDevBoxParameters

Functions

default(string, TokenCredential, ClientOptions)

Initialize a new instance of AzureDeveloperDevCenterClient
getLongRunningPoller<TResult>(Client, CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.
getLongRunningPoller<TResult>(Client, DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, StartDevBoxDefaultResponse | StartDevBox202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, StopDevBoxDefaultResponse | StopDevBox202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, RestartDevBoxDefaultResponse | RestartDevBox202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
isUnexpected(ListProjects200Response | ListProjectsDefaultResponse)
isUnexpected(GetProject200Response | GetProjectDefaultResponse)
isUnexpected(GetProjectOperationStatus200Response | GetProjectOperationStatusDefaultResponse)
isUnexpected(ListPools200Response | ListPoolsDefaultResponse)
isUnexpected(GetPool200Response | GetPoolDefaultResponse)
isUnexpected(ListSchedules200Response | ListSchedulesDefaultResponse)
isUnexpected(GetSchedule200Response | GetScheduleDefaultResponse)
isUnexpected(ListDevBoxes200Response | ListDevBoxesDefaultResponse)
isUnexpected(GetDevBox200Response | GetDevBoxDefaultResponse)
isUnexpected(CreateDevBoxLogicalResponse | CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response)
isUnexpected(DeleteDevBoxLogicalResponse | DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response)
isUnexpected(StartDevBoxLogicalResponse | StartDevBoxDefaultResponse | StartDevBox202Response)
isUnexpected(StopDevBoxLogicalResponse | StopDevBoxDefaultResponse | StopDevBox202Response)
isUnexpected(RestartDevBoxLogicalResponse | RestartDevBoxDefaultResponse | RestartDevBox202Response)
isUnexpected(GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse)
isUnexpected(ListDevBoxActions200Response | ListDevBoxActionsDefaultResponse)
isUnexpected(GetDevBoxAction200Response | GetDevBoxActionDefaultResponse)
isUnexpected(SkipAction204Response | SkipActionDefaultResponse)
isUnexpected(DelayAction200Response | DelayActionDefaultResponse)
isUnexpected(DelayAllActions200Response | DelayAllActionsDefaultResponse)
isUnexpected(ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse)
isUnexpected(ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse)
isUnexpected(ListAllEnvironments200Response | ListAllEnvironmentsDefaultResponse)
isUnexpected(ListEnvironments200Response | ListEnvironmentsDefaultResponse)
isUnexpected(GetEnvironment200Response | GetEnvironmentDefaultResponse)
isUnexpected(CreateOrUpdateEnvironmentLogicalResponse | CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response)
isUnexpected(DeleteEnvironmentLogicalResponse | DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response)
isUnexpected(ListCatalogs200Response | ListCatalogsDefaultResponse)
isUnexpected(GetCatalog200Response | GetCatalogDefaultResponse)
isUnexpected(ListEnvironmentDefinitions200Response | ListEnvironmentDefinitionsDefaultResponse)
isUnexpected(ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse)
isUnexpected(GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse)
isUnexpected(ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, TokenCredential, ClientOptions)

Initialize a new instance of AzureDeveloperDevCenterClient

function default(endpoint: string, credentials: TokenCredential, options?: ClientOptions): AzureDeveloperDevCenterClient

Parameters

endpoint

string

The DevCenter-specific URI to operate on.

credentials
TokenCredential

uniquely identify client credential

options
ClientOptions

the parameter for all optional parameters

Returns

AzureDeveloperDevCenterClient

getLongRunningPoller<TResult>(Client, CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.

function getLongRunningPoller<TResult>(client: Client, initialResponse: CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client

Client to use for sending the request to get additional pages.

initialResponse

CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

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

  • A poller object to poll for operation state updates and eventually get the final response.

getLongRunningPoller<TResult>(Client, DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

function getLongRunningPoller<TResult>(client: Client, initialResponse: DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client
initialResponse

DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

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

getLongRunningPoller<TResult>(Client, StartDevBoxDefaultResponse | StartDevBox202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

function getLongRunningPoller<TResult>(client: Client, initialResponse: StartDevBoxDefaultResponse | StartDevBox202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client
initialResponse

StartDevBoxDefaultResponse | StartDevBox202Response

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

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

getLongRunningPoller<TResult>(Client, StopDevBoxDefaultResponse | StopDevBox202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

function getLongRunningPoller<TResult>(client: Client, initialResponse: StopDevBoxDefaultResponse | StopDevBox202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client
initialResponse

StopDevBoxDefaultResponse | StopDevBox202Response

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

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

getLongRunningPoller<TResult>(Client, RestartDevBoxDefaultResponse | RestartDevBox202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

function getLongRunningPoller<TResult>(client: Client, initialResponse: RestartDevBoxDefaultResponse | RestartDevBox202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client
initialResponse

RestartDevBoxDefaultResponse | RestartDevBox202Response

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

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

getLongRunningPoller<TResult>(Client, CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

function getLongRunningPoller<TResult>(client: Client, initialResponse: CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client
initialResponse

CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

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

getLongRunningPoller<TResult>(Client, DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

function getLongRunningPoller<TResult>(client: Client, initialResponse: DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client
initialResponse

DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

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

isUnexpected(ListProjects200Response | ListProjectsDefaultResponse) 

function isUnexpected(response: ListProjects200Response | ListProjectsDefaultResponse): response

Parameters

response

ListProjects200Response | ListProjectsDefaultResponse

Returns

response

isUnexpected(GetProject200Response | GetProjectDefaultResponse) 

function isUnexpected(response: GetProject200Response | GetProjectDefaultResponse): response

Parameters

response

GetProject200Response | GetProjectDefaultResponse

Returns

response

isUnexpected(GetProjectOperationStatus200Response | GetProjectOperationStatusDefaultResponse) 

function isUnexpected(response: GetProjectOperationStatus200Response | GetProjectOperationStatusDefaultResponse): response

Parameters

response

GetProjectOperationStatus200Response | GetProjectOperationStatusDefaultResponse

Returns

response

isUnexpected(ListPools200Response | ListPoolsDefaultResponse) 

function isUnexpected(response: ListPools200Response | ListPoolsDefaultResponse): response

Parameters

response

ListPools200Response | ListPoolsDefaultResponse

Returns

response

isUnexpected(GetPool200Response | GetPoolDefaultResponse) 

function isUnexpected(response: GetPool200Response | GetPoolDefaultResponse): response

Parameters

response

GetPool200Response | GetPoolDefaultResponse

Returns

response

isUnexpected(ListSchedules200Response | ListSchedulesDefaultResponse) 

function isUnexpected(response: ListSchedules200Response | ListSchedulesDefaultResponse): response

Parameters

response

ListSchedules200Response | ListSchedulesDefaultResponse

Returns

response

isUnexpected(GetSchedule200Response | GetScheduleDefaultResponse) 

function isUnexpected(response: GetSchedule200Response | GetScheduleDefaultResponse): response

Parameters

response

GetSchedule200Response | GetScheduleDefaultResponse

Returns

response

isUnexpected(ListDevBoxes200Response | ListDevBoxesDefaultResponse) 

function isUnexpected(response: ListDevBoxes200Response | ListDevBoxesDefaultResponse): response

Parameters

response

ListDevBoxes200Response | ListDevBoxesDefaultResponse

Returns

response

isUnexpected(GetDevBox200Response | GetDevBoxDefaultResponse) 

function isUnexpected(response: GetDevBox200Response | GetDevBoxDefaultResponse): response

Parameters

response

GetDevBox200Response | GetDevBoxDefaultResponse

Returns

response

isUnexpected(CreateDevBoxLogicalResponse | CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response) 

function isUnexpected(response: CreateDevBoxLogicalResponse | CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response): response

Parameters

response

CreateDevBoxLogicalResponse | CreateDevBoxDefaultResponse | CreateDevBox200Response | CreateDevBox201Response

Returns

response

isUnexpected(DeleteDevBoxLogicalResponse | DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response) 

function isUnexpected(response: DeleteDevBoxLogicalResponse | DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response): response

Parameters

response

DeleteDevBoxLogicalResponse | DeleteDevBoxDefaultResponse | DeleteDevBox202Response | DeleteDevBox204Response

Returns

response

isUnexpected(StartDevBoxLogicalResponse | StartDevBoxDefaultResponse | StartDevBox202Response) 

function isUnexpected(response: StartDevBoxLogicalResponse | StartDevBoxDefaultResponse | StartDevBox202Response): response

Parameters

response

StartDevBoxLogicalResponse | StartDevBoxDefaultResponse | StartDevBox202Response

Returns

response

isUnexpected(StopDevBoxLogicalResponse | StopDevBoxDefaultResponse | StopDevBox202Response) 

function isUnexpected(response: StopDevBoxLogicalResponse | StopDevBoxDefaultResponse | StopDevBox202Response): response

Parameters

response

StopDevBoxLogicalResponse | StopDevBoxDefaultResponse | StopDevBox202Response

Returns

response

isUnexpected(RestartDevBoxLogicalResponse | RestartDevBoxDefaultResponse | RestartDevBox202Response) 

function isUnexpected(response: RestartDevBoxLogicalResponse | RestartDevBoxDefaultResponse | RestartDevBox202Response): response

Parameters

response

RestartDevBoxLogicalResponse | RestartDevBoxDefaultResponse | RestartDevBox202Response

Returns

response

isUnexpected(GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse) 

function isUnexpected(response: GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse): response

Parameters

response

GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse

Returns

response

isUnexpected(ListDevBoxActions200Response | ListDevBoxActionsDefaultResponse) 

function isUnexpected(response: ListDevBoxActions200Response | ListDevBoxActionsDefaultResponse): response

Parameters

response

ListDevBoxActions200Response | ListDevBoxActionsDefaultResponse

Returns

response

isUnexpected(GetDevBoxAction200Response | GetDevBoxActionDefaultResponse) 

function isUnexpected(response: GetDevBoxAction200Response | GetDevBoxActionDefaultResponse): response

Parameters

response

GetDevBoxAction200Response | GetDevBoxActionDefaultResponse

Returns

response

isUnexpected(SkipAction204Response | SkipActionDefaultResponse) 

function isUnexpected(response: SkipAction204Response | SkipActionDefaultResponse): response

Parameters

response

SkipAction204Response | SkipActionDefaultResponse

Returns

response

isUnexpected(DelayAction200Response | DelayActionDefaultResponse) 

function isUnexpected(response: DelayAction200Response | DelayActionDefaultResponse): response

Parameters

response

DelayAction200Response | DelayActionDefaultResponse

Returns

response

isUnexpected(DelayAllActions200Response | DelayAllActionsDefaultResponse) 

function isUnexpected(response: DelayAllActions200Response | DelayAllActionsDefaultResponse): response

Parameters

response

DelayAllActions200Response | DelayAllActionsDefaultResponse

Returns

response

isUnexpected(ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse) 

function isUnexpected(response: ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse): response

Parameters

response

ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse

Returns

response

isUnexpected(ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse) 

function isUnexpected(response: ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse): response

Parameters

response

ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse

Returns

response

isUnexpected(ListAllEnvironments200Response | ListAllEnvironmentsDefaultResponse) 

function isUnexpected(response: ListAllEnvironments200Response | ListAllEnvironmentsDefaultResponse): response

Parameters

response

ListAllEnvironments200Response | ListAllEnvironmentsDefaultResponse

Returns

response

isUnexpected(ListEnvironments200Response | ListEnvironmentsDefaultResponse) 

function isUnexpected(response: ListEnvironments200Response | ListEnvironmentsDefaultResponse): response

Parameters

response

ListEnvironments200Response | ListEnvironmentsDefaultResponse

Returns

response

isUnexpected(GetEnvironment200Response | GetEnvironmentDefaultResponse) 

function isUnexpected(response: GetEnvironment200Response | GetEnvironmentDefaultResponse): response

Parameters

response

GetEnvironment200Response | GetEnvironmentDefaultResponse

Returns

response

isUnexpected(CreateOrUpdateEnvironmentLogicalResponse | CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response) 

function isUnexpected(response: CreateOrUpdateEnvironmentLogicalResponse | CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response): response

Parameters

response

CreateOrUpdateEnvironmentLogicalResponse | CreateOrUpdateEnvironmentDefaultResponse | CreateOrUpdateEnvironment201Response

Returns

response

isUnexpected(DeleteEnvironmentLogicalResponse | DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response) 

function isUnexpected(response: DeleteEnvironmentLogicalResponse | DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response): response

Parameters

response

DeleteEnvironmentLogicalResponse | DeleteEnvironmentDefaultResponse | DeleteEnvironment202Response | DeleteEnvironment204Response

Returns

response

isUnexpected(ListCatalogs200Response | ListCatalogsDefaultResponse) 

function isUnexpected(response: ListCatalogs200Response | ListCatalogsDefaultResponse): response

Parameters

response

ListCatalogs200Response | ListCatalogsDefaultResponse

Returns

response

isUnexpected(GetCatalog200Response | GetCatalogDefaultResponse) 

function isUnexpected(response: GetCatalog200Response | GetCatalogDefaultResponse): response

Parameters

response

GetCatalog200Response | GetCatalogDefaultResponse

Returns

response

isUnexpected(ListEnvironmentDefinitions200Response | ListEnvironmentDefinitionsDefaultResponse) 

function isUnexpected(response: ListEnvironmentDefinitions200Response | ListEnvironmentDefinitionsDefaultResponse): response

Parameters

response

ListEnvironmentDefinitions200Response | ListEnvironmentDefinitionsDefaultResponse

Returns

response

isUnexpected(ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse) 

function isUnexpected(response: ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse): response

Parameters

response

ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse

Returns

response

isUnexpected(GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse) 

function isUnexpected(response: GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse): response

Parameters

response

GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse

Returns

response

isUnexpected(ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse) 

function isUnexpected(response: ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse): response

Parameters

response

ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client
Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator to iterate the elements