ServiceEndpointRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

ServiceEndpointRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)	Добавьте записи выполнения конечной точки службы.
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createOAuthConfiguration(OAuthConfigurationParams)
createServiceEndpoint(ServiceEndpoint)	Создает новую конечную точку службы
deleteOAuthConfiguration(string)
deleteServiceEndpoint(string, string[], boolean)	Удаление конечной точки службы
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)	Прокси-сервер для запроса GET, определенного конечной точкой службы.
getAzureManagementGroups()	Возвращает список подписок Azure
getAzureSubscriptions()	Возвращает список подписок Azure
getOAuthConfiguration(string)
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)	Получение сведений о конечной точке службы.
getServiceEndpointExecutionRecords(string, string, number, number)	Получение записей выполнения конечной точки службы.
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)	Получение конечных точек службы.
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)	Получение конечных точек службы по имени.
getServiceEndpointsByTypeAndOwner(string, string)	Получение конечных точек службы для организации по типу и владельцу. Возвращает только id, name и url и используется только внутри службы лицензирования
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])	Возвращает конечные точки службы и исправления новых параметров авторизации
getServiceEndpointTypes(string, string)	Получение типов конечных точек службы.
getVstsAadTenantId()
queryServiceEndpoint(DataSourceBinding, string)	Прокси-сервер для запроса GET, определенного конечной точкой службы. Запрос авторизован с помощью источника данных в конечной точке службы. Ответ фильтруется с помощью селектора на основе XPath/Json.
querySharedProjects(string, string)
shareEndpointWithProject(string, string, string)
shareServiceEndpoint(ServiceEndpointProjectReference[], string)	Совместное использование конечной точки службы в проектах
updateOAuthConfiguration(OAuthConfigurationParams, string)
updateServiceEndpoint(ServiceEndpoint, string, string)	Обновление конечной точки службы
updateServiceEndpoints(ServiceEndpoint[])	Обновите конечные точки службы.

Сведения о конструкторе

ServiceEndpointRestClient(IVssRestClientOptions)

new ServiceEndpointRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)

Добавьте записи выполнения конечной точки службы.

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

Параметры

input

ServiceEndpointExecutionRecordsInput

Добавляемая запись выполнения конечной точки службы.

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ServiceEndpointExecutionRecord[]>

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

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

Параметры

tenantId

string

redirectUri

string

promptOption

AadLoginPromptOption

completeCallbackPayload

string

completeCallbackByAuthCode

boolean

Возвращаемое значение

Promise<string>

createOAuthConfiguration(OAuthConfigurationParams)

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

Параметры

configurationParams

OAuthConfigurationParams

Возвращаемое значение

Promise<OAuthConfiguration>

createServiceEndpoint(ServiceEndpoint)

Создает новую конечную точку службы

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

Параметры

endpoint

ServiceEndpoint

Конечная точка службы для создания

Возвращаемое значение

Promise<ServiceEndpoint>

deleteOAuthConfiguration(string)

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

Параметры

configurationId

string

Возвращаемое значение

Promise<OAuthConfiguration>

deleteServiceEndpoint(string, string[], boolean)

Удаление конечной точки службы

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

Параметры

endpointId

string

Идентификатор конечной точки для удаления

projectIds

string[]

Идентификаторы проекта, из которых необходимо удалить конечную точку

deep

boolean

Удаление имени участника-службы, созданного конечной точкой

Возвращаемое значение

Promise<void>

executeServiceEndpointRequest(ServiceEndpointRequest, string, string)

Прокси-сервер для запроса GET, определенного конечной точкой службы.

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

Параметры

serviceEndpointRequest

ServiceEndpointRequest

Запрос конечной точки службы.

project

string

Идентификатор проекта или имя проекта

endpointId

string

Идентификатор конечной точки службы.

Возвращаемое значение

Promise<ServiceEndpointRequestResult>

getAzureManagementGroups()

Возвращает список подписок Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Возвращаемое значение

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Возвращает список подписок Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Возвращаемое значение

Promise<AzureSubscriptionQueryResult>

getOAuthConfiguration(string)

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

Параметры

configurationId

string

Возвращаемое значение

Promise<OAuthConfiguration>

getOAuthConfigurations(string, OAuthConfigurationActionFilter)

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

Параметры

endpointType

string

actionFilter

OAuthConfigurationActionFilter

Возвращаемое значение

Promise<OAuthConfiguration[]>

getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)

Получение сведений о конечной точке службы.

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

Параметры

project

string

Идентификатор проекта или имя проекта

endpointId

string

Идентификатор конечной точки службы.

actionFilter

ServiceEndpointActionFilter

Фильтр действий для подключения к службе. Он указывает действие, которое можно выполнить при подключении к службе.

loadConfidentialData

boolean

Пометка для включения конфиденциальных сведений о конечной точке службы. Это предназначено только для внутреннего использования.

Возвращаемое значение

Promise<ServiceEndpoint>

