ServiceEndpointRestClient class
应使用 (派生自) 的基类向 VSS REST API 发出请求
- Extends
构造函数
| Service |
属性
| RESOURCE_AREA_ID |
方法
构造函数详细信息
ServiceEndpointRestClient(IVssRestClientOptions)
属性详细信息
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string属性值
string
方法详细信息
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
添加服务终结点执行记录。
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>参数
要添加的服务终结点执行记录。
- project
-
string
项目 ID 或项目名称
返回
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
要删除的终结点的终结点 ID
- projectIds
-
string[]
需要从中删除终结点的项目 ID
- deep
-
boolean
删除终结点创建的 spn
返回
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
由服务终结点定义的 GET 请求的代理。
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>参数
- serviceEndpointRequest
- ServiceEndpointRequest
服务终结点请求。
- project
-
string
项目 ID 或项目名称
- endpointId
-
string
服务终结点的 ID。
返回
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
项目 ID 或项目名称
- endpointId
-
string
服务终结点的 ID。
- actionFilter
- ServiceEndpointActionFilter
服务连接的操作筛选器。 它指定可以对服务连接执行的操作。
返回
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
获取服务终结点执行记录。
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>参数
- project
-
string
项目 ID 或项目名称
- endpointId
-
string
服务终结点的 ID。
- 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
项目 ID 或项目名称
- type
-
string
服务终结点的类型。
- authSchemes
-
string[]
用于服务终结点的授权方案。
- endpointIds
-
string[]
服务终结点的 ID。
- 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
项目 ID 或项目名称
- 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
项目 ID 或项目名称
- endpointIds
-
string[]
服务终结点的 ID。
返回
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
项目 ID 或项目名称
返回
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
要共享的终结点的终结点 ID
返回
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
要更新的终结点的终结点 ID
- operation
-
string
操作类型
返回
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
更新服务终结点。
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>参数
- endpoints
要更新的服务终结点的名称。
返回
Promise<ServiceEndpoint[]>