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[]>