@azure-rest/developer-devcenter package
Interfaces
Aliases de Tipo
AzureDeveloperDevCenterClient | |
CreateDevBoxParameters | |
CreateOrReplaceEnvironmentParameters | |
DelayActionParameters | |
DelayActionsParameters | |
DeleteDevBoxParameters | |
DeleteEnvironmentParameters | |
DevBoxActionDelayResultStatusOutput |
Alias para DevBoxActionDelayResultStatusOutput |
DevBoxActionTypeOutput |
Alias para DevBoxActionTypeOutput |
DevBoxProvisioningState |
Alias para DevBoxProvisioningState |
DevBoxProvisioningStateOutput |
Alias para DevBoxProvisioningStateOutput |
EnvironmentProvisioningState |
Alias para EnvironmentProvisioningState |
EnvironmentProvisioningStateOutput |
Alias para EnvironmentProvisioningStateOutput |
EnvironmentTypeEnableStatusOutput |
Alias para EnvironmentTypeEnableStatusOutput |
GetActionParameters | |
GetArrayType |
Tipo auxiliar para extrair o tipo de uma matriz |
GetCatalogParameters | |
GetDevBoxByUserParameters | |
GetEnvironmentByUserParameters | |
GetEnvironmentDefinitionParameters | |
GetPage |
O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver. |
GetParameters | |
GetPoolParameters | |
GetProjectParameters | |
GetRemoteConnectionParameters | |
GetScheduleByPoolParameters | |
HibernateSupport |
Alias para HibernateSupport |
HibernateSupportOutput |
Alias para HibernateSupportOutput |
ListActionsParameters | |
ListAllDevBoxesByUserParameters | |
ListAllDevBoxesParameters | |
ListCatalogsByProjectParameters | |
ListDevBoxesByUserParameters | |
ListEnvironmentDefinitionsByCatalogParameters | |
ListEnvironmentDefinitionsByProjectParameters | |
ListEnvironmentTypesParameters | |
ListEnvironmentsByUserParameters | |
ListEnvironmentsParameters | |
ListPoolsParameters | |
ListProjectsParameters | |
ListSchedulesByPoolParameters | |
LocalAdminStatus |
Alias para LocalAdminStatus |
LocalAdminStatusOutput |
Alias para LocalAdminStatusOutput |
OperationStateOutput |
Enum descrevendo estados de operação permitidos. |
OsType |
Alias para OsType |
OsTypeOutput |
Alias para OsTypeOutput |
PagedCatalogOutput |
Coleção paginada de itens do catálogo |
PagedDevBoxActionDelayResultOutput |
Coleção paginada de itens DevBoxActionDelayResult |
PagedDevBoxActionOutput |
Coleção paginada de itens DevBoxAction |
PagedDevBoxOutput |
Coleção paginada de itens DevBox |
PagedEnvironmentDefinitionOutput |
Coleção paginada de itens EnvironmentDefinition |
PagedEnvironmentOutput |
Coleção paginada de itens Ambiente |
PagedEnvironmentTypeOutput |
Coleção paginada de itens EnvironmentType |
PagedPoolOutput |
Coleção paginada de itens de Pool |
PagedProjectOutput |
Coleção paginada de itens do Project |
PagedScheduleOutput |
Coleção paginada de itens Schedule |
PaginateReturn |
Tipo auxiliar para inferir o Tipo dos elementos paginados do tipo de resposta Esse tipo é gerado com base nas informações do swagger para x-ms-pageable, especificamente na propriedade itemName, que indica a propriedade da resposta onde os itens de página são encontrados. O valor padrão é |
ParameterTypeOutput |
Alias para ParameterTypeOutput |
PoolHealthStatusOutput |
Alias para PoolHealthStatusOutput |
PowerState |
Alias para PowerState |
PowerStateOutput |
Alias para PowerStateOutput |
RestartDevBoxParameters | |
ScheduledFrequencyOutput |
Alias para ScheduledFrequencyOutput |
ScheduledTypeOutput |
Alias para ScheduledTypeOutput |
SkipActionParameters | |
SkuName |
Alias para SkuName |
SkuNameOutput |
Alias para SkuNameOutput |
StartDevBoxParameters | |
StopDevBoxParameters | |
StopOnDisconnectEnableStatusOutput |
Alias para StopOnDisconnectEnableStatusOutput |
Funções
Detalhes de Função
default(string, TokenCredential, ClientOptions)
Inicializar uma nova instância do AzureDeveloperDevCenterClient
function default(endpointParam: string, credentials: TokenCredential, options?: ClientOptions): AzureDeveloperDevCenterClient
Parâmetros
- endpointParam
-
string
O URI específico do DevCenter para operar.
- credentials
- TokenCredential
identificar exclusivamente a credencial do cliente
- options
- ClientOptions
o parâmetro para todos os parâmetros opcionais
Devoluções
getLongRunningPoller<TResult>(Client, CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de longa duração.
function getLongRunningPoller<TResult>(client: Client, initialResponse: CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parâmetros
- client
- Client
Cliente a utilizar para enviar o pedido para obter páginas adicionais.
- initialResponse
-
CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse
A resposta inicial.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opções para definir um estado de retomada ou intervalo de sondagem personalizado.
Devoluções
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Um poller se opõe a pesquisar atualizações de estado da operação e, eventualmente, obter a resposta final.
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>>
Parâmetros
- client
- Client
- initialResponse
-
DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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>>
Parâmetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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>>
Parâmetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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>>
Parâmetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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>>
Parâmetros
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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>>
Parâmetros
- client
- Client
- initialResponse
-
DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListProjects200Response | ListProjectsDefaultResponse)
function isUnexpected(response: ListProjects200Response | ListProjectsDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetProject200Response | GetProjectDefaultResponse)
function isUnexpected(response: GetProject200Response | GetProjectDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(Get200Response | GetDefaultResponse)
function isUnexpected(response: Get200Response | GetDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(ListPools200Response | ListPoolsDefaultResponse)
function isUnexpected(response: ListPools200Response | ListPoolsDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(GetPool200Response | GetPoolDefaultResponse)
function isUnexpected(response: GetPool200Response | GetPoolDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse)
function isUnexpected(response: ListAllDevBoxes200Response | ListAllDevBoxesDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse)
function isUnexpected(response: ListAllDevBoxesByUser200Response | ListAllDevBoxesByUserDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse)
function isUnexpected(response: ListSchedulesByPool200Response | ListSchedulesByPoolDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse)
function isUnexpected(response: GetScheduleByPool200Response | GetScheduleByPoolDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse)
function isUnexpected(response: ListDevBoxesByUser200Response | ListDevBoxesByUserDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse)
function isUnexpected(response: GetDevBoxByUser200Response | GetDevBoxByUserDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse | CreateDevBoxLogicalResponse)
function isUnexpected(response: CreateDevBox200Response | CreateDevBox201Response | CreateDevBoxDefaultResponse | CreateDevBoxLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse | DeleteDevBoxLogicalResponse)
function isUnexpected(response: DeleteDevBox202Response | DeleteDevBox204Response | DeleteDevBoxDefaultResponse | DeleteDevBoxLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(StartDevBox202Response | StartDevBoxDefaultResponse | StartDevBoxLogicalResponse)
function isUnexpected(response: StartDevBox202Response | StartDevBoxDefaultResponse | StartDevBoxLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(StopDevBox202Response | StopDevBoxDefaultResponse | StopDevBoxLogicalResponse)
function isUnexpected(response: StopDevBox202Response | StopDevBoxDefaultResponse | StopDevBoxLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(RestartDevBox202Response | RestartDevBoxDefaultResponse | RestartDevBoxLogicalResponse)
function isUnexpected(response: RestartDevBox202Response | RestartDevBoxDefaultResponse | RestartDevBoxLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse)
function isUnexpected(response: GetRemoteConnection200Response | GetRemoteConnectionDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListActions200Response | ListActionsDefaultResponse)
function isUnexpected(response: ListActions200Response | ListActionsDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(GetAction200Response | GetActionDefaultResponse)
function isUnexpected(response: GetAction200Response | GetActionDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(SkipAction204Response | SkipActionDefaultResponse)
function isUnexpected(response: SkipAction204Response | SkipActionDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(DelayAction200Response | DelayActionDefaultResponse)
function isUnexpected(response: DelayAction200Response | DelayActionDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(DelayActions200Response | DelayActionsDefaultResponse)
function isUnexpected(response: DelayActions200Response | DelayActionsDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListEnvironments200Response | ListEnvironmentsDefaultResponse)
function isUnexpected(response: ListEnvironments200Response | ListEnvironmentsDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse)
function isUnexpected(response: ListEnvironmentsByUser200Response | ListEnvironmentsByUserDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse)
function isUnexpected(response: GetEnvironmentByUser200Response | GetEnvironmentByUserDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse)
function isUnexpected(response: CreateOrReplaceEnvironment201Response | CreateOrReplaceEnvironmentDefaultResponse | CreateOrReplaceEnvironmentLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse | DeleteEnvironmentLogicalResponse)
function isUnexpected(response: DeleteEnvironment202Response | DeleteEnvironment204Response | DeleteEnvironmentDefaultResponse | DeleteEnvironmentLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse)
function isUnexpected(response: ListCatalogsByProject200Response | ListCatalogsByProjectDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetCatalog200Response | GetCatalogDefaultResponse)
function isUnexpected(response: GetCatalog200Response | GetCatalogDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse)
function isUnexpected(response: ListEnvironmentDefinitionsByProject200Response | ListEnvironmentDefinitionsByProjectDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse)
function isUnexpected(response: ListEnvironmentDefinitionsByCatalog200Response | ListEnvironmentDefinitionsByCatalogDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse)
function isUnexpected(response: GetEnvironmentDefinition200Response | GetEnvironmentDefinitionDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse)
function isUnexpected(response: ListEnvironmentTypes200Response | ListEnvironmentTypesDefaultResponse): response
Parâmetros
Devoluções
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parâmetros
- client
- Client
Cliente a utilizar para enviar os pedidos da página seguinte
- initialResponse
-
TResponse
Resposta inicial contendo o nextLink e a página atual de elementos
- options
-
PagingOptions<TResponse>
Devoluções
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator para iterar os elementos