ServiceEndpointRestClient class

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends

Construtores

ServiceEndpointRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)

Adicione registros de execução de ponto de extremidade de serviço.

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createOAuthConfiguration(OAuthConfigurationParams)
createServiceEndpoint(ServiceEndpoint)

Cria um novo ponto de extremidade de serviço

deleteOAuthConfiguration(string)
deleteServiceEndpoint(string, string[], boolean)

Excluir um ponto de extremidade de serviço

executeServiceEndpointRequest(ServiceEndpointRequest, string, string)

Proxy para uma solicitação GET definida por um ponto de extremidade de serviço.

getAzureManagementGroups()

Retorna lista de assinaturas do azure

getAzureSubscriptions()

Retorna lista de assinaturas do azure

getOAuthConfiguration(string)
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)

Obtenha os detalhes do ponto de extremidade do serviço.

getServiceEndpointExecutionRecords(string, string, number, number)

Obtenha registros de execução de ponto de extremidade de serviço.

getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)

Obtenha os pontos de extremidade de serviço.

getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)

Obtenha os pontos de extremidade de serviço pelo nome.

getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])

Obtém os pontos de extremidade de serviço e corrige novos parâmetros de autorização

getServiceEndpointTypes(string, string)

Obtenha tipos de ponto de extremidade de serviço.

getVstsAadTenantId()
queryServiceEndpoint(DataSourceBinding, string)

Proxy para uma solicitação GET definida por um ponto de extremidade de serviço. A solicitação é autorizada usando uma fonte de dados no ponto de extremidade do serviço. A resposta é filtrada usando um seletor baseado em XPath/Json.

querySharedProjects(string, string)
shareEndpointWithProject(string, string, string)
shareServiceEndpoint(ServiceEndpointProjectReference[], string)

Compartilhar ponto de extremidade de serviço entre projetos

updateOAuthConfiguration(OAuthConfigurationParams, string)
updateServiceEndpoint(ServiceEndpoint, string, string)

Atualizar o ponto de extremidade do serviço

updateServiceEndpoints(ServiceEndpoint[])

Atualize os pontos de extremidade de serviço.

Detalhes do Construtor

ServiceEndpointRestClient(IVssRestClientOptions)

new ServiceEndpointRestClient(options: IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)

Adicione registros de execução de ponto de extremidade de serviço.

function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>

Parâmetros

input
ServiceEndpointExecutionRecordsInput

Registros de execução de ponto de extremidade de serviço a serem adicionados.

project

string

ID do projeto ou nome do projeto

Devoluções

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)

function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>

Parâmetros

tenantId

string

redirectUri

string

promptOption
AadLoginPromptOption
completeCallbackPayload

string

completeCallbackByAuthCode

boolean

Devoluções

Promise<string>

createOAuthConfiguration(OAuthConfigurationParams)

function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>

Parâmetros

configurationParams
OAuthConfigurationParams

Devoluções

createServiceEndpoint(ServiceEndpoint)

Cria um novo ponto de extremidade de serviço

function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>

Parâmetros

endpoint
ServiceEndpoint

Ponto de extremidade de serviço a ser criado

Devoluções

Promise<ServiceEndpoint>

deleteOAuthConfiguration(string)

function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>

Parâmetros

configurationId

string

Devoluções

deleteServiceEndpoint(string, string[], boolean)

Excluir um ponto de extremidade de serviço

function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>

Parâmetros

endpointId

string

ID do ponto de extremidade a ser excluído

projectIds

string[]

Ids do projeto do qual o ponto de extremidade precisa ser excluído

deep

boolean

Excluir o SPN criado pelo ponto de extremidade

Devoluções

Promise<void>

executeServiceEndpointRequest(ServiceEndpointRequest, string, string)

Proxy para uma solicitação GET definida por um ponto de extremidade de serviço.

function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>

Parâmetros

serviceEndpointRequest
ServiceEndpointRequest

Solicitação de ponto de extremidade de serviço.

project

string

ID do projeto ou nome do projeto

endpointId

string

Id do ponto de extremidade do serviço.

Devoluções

getAzureManagementGroups()

Retorna lista de assinaturas do azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Devoluções

getAzureSubscriptions()

Retorna lista de assinaturas do azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Devoluções

getOAuthConfiguration(string)

function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>

Parâmetros

configurationId

string

Devoluções

getOAuthConfigurations(string, OAuthConfigurationActionFilter)

function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>

Parâmetros

endpointType

string

Devoluções

Promise<OAuthConfiguration[]>

getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)

Obtenha os detalhes do ponto de extremidade do serviço.

function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter, loadConfidetantialData?: boolean): Promise<ServiceEndpoint>

Parâmetros

project

string

ID do projeto ou nome do projeto

endpointId

string

Id do ponto de extremidade do serviço.

actionFilter
ServiceEndpointActionFilter

Filtro de ação para a conexão de serviço. Ele especifica a ação que pode ser executada na conexão de serviço.

loadConfidetantialData

boolean

Sinalizar para incluir detalhes confidenciais do ponto de extremidade do serviço. Isto é apenas para uso interno.

