ServiceEndpointRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

ServiceEndpointRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)	Dodaj rekordy wykonywania punktu końcowego usługi.
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createOAuthConfiguration(OAuthConfigurationParams)
createServiceEndpoint(ServiceEndpoint)	Tworzy nowy punkt końcowy usługi
deleteOAuthConfiguration(string)
deleteServiceEndpoint(string, string[], boolean)	Usuwanie punktu końcowego usługi
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)	Serwer proxy dla żądania GET zdefiniowanego przez punkt końcowy usługi.
getAzureManagementGroups()	Zwraca listę subskrypcji platformy Azure
getAzureSubscriptions()	Zwraca listę subskrypcji platformy Azure
getOAuthConfiguration(string)
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter)	Pobierz szczegóły punktu końcowego usługi.
getServiceEndpointExecutionRecords(string, string, number, number)	Pobieranie rekordów wykonywania punktu końcowego usługi.
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)	Pobierz punkty końcowe usługi.
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)	Pobierz punkty końcowe usługi według nazwy.
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])	Pobiera punkty końcowe usługi i poprawia nowe parametry autoryzacji
getServiceEndpointTypes(string, string)	Pobieranie typów punktów końcowych usługi.
getVstsAadTenantId()
queryServiceEndpoint(DataSourceBinding, string)	Serwer proxy dla żądania GET zdefiniowanego przez punkt końcowy usługi. Żądanie jest autoryzowane przy użyciu źródła danych w punkcie końcowym usługi. Odpowiedź jest filtrowana przy użyciu selektora opartego na języku XPath/Json.
querySharedProjects(string, string)
shareEndpointWithProject(string, string, string)
shareServiceEndpoint(ServiceEndpointProjectReference[], string)	Udostępnianie punktu końcowego usługi między projektami
updateOAuthConfiguration(OAuthConfigurationParams, string)
updateServiceEndpoint(ServiceEndpoint, string, string)	Aktualizowanie punktu końcowego usługi
updateServiceEndpoints(ServiceEndpoint[])	Zaktualizuj punkty końcowe usługi.

Szczegóły konstruktora

ServiceEndpointRestClient(IVssRestClientOptions)

new ServiceEndpointRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)

Dodaj rekordy wykonywania punktu końcowego usługi.

function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>

Parametry

input

ServiceEndpointExecutionRecordsInput

Rekordy wykonywania punktu końcowego usługi do dodania.

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ServiceEndpointExecutionRecord[]>

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)

function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>

Parametry

tenantId

string

redirectUri

string

promptOption

AadLoginPromptOption

completeCallbackPayload

string

completeCallbackByAuthCode

boolean

Zwraca

Promise<string>

createOAuthConfiguration(OAuthConfigurationParams)

function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>

Parametry

configurationParams

OAuthConfigurationParams

Zwraca

Promise<OAuthConfiguration>

createServiceEndpoint(ServiceEndpoint)

Tworzy nowy punkt końcowy usługi

function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>

Parametry

endpoint

ServiceEndpoint

Punkt końcowy usługi do utworzenia

Zwraca

Promise<ServiceEndpoint>

deleteOAuthConfiguration(string)

function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>

Parametry

configurationId

string

Zwraca

Promise<OAuthConfiguration>

deleteServiceEndpoint(string, string[], boolean)

Usuwanie punktu końcowego usługi

function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>

Parametry

endpointId

string

Identyfikator punktu końcowego punktu końcowego do usunięcia

projectIds

string[]

identyfikatory projektu, z których należy usunąć punkt końcowy

deep

boolean

usuwanie nazwy spn utworzonej przez punkt końcowy

Zwraca

Promise<void>

executeServiceEndpointRequest(ServiceEndpointRequest, string, string)

Serwer proxy dla żądania GET zdefiniowanego przez punkt końcowy usługi.

function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>

Parametry

serviceEndpointRequest

ServiceEndpointRequest

Żądanie punktu końcowego usługi.

project

string

Identyfikator projektu lub nazwa projektu

endpointId

string

Identyfikator punktu końcowego usługi.

Zwraca

Promise<ServiceEndpointRequestResult>

getAzureManagementGroups()

Zwraca listę subskrypcji platformy Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Zwraca

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Zwraca listę subskrypcji platformy Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Zwraca

Promise<AzureSubscriptionQueryResult>

getOAuthConfiguration(string)

function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>

Parametry

configurationId

string

Zwraca

Promise<OAuthConfiguration>

getOAuthConfigurations(string, OAuthConfigurationActionFilter)

function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>

Parametry

endpointType

string

actionFilter

OAuthConfigurationActionFilter

Zwraca

Promise<OAuthConfiguration[]>

getServiceEndpointDetails(string, string, ServiceEndpointActionFilter)

Pobierz szczegóły punktu końcowego usługi.

function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

endpointId

string

Identyfikator punktu końcowego usługi.

actionFilter

ServiceEndpointActionFilter

Filtr akcji dla połączenia z usługą. Określa akcję, którą można wykonać w połączeniu z usługą.

Zwraca

