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
項目識別碼或項目名稱
傳回
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
刪除端點所建立的spn
傳回
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
服務端點所定義 GET 要求的 Proxy。
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, loadConfidetantialData?: boolean): Promise<ServiceEndpoint>參數
- project
-
string
項目識別碼或項目名稱
- endpointId
-
string
服務端點的標識碼。
- actionFilter
- ServiceEndpointActionFilter
服務連線的動作篩選。 它會指定可在服務連線上執行的動作。
- loadConfidetantialData
-
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[]>
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 要求的 Proxy。 要求是使用服務端點中的數據源進行授權。 回應會使用 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[]>