getServiceEndpointExecutionRecords(string, string, number, number)

Получение записей выполнения конечной точки службы.

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

Параметры

project

string

Идентификатор проекта или имя проекта

endpointId

string

Идентификатор конечной точки службы.

top

number

Количество записей выполнения конечной точки службы для получения.

continuationToken

number

Маркер продолжения, возвращаемый предыдущим вызовом этого метода, который можно использовать для возврата следующего набора записей.

Возвращаемое значение

Promise<PagedList<ServiceEndpointExecutionRecord>>

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

Получение конечных точек службы.

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

Параметры

project

string

Идентификатор проекта или имя проекта

type

string

Тип конечных точек службы.

authSchemes

string[]

Схемы авторизации, используемые для конечных точек службы.

endpointIds

string[]

Идентификаторы конечных точек службы.

owner

string

Владелец конечных точек службы.

includeFailed

boolean

Сбой флага для конечных точек службы.

includeDetails

boolean

Пометка, чтобы включить дополнительные сведения о конечных точках службы. Это только для внутреннего использования, и флаг будет рассматриваться как false для всех остальных запросов.

actionFilter

ServiceEndpointActionFilter

Параметр ActionFilter позволяет пользователям оценивать разрешения запрашивающего пользователя и получать список конечных точек, соответствующих указанным условиям, гарантируя, что возвращаются только соответствующие конечные точки на основе разрешений.

Возвращаемое значение

Promise<ServiceEndpoint[]>

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

Получение конечных точек службы по имени.

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

Параметры

project

string

Идентификатор проекта или имя проекта

endpointNames

string[]

Имена конечных точек службы.

type

string

Тип конечных точек службы.

authSchemes

string[]

Схемы авторизации, используемые для конечных точек службы.

owner

string

Владелец конечных точек службы.

includeFailed

boolean

Сбой флага для конечных точек службы.

includeDetails

boolean

Пометка, чтобы включить дополнительные сведения о конечных точках службы. Это только для внутреннего использования, и флаг будет рассматриваться как false для всех остальных запросов.

Возвращаемое значение

Promise<ServiceEndpoint[]>

getServiceEndpointsByTypeAndOwner(string, string)

Получение конечных точек службы для организации по типу и владельцу. Возвращает только id, name и url и используется только внутри службы лицензирования

function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>

Параметры

type

string

Тип конечных точек службы.

owner

string

Владелец конечных точек службы.

Возвращаемое значение

Promise<ServiceEndpoint[]>

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

Возвращает конечные точки службы и исправления новых параметров авторизации

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

Параметры

refreshAuthenticationParameters

RefreshAuthenticationParameters[]

Область, допустимость запрошенного токена.

project

string

Идентификатор проекта или имя проекта

endpointIds

string[]

Идентификаторы конечных точек службы.

Возвращаемое значение

Promise<ServiceEndpoint[]>

getServiceEndpointTypes(string, string)

Получение типов конечных точек службы.

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

Параметры

type

string

Тип конечной точки службы.

scheme

string

Схема конечной точки службы.

Возвращаемое значение

Promise<ServiceEndpointType[]>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Возвращаемое значение

Promise<string>

queryServiceEndpoint(DataSourceBinding, string)

Прокси-сервер для запроса GET, определенного конечной точкой службы. Запрос авторизован с помощью источника данных в конечной точке службы. Ответ фильтруется с помощью селектора на основе XPath/Json.

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

Параметры

binding

DataSourceBinding

Описывает источник данных для получения.

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<string[]>

querySharedProjects(string, string)

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

Параметры

endpointId

string

project

string

Возвращаемое значение

Promise<ProjectReference[]>

shareEndpointWithProject(string, string, string)

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

Параметры

endpointId

string

fromProject

string

withProject

string

Возвращаемое значение

Promise<void>

shareServiceEndpoint(ServiceEndpointProjectReference[], string)

Совместное использование конечной точки службы в проектах

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

Параметры

endpointProjectReferences

ServiceEndpointProjectReference[]

Справочные сведения о проекте

endpointId

string

Идентификатор конечной точки для общего доступа

Возвращаемое значение

Promise<void>

updateOAuthConfiguration(OAuthConfigurationParams, string)

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

Параметры

configurationParams

OAuthConfigurationParams

configurationId

string

Возвращаемое значение

Promise<OAuthConfiguration>

updateServiceEndpoint(ServiceEndpoint, string, string)

Обновление конечной точки службы

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

Параметры

endpoint

ServiceEndpoint

Обновленные данные для конечной точки

endpointId

string

Идентификатор конечной точки для обновления

operation

string

Тип операции

Возвращаемое значение

Promise<ServiceEndpoint>

updateServiceEndpoints(ServiceEndpoint[])

Обновите конечные точки службы.

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

Параметры

endpoints

ServiceEndpoint[]

Имена конечных точек службы для обновления.

Возвращаемое значение

Promise<ServiceEndpoint[]>