Devoluções

Promise<ServiceEndpoint>

getServiceEndpointExecutionRecords(string, string, number, number)

Obtenha registros de execução de ponto de extremidade de serviço.

function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>

Parâmetros

project

string

ID do projeto ou nome do projeto

endpointId

string

Id do ponto de extremidade do serviço.

top

number

Número de registros de execução de ponto de extremidade de serviço a serem obtidos.

continuationToken

number

Um token de continuação, retornado por uma chamada anterior para esse método, que pode ser usado para retornar o próximo conjunto de registros

Devoluções

getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)

Obtenha os pontos de extremidade de serviço.

function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

type

string

Tipo de pontos de extremidade de serviço.

authSchemes

string[]

Esquemas de autorização usados para pontos de extremidade de serviço.

endpointIds

string[]

Ids dos pontos de extremidade de serviço.

owner

string

Proprietário para pontos de extremidade de serviço.

includeFailed

boolean

Sinalizador de falha para pontos de extremidade de serviço.

includeDetails

boolean

Sinalizar para incluir mais detalhes sobre pontos de extremidade de serviço. Isso é apenas para uso interno e o sinalizador será tratado como falso para todas as outras solicitações

actionFilter
ServiceEndpointActionFilter

O parâmetro "actionFilter" permite que os usuários avaliem as permissões do solicitante e recuperem uma lista de pontos de extremidade que correspondam às condições especificadas, garantindo que apenas os pontos de extremidade relevantes sejam retornados com base em suas permissões

Devoluções

Promise<ServiceEndpoint[]>

getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)

Obtenha os pontos de extremidade de serviço pelo nome.

function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

endpointNames

string[]

Nomes dos pontos de extremidade de serviço.

type

string

Tipo de pontos de extremidade de serviço.

authSchemes

string[]

Esquemas de autorização usados para pontos de extremidade de serviço.

owner

string

Proprietário para pontos de extremidade de serviço.

includeFailed

boolean

Sinalizador de falha para pontos de extremidade de serviço.

includeDetails

boolean

Sinalizar para incluir mais detalhes sobre pontos de extremidade de serviço. Isso é apenas para uso interno e o sinalizador será tratado como falso para todas as outras solicitações

Devoluções

Promise<ServiceEndpoint[]>

getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])

Obtém os pontos de extremidade de serviço e corrige novos parâmetros de autorização

function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>

Parâmetros

refreshAuthenticationParameters

RefreshAuthenticationParameters[]

Escopo, Validade do Token solicitado.

project

string

ID do projeto ou nome do projeto

endpointIds

string[]

Ids dos pontos de extremidade de serviço.

Devoluções

Promise<ServiceEndpoint[]>

getServiceEndpointTypes(string, string)

Obtenha tipos de ponto de extremidade de serviço.

function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>

Parâmetros

type

string

Tipo de ponto de extremidade de serviço.

scheme

string

Esquema de ponto de extremidade de serviço.

Devoluções

Promise<ServiceEndpointType[]>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Devoluções

Promise<string>

queryServiceEndpoint(DataSourceBinding, string)

Proxy para uma solicitação GET definida por um ponto de extremidade de serviço. A solicitação é autorizada usando uma fonte de dados no ponto de extremidade do serviço. A resposta é filtrada usando um seletor baseado em XPath/Json.

function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>

Parâmetros

binding
DataSourceBinding

Descreve a fonte de dados a ser buscada.

project

string

ID do projeto ou nome do projeto

Devoluções

Promise<string[]>

querySharedProjects(string, string)

function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>

Parâmetros

endpointId

string

project

string

Devoluções

Promise<ProjectReference[]>

shareEndpointWithProject(string, string, string)

function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>

Parâmetros

endpointId

string

fromProject

string

withProject

string

Devoluções

Promise<void>

shareServiceEndpoint(ServiceEndpointProjectReference[], string)

Compartilhar ponto de extremidade de serviço entre projetos

function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>

Parâmetros

endpointProjectReferences

ServiceEndpointProjectReference[]

Detalhes de referência do projeto-alvo

endpointId

string

ID do ponto de extremidade a ser compartilhado

Devoluções

Promise<void>

updateOAuthConfiguration(OAuthConfigurationParams, string)

function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>

Parâmetros

configurationParams
OAuthConfigurationParams
configurationId

string

Devoluções

updateServiceEndpoint(ServiceEndpoint, string, string)

Atualizar o ponto de extremidade do serviço

function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>

Parâmetros

endpoint
ServiceEndpoint

Dados atualizados para o endpoint

endpointId

string

ID do ponto de extremidade a ser atualizado

operation

string

Tipo de operação

Devoluções

Promise<ServiceEndpoint>

updateServiceEndpoints(ServiceEndpoint[])

Atualize os pontos de extremidade de serviço.

function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>

Parâmetros

endpoints

ServiceEndpoint[]

Nomes dos pontos de extremidade de serviço a serem atualizados.

Devoluções

Promise<ServiceEndpoint[]>