@azure-rest/developer-devcenter package

Interfaces

AzureDeveloperDevCenterClientOptions	The optional parameters for the client
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
CreateOrReplaceEnvironment201Headers
CreateOrReplaceEnvironment201Response	The request has succeeded and a new resource has been created as a result.
CreateOrReplaceEnvironmentBodyParam
CreateOrReplaceEnvironmentDefaultHeaders
CreateOrReplaceEnvironmentDefaultResponse
CreateOrReplaceEnvironmentLogicalResponse	The final response for long-running createOrReplaceEnvironment operation
DelayAction
DelayAction200Response	The request has succeeded.
DelayActionDefaultHeaders
DelayActionDefaultResponse
DelayActionQueryParam
DelayActionQueryParamProperties
DelayActions
DelayActions200Response	The request has succeeded.
DelayActionsDefaultHeaders
DelayActionsDefaultResponse
DelayActionsQueryParam
DelayActionsQueryParamProperties
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.
Get
Get200Response	The request has succeeded.
GetAction
GetAction200Response	The request has succeeded.
GetActionDefaultHeaders
GetActionDefaultResponse
GetCatalog
GetCatalog200Response	The request has succeeded.
GetCatalogDefaultHeaders
GetCatalogDefaultResponse
GetDefaultHeaders
GetDefaultResponse
GetDevBoxByUser
GetDevBoxByUser200Response	The request has succeeded.
GetDevBoxByUserDefaultHeaders
GetDevBoxByUserDefaultResponse
GetEnvironmentByUser
GetEnvironmentByUser200Response	The request has succeeded.
GetEnvironmentByUserDefaultHeaders
GetEnvironmentByUserDefaultResponse
GetEnvironmentDefinition
GetEnvironmentDefinition200Response	The request has succeeded.
GetEnvironmentDefinitionDefaultHeaders
GetEnvironmentDefinitionDefaultResponse
GetPool
GetPool200Response	The request has succeeded.
GetPoolDefaultHeaders
GetPoolDefaultResponse
GetProject
GetProject200Response	The request has succeeded.
GetProjectDefaultHeaders
GetProjectDefaultResponse
GetRemoteConnection
GetRemoteConnection200Response	The request has succeeded.
GetRemoteConnectionDefaultHeaders
GetRemoteConnectionDefaultResponse
GetScheduleByPool
GetScheduleByPool200Response	The request has succeeded.
GetScheduleByPoolDefaultHeaders
GetScheduleByPoolDefaultResponse
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.
ListActions
ListActions200Response	The request has succeeded.
ListActionsDefaultHeaders
ListActionsDefaultResponse
ListAllDevBoxes
ListAllDevBoxes200Response	The request has succeeded.
ListAllDevBoxesByUser
ListAllDevBoxesByUser200Response	The request has succeeded.
ListAllDevBoxesByUserDefaultHeaders
ListAllDevBoxesByUserDefaultResponse
ListAllDevBoxesDefaultHeaders
ListAllDevBoxesDefaultResponse
ListCatalogsByProject
ListCatalogsByProject200Response	The request has succeeded.
ListCatalogsByProjectDefaultHeaders
ListCatalogsByProjectDefaultResponse
ListDevBoxesByUser
ListDevBoxesByUser200Response	The request has succeeded.
ListDevBoxesByUserDefaultHeaders
ListDevBoxesByUserDefaultResponse
ListEnvironmentDefinitionsByCatalog
ListEnvironmentDefinitionsByCatalog200Response	The request has succeeded.
ListEnvironmentDefinitionsByCatalogDefaultHeaders
ListEnvironmentDefinitionsByCatalogDefaultResponse
ListEnvironmentDefinitionsByProject
ListEnvironmentDefinitionsByProject200Response	The request has succeeded.
ListEnvironmentDefinitionsByProjectDefaultHeaders
ListEnvironmentDefinitionsByProjectDefaultResponse
ListEnvironmentTypes
ListEnvironmentTypes200Response	The request has succeeded.
ListEnvironmentTypesDefaultHeaders
ListEnvironmentTypesDefaultResponse
ListEnvironments
ListEnvironments200Response	The request has succeeded.
ListEnvironmentsByUser
ListEnvironmentsByUser200Response	The request has succeeded.
ListEnvironmentsByUserDefaultHeaders
ListEnvironmentsByUserDefaultResponse
ListEnvironmentsDefaultHeaders
ListEnvironmentsDefaultResponse
ListPools
ListPools200Response	The request has succeeded.
ListPoolsDefaultHeaders
ListPoolsDefaultResponse
ListProjects
ListProjects200Response	The request has succeeded.
ListProjectsDefaultHeaders
ListProjectsDefaultResponse
ListSchedulesByPool
ListSchedulesByPool200Response	The request has succeeded.
ListSchedulesByPoolDefaultHeaders
ListSchedulesByPoolDefaultResponse
OperationStatusOutput	The current status of an async operation.
OsDisk	Settings for the operating system disk.
OsDiskOutput	Settings for the operating system disk.
PageSettings	An interface that tracks the settings for paged iteration
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PagedCatalogOutput	Paged collection of Catalog items
PagedDevBoxActionDelayResultOutput	Paged collection of DevBoxActionDelayResult items
PagedDevBoxActionOutput	Paged collection of DevBoxAction items
PagedDevBoxOutput	Paged collection of DevBox items
PagedEnvironmentDefinitionOutput	Paged collection of EnvironmentDefinition items
PagedEnvironmentOutput	Paged collection of Environment items
PagedEnvironmentTypeOutput	Paged collection of EnvironmentType items
PagedPoolOutput	Paged collection of Pool items
PagedProjectOutput	Paged collection of Project items
PagedScheduleOutput	Paged collection of Schedule items
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.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
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
CreateOrReplaceEnvironmentParameters
DelayActionParameters
DelayActionsParameters
DeleteDevBoxParameters
DeleteEnvironmentParameters
DevBoxActionDelayResultStatusOutput	Alias for DevBoxActionDelayResultStatusOutput
DevBoxActionTypeOutput	Alias for DevBoxActionTypeOutput
DevBoxProvisioningState	Alias for DevBoxProvisioningState
DevBoxProvisioningStateOutput	Alias for DevBoxProvisioningStateOutput
EnvironmentProvisioningState	Alias for EnvironmentProvisioningState
EnvironmentProvisioningStateOutput	Alias for EnvironmentProvisioningStateOutput
EnvironmentTypeEnableStatusOutput	Alias for EnvironmentTypeEnableStatusOutput
GetActionParameters
GetArrayType	Helper type to extract the type of an array
GetCatalogParameters
GetDevBoxByUserParameters
GetEnvironmentByUserParameters
GetEnvironmentDefinitionParameters
GetPage	The type of a custom function that defines how to get a page and a link to the next one if any.
GetParameters
GetPoolParameters
GetProjectParameters
GetRemoteConnectionParameters
GetScheduleByPoolParameters
HibernateSupport	Alias for HibernateSupport
HibernateSupportOutput	Alias for HibernateSupportOutput
ListActionsParameters
ListAllDevBoxesByUserParameters
ListAllDevBoxesParameters
ListCatalogsByProjectParameters
ListDevBoxesByUserParameters
ListEnvironmentDefinitionsByCatalogParameters
ListEnvironmentDefinitionsByProjectParameters
ListEnvironmentTypesParameters
ListEnvironmentsByUserParameters
ListEnvironmentsParameters
ListPoolsParameters
ListProjectsParameters
ListSchedulesByPoolParameters
LocalAdminStatus	Alias for LocalAdminStatus
LocalAdminStatusOutput	Alias for LocalAdminStatusOutput
OperationStateOutput	Alias for OperationStateOutput
OsType	Alias for OsType
OsTypeOutput	Alias for OsTypeOutput
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
ParameterTypeOutput	Alias for ParameterTypeOutput
PoolHealthStatusOutput	Alias for PoolHealthStatusOutput
PowerState	Alias for PowerState
PowerStateOutput	Alias for PowerStateOutput
RestartDevBoxParameters
ScheduledFrequencyOutput	Alias for ScheduledFrequencyOutput
ScheduledTypeOutput	Alias for ScheduledTypeOutput
SkipActionParameters
SkuName	Alias for SkuName
SkuNameOutput	Alias for SkuNameOutput
StartDevBoxParameters
StopDevBoxParameters
StopOnDisconnectEnableStatusOutput	Alias for StopOnDisconnectEnableStatusOutput

