ServiceEndpointRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
| Service |
Свойства
| RESOURCE_AREA_ID |
Методы
Сведения о конструкторе
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[]>Параметры
Добавляемая запись выполнения конечной точки службы.
- 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)
Получение сведений о конечной точке службы.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint>Параметры
- project
-
string
Идентификатор проекта или имя проекта
- endpointId
-
string
Идентификатор конечной точки службы.
- actionFilter
- ServiceEndpointActionFilter
Фильтр действий для подключения службы. Он указывает действие, которое может быть выполнено при подключении службы.
Возвращаемое значение
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[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Возвращает конечные точки службы и новые параметры авторизации исправления.
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Параметры
- 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
Справочные сведения о целевом проекте
- 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
Имена обновляемых конечных точек служб.
Возвращаемое значение
Promise<ServiceEndpoint[]>