@azure-rest/developer-devcenter package
Interfaces
Type Aliases
Functions
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
the parameter for all optional parameters
Returns
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
- 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
- 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
- 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
- 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
Parameters
Returns
response
isUnexpected(GetProject200Response | GetProjectDefaultResponse)
function isUnexpected(response: GetProject200Response | GetProjectDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(Get200Response | GetDefaultResponse)
function isUnexpected(response: Get200Response | GetDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(ListPools200Response | ListPoolsDefaultResponse)
function isUnexpected(response: ListPools200Response | ListPoolsDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(GetPool200Response | GetPoolDefaultResponse)
function isUnexpected(response: GetPool200Response | GetPoolDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse)
function isUnexpected(response: ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse)
function isUnexpected(response: ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse)
function isUnexpected(response: ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse)
function isUnexpected(response: GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse)
function isUnexpected(response: ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse)
function isUnexpected(response: GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse): response
Parameters
Returns
response
isUnexpected(CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse | CreateDevBoxLogicalResponse)
function isUnexpected(response: CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse | CreateDevBoxLogicalResponse): response
Parameters
Returns
response
isUnexpected(DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse | DeleteDevBoxLogicalResponse)
function isUnexpected(response: DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse | DeleteDevBoxLogicalResponse): response
Parameters
Returns
response
isUnexpected(StartDevBox202Response | StartDevBoxDefaultResponse | StartDevBoxLogicalResponse)
function isUnexpected(response: StartDevBox202Response | StartDevBoxDefaultResponse | StartDevBoxLogicalResponse): response
Parameters
Returns
response
isUnexpected(StopDevBox202Response | StopDevBoxDefaultResponse | StopDevBoxLogicalResponse)
function isUnexpected(response: StopDevBox202Response | StopDevBoxDefaultResponse | StopDevBoxLogicalResponse): response
Parameters
Returns
response
isUnexpected(RestartDevBox202Response | RestartDevBoxDefaultResponse | RestartDevBoxLogicalResponse)
function isUnexpected(response: RestartDevBox202Response | RestartDevBoxDefaultResponse | RestartDevBoxLogicalResponse): response
Parameters
Returns
response
isUnexpected(GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse)
function isUnexpected(response: GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListActions200Response | ListActionsDefaultResponse)
function isUnexpected(response: ListActions200Response | ListActionsDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(GetAction200Response | GetActionDefaultResponse)
function isUnexpected(response: GetAction200Response | GetActionDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(SkipAction204Response | SkipActionDefaultResponse)
function isUnexpected(response: SkipAction204Response | SkipActionDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(DelayAction200Response | DelayActionDefaultResponse)
function isUnexpected(response: DelayAction200Response | DelayActionDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(DelayActions200Response | DelayActionsDefaultResponse)
function isUnexpected(response: DelayActions200Response | DelayActionsDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListEnvironments200Response | ListEnvironmentsDefaultResponse)
function isUnexpected(response: ListEnvironments200Response | ListEnvironmentsDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse)
function isUnexpected(response: ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse)
function isUnexpected(response: GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse): response
Parameters
Returns
response
isUnexpected(CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse)
function isUnexpected(response: CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse): response
Parameters
Returns
response
isUnexpected(DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse | DeleteEnvironmentLogicalResponse)
function isUnexpected(response: DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse | DeleteEnvironmentLogicalResponse): response
Parameters
Returns
response
isUnexpected(ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse)
function isUnexpected(response: ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetCatalog200Response | GetCatalogDefaultResponse)
function isUnexpected(response: GetCatalog200Response | GetCatalogDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse)
function isUnexpected(response: ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse)
function isUnexpected(response: ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse)
function isUnexpected(response: GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse): response
Parameters
Returns
response
isUnexpected(ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse)
function isUnexpected(response: ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse): response
Parameters
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