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