Functions

default(string, TokenCredential, AzureDeveloperDevCenterClientOptions)	Initialize a new instance of AzureDeveloperDevCenterClient
getLongRunningPoller<TResult>(Client, CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Helper function that builds a Poller object to help polling a long running operation.
getLongRunningPoller<TResult>(Client, DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, StartDevBox202Response | StartDevBoxDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, StopDevBox202Response | StopDevBoxDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, RestartDevBox202Response | RestartDevBoxDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
isUnexpected(ListProjects200Response | ListProjectsDefaultResponse)
isUnexpected(GetProject200Response | GetProjectDefaultResponse)
isUnexpected(Get200Response | GetDefaultResponse)
isUnexpected(ListPools200Response | ListPoolsDefaultResponse)
isUnexpected(GetPool200Response | GetPoolDefaultResponse)
isUnexpected(ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse)
isUnexpected(ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse)
isUnexpected(ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse)
isUnexpected(GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse)
isUnexpected(ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse)
isUnexpected(GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse)
isUnexpected(CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse | CreateDevBoxLogicalResponse)
isUnexpected(DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse | DeleteDevBoxLogicalResponse)
isUnexpected(StartDevBox202Response | StartDevBoxDefaultResponse | StartDevBoxLogicalResponse)
isUnexpected(StopDevBox202Response | StopDevBoxDefaultResponse | StopDevBoxLogicalResponse)
isUnexpected(RestartDevBox202Response | RestartDevBoxDefaultResponse | RestartDevBoxLogicalResponse)
isUnexpected(GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse)
isUnexpected(ListActions200Response | ListActionsDefaultResponse)
isUnexpected(GetAction200Response | GetActionDefaultResponse)
isUnexpected(SkipAction204Response | SkipActionDefaultResponse)
isUnexpected(DelayAction200Response | DelayActionDefaultResponse)
isUnexpected(DelayActions200Response | DelayActionsDefaultResponse)
isUnexpected(ListEnvironments200Response | ListEnvironmentsDefaultResponse)
isUnexpected(ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse)
isUnexpected(GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse)
isUnexpected(CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse)
isUnexpected(DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse | DeleteEnvironmentLogicalResponse)
isUnexpected(ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse)
isUnexpected(GetCatalog200Response | GetCatalogDefaultResponse)
isUnexpected(ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse)
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, AzureDeveloperDevCenterClientOptions)

Initialize a new instance of AzureDeveloperDevCenterClient

function default(endpointParam: string, credentials: TokenCredential, options?: AzureDeveloperDevCenterClientOptions): AzureDeveloperDevCenterClient

Parameters

endpointParam

string

The DevCenter-specific URI to operate on.

credentials

TokenCredential

uniquely identify client credential

options

AzureDeveloperDevCenterClientOptions

the parameter for all optional parameters

Returns

AzureDeveloperDevCenterClient

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

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

function getLongRunningPoller<TResult>(client: Client, initialResponse: CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse, 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

CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

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

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

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

Parameters

client

Client

initialResponse

DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

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

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

Parameters

client

Client

initialResponse

StartDevBox202Response | StartDevBoxDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

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

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

Parameters

client

Client

initialResponse

StopDevBox202Response | StopDevBoxDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

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

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

Parameters

client

Client

initialResponse

RestartDevBox202Response | RestartDevBoxDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

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

Parameters

client

Client

initialResponse

CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

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

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

Parameters

client

Client

initialResponse

DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

isUnexpected(ListProjects200Response | ListProjectsDefaultResponse)

function isUnexpected(response: ListProjects200Response | ListProjectsDefaultResponse): response is ListProjectsDefaultResponse

Parameters

response

ListProjects200Response | ListProjectsDefaultResponse

Returns

response is ListProjectsDefaultResponse

isUnexpected(GetProject200Response | GetProjectDefaultResponse)

function isUnexpected(response: GetProject200Response | GetProjectDefaultResponse): response is GetProjectDefaultResponse

Parameters

response

GetProject200Response | GetProjectDefaultResponse

Returns

response is GetProjectDefaultResponse

isUnexpected(Get200Response | GetDefaultResponse)

function isUnexpected(response: Get200Response | GetDefaultResponse): response is GetDefaultResponse

Parameters

response

Get200Response | GetDefaultResponse

Returns

response is GetDefaultResponse

isUnexpected(ListPools200Response | ListPoolsDefaultResponse)

function isUnexpected(response: ListPools200Response | ListPoolsDefaultResponse): response is ListPoolsDefaultResponse

Parameters

response

ListPools200Response | ListPoolsDefaultResponse

Returns

response is ListPoolsDefaultResponse

isUnexpected(GetPool200Response | GetPoolDefaultResponse)

function isUnexpected(response: GetPool200Response | GetPoolDefaultResponse): response is GetPoolDefaultResponse

Parameters

response

GetPool200Response | GetPoolDefaultResponse

Returns

response is GetPoolDefaultResponse

isUnexpected(ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse)

function isUnexpected(response: ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse): response is ListAllDevBoxesDefaultResponse

Parameters

response

ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse

Returns

response is ListAllDevBoxesDefaultResponse

isUnexpected(ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse)

function isUnexpected(response: ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse): response is ListAllDevBoxesByUserDefaultResponse

Parameters

response

ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse

Returns

response is ListAllDevBoxesByUserDefaultResponse

isUnexpected(ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse)

function isUnexpected(response: ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse): response is ListSchedulesByPoolDefaultResponse

Parameters

response

ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse

Returns

response is ListSchedulesByPoolDefaultResponse

isUnexpected(GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse)

function isUnexpected(response: GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse): response is GetScheduleByPoolDefaultResponse

Parameters

response

GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse

Returns

response is GetScheduleByPoolDefaultResponse

isUnexpected(ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse)

function isUnexpected(response: ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse): response is ListDevBoxesByUserDefaultResponse

Parameters

response

ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse

Returns

response is ListDevBoxesByUserDefaultResponse

isUnexpected(GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse)

function isUnexpected(response: GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse): response is GetDevBoxByUserDefaultResponse

Parameters

response

GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse

Returns

response is GetDevBoxByUserDefaultResponse

isUnexpected(CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse | CreateDevBoxLogicalResponse)

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

Parameters

response

CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse | CreateDevBoxLogicalResponse

Returns

response is CreateDevBoxDefaultResponse

isUnexpected(DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse | DeleteDevBoxLogicalResponse)

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

Parameters

response

DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse | DeleteDevBoxLogicalResponse

Returns

response is DeleteDevBoxDefaultResponse

isUnexpected(StartDevBox202Response | StartDevBoxDefaultResponse | StartDevBoxLogicalResponse)

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

Parameters

response

StartDevBox202Response | StartDevBoxDefaultResponse | StartDevBoxLogicalResponse

Returns

response is StartDevBoxDefaultResponse

isUnexpected(StopDevBox202Response | StopDevBoxDefaultResponse | StopDevBoxLogicalResponse)

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

Parameters

response

StopDevBox202Response | StopDevBoxDefaultResponse | StopDevBoxLogicalResponse

Returns

response is StopDevBoxDefaultResponse

isUnexpected(RestartDevBox202Response | RestartDevBoxDefaultResponse | RestartDevBoxLogicalResponse)

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

Parameters

response

RestartDevBox202Response | RestartDevBoxDefaultResponse | RestartDevBoxLogicalResponse

Returns

response is RestartDevBoxDefaultResponse

isUnexpected(GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse)

function isUnexpected(response: GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse): response is GetRemoteConnectionDefaultResponse

Parameters

response

GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse

Returns

response is GetRemoteConnectionDefaultResponse

isUnexpected(ListActions200Response | ListActionsDefaultResponse)

function isUnexpected(response: ListActions200Response | ListActionsDefaultResponse): response is ListActionsDefaultResponse

Parameters

response

ListActions200Response | ListActionsDefaultResponse

Returns

response is ListActionsDefaultResponse

isUnexpected(GetAction200Response | GetActionDefaultResponse)

function isUnexpected(response: GetAction200Response | GetActionDefaultResponse): response is GetActionDefaultResponse

Parameters

response

GetAction200Response | GetActionDefaultResponse

Returns

response is GetActionDefaultResponse

isUnexpected(SkipAction204Response | SkipActionDefaultResponse)

function isUnexpected(response: SkipAction204Response | SkipActionDefaultResponse): response is SkipActionDefaultResponse

Parameters

response

SkipAction204Response | SkipActionDefaultResponse

Returns

response is SkipActionDefaultResponse

isUnexpected(DelayAction200Response | DelayActionDefaultResponse)

function isUnexpected(response: DelayAction200Response | DelayActionDefaultResponse): response is DelayActionDefaultResponse

Parameters

response

DelayAction200Response | DelayActionDefaultResponse

Returns

response is DelayActionDefaultResponse

isUnexpected(DelayActions200Response | DelayActionsDefaultResponse)

function isUnexpected(response: DelayActions200Response | DelayActionsDefaultResponse): response is DelayActionsDefaultResponse

Parameters

response

DelayActions200Response | DelayActionsDefaultResponse

Returns

response is DelayActionsDefaultResponse

isUnexpected(ListEnvironments200Response | ListEnvironmentsDefaultResponse)

function isUnexpected(response: ListEnvironments200Response | ListEnvironmentsDefaultResponse): response is ListEnvironmentsDefaultResponse

Parameters

response

ListEnvironments200Response | ListEnvironmentsDefaultResponse

Returns

response is ListEnvironmentsDefaultResponse

isUnexpected(ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse)

function isUnexpected(response: ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse): response is ListEnvironmentsByUserDefaultResponse

Parameters

response

ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse

Returns

response is ListEnvironmentsByUserDefaultResponse

isUnexpected(GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse)

function isUnexpected(response: GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse): response is GetEnvironmentByUserDefaultResponse

Parameters

response

GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse

Returns

response is GetEnvironmentByUserDefaultResponse

isUnexpected(CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse)

function isUnexpected(response: CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse): response is CreateOrReplaceEnvironmentDefaultResponse

Parameters

response

CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse

Returns

response is CreateOrReplaceEnvironmentDefaultResponse

isUnexpected(DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse | DeleteEnvironmentLogicalResponse)

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

Parameters

response

DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse | DeleteEnvironmentLogicalResponse

Returns

response is DeleteEnvironmentDefaultResponse

isUnexpected(ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse)

function isUnexpected(response: ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse): response is ListCatalogsByProjectDefaultResponse

Parameters

response

ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse

Returns

response is ListCatalogsByProjectDefaultResponse

isUnexpected(GetCatalog200Response | GetCatalogDefaultResponse)

function isUnexpected(response: GetCatalog200Response | GetCatalogDefaultResponse): response is GetCatalogDefaultResponse

Parameters

response

GetCatalog200Response | GetCatalogDefaultResponse

Returns

response is GetCatalogDefaultResponse

isUnexpected(ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse)

function isUnexpected(response: ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse): response is ListEnvironmentDefinitionsByProjectDefaultResponse

Parameters

response

ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse

Returns

response is ListEnvironmentDefinitionsByProjectDefaultResponse

isUnexpected(ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse)

function isUnexpected(response: ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse): response is ListEnvironmentDefinitionsByCatalogDefaultResponse

Parameters

response

ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse

Returns

response is ListEnvironmentDefinitionsByCatalogDefaultResponse

isUnexpected(GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse)

function isUnexpected(response: GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse): response is GetEnvironmentDefinitionDefaultResponse

Parameters

response

GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse

Returns

response is GetEnvironmentDefinitionDefaultResponse

isUnexpected(ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse)

function isUnexpected(response: ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse): response is ListEnvironmentTypesDefaultResponse

Parameters

response

ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse

Returns

response is 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 paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>, PaginateReturn<TResponse>[], PageSettings>

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>, PaginateReturn<TResponse>[], PageSettings>

• PagedAsyncIterableIterator to iterate the elements