Promise<ServiceEndpoint>

getServiceEndpointExecutionRecords(string, string, number, number)

Pobieranie rekordów wykonywania punktu końcowego usługi.

function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

endpointId

string

Identyfikator punktu końcowego usługi.

top

number

Liczba rekordów wykonywania punktu końcowego usługi do pobrania.

continuationToken

number

Token kontynuacji zwrócony przez poprzednie wywołanie tej metody, którego można użyć do zwrócenia następnego zestawu rekordów

Zwraca

Promise<PagedList<ServiceEndpointExecutionRecord>>

getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)

Pobierz punkty końcowe usługi.

function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

type

string

Typ punktów końcowych usługi.

authSchemes

string[]

Schematy autoryzacji używane dla punktów końcowych usługi.

endpointIds

string[]

Identyfikatory punktów końcowych usługi.

owner

string

Właściciel punktów końcowych usługi.

includeFailed

boolean

Flaga niepowodzenia dla punktów końcowych usługi.

includeDetails

boolean

Flaga w celu uwzględnienia dodatkowych szczegółów dotyczących punktów końcowych usługi. Dotyczy to tylko użytku wewnętrznego, a flaga będzie traktowana jako fałsz dla wszystkich innych żądań

actionFilter

ServiceEndpointActionFilter

Parametr "actionFilter" umożliwia użytkownikom ocenę uprawnień osoby żądającej i pobranie listy punktów końcowych spełniających określone warunki, zapewniając, że zwracane są tylko odpowiednie punkty końcowe na podstawie ich uprawnień

Zwraca

Promise<ServiceEndpoint[]>

getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)

Pobierz punkty końcowe usługi według nazwy.

function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

endpointNames

string[]

Nazwy punktów końcowych usługi.

type

string

Typ punktów końcowych usługi.

authSchemes

string[]

Schematy autoryzacji używane dla punktów końcowych usługi.

owner

string

Właściciel punktów końcowych usługi.

includeFailed

boolean

Flaga niepowodzenia dla punktów końcowych usługi.

includeDetails

boolean

Flaga w celu uwzględnienia dodatkowych szczegółów dotyczących punktów końcowych usługi. Dotyczy to tylko użytku wewnętrznego, a flaga będzie traktowana jako fałsz dla wszystkich innych żądań

Zwraca

Promise<ServiceEndpoint[]>

getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])

Pobiera punkty końcowe usługi i poprawia nowe parametry autoryzacji

function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>

Parametry

refreshAuthenticationParameters

RefreshAuthenticationParameters[]

Zakres, ważność żądanego tokenu.

project

string

Identyfikator projektu lub nazwa projektu

endpointIds

string[]

Identyfikatory punktów końcowych usługi.

Zwraca

Promise<ServiceEndpoint[]>

getServiceEndpointTypes(string, string)

Pobieranie typów punktów końcowych usługi.

function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>

Parametry

type

string

Typ punktu końcowego usługi.

scheme

string

Schemat punktu końcowego usługi.

Zwraca

Promise<ServiceEndpointType[]>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Zwraca

Promise<string>

queryServiceEndpoint(DataSourceBinding, string)

Serwer proxy dla żądania GET zdefiniowanego przez punkt końcowy usługi. Żądanie jest autoryzowane przy użyciu źródła danych w punkcie końcowym usługi. Odpowiedź jest filtrowana przy użyciu selektora opartego na języku XPath/Json.

function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>

Parametry

binding

DataSourceBinding

Opisuje źródło danych do pobrania.

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<string[]>

querySharedProjects(string, string)

function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>

Parametry

endpointId

string

project

string

Zwraca

Promise<ProjectReference[]>

shareEndpointWithProject(string, string, string)

function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>

Parametry

endpointId

string

fromProject

string

withProject

string

Zwraca

Promise<void>

shareServiceEndpoint(ServiceEndpointProjectReference[], string)

Udostępnianie punktu końcowego usługi między projektami

function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>

Parametry

endpointProjectReferences

ServiceEndpointProjectReference[]

Szczegóły odwołania do projektu docelowego

endpointId

string

Identyfikator punktu końcowego punktu końcowego do udostępnienia

Zwraca

Promise<void>

updateOAuthConfiguration(OAuthConfigurationParams, string)

function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>

Parametry

configurationParams

OAuthConfigurationParams

configurationId

string

Zwraca

Promise<OAuthConfiguration>

updateServiceEndpoint(ServiceEndpoint, string, string)

Aktualizowanie punktu końcowego usługi

function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>

Parametry

endpoint

ServiceEndpoint

Zaktualizowane dane dla punktu końcowego

endpointId

string

Identyfikator punktu końcowego do zaktualizowania

operation

string

typ operacji

Zwraca

Promise<ServiceEndpoint>

updateServiceEndpoints(ServiceEndpoint[])

Zaktualizuj punkty końcowe usługi.

function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>

Parametry

endpoints

ServiceEndpoint[]

Nazwy punktów końcowych usługi do zaktualizowania.

Zwraca

Promise<ServiceEndpoint[]>