ServiceEndpointRestClient class
Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS
- Extends
Konstruktory
| Service |
Vlastnosti
| RESOURCE_AREA_ID |
Metody
Podrobnosti konstruktoru
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Parametry
- options
- IVssRestClientOptions
Podrobnosti vlastnosti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringHodnota vlastnosti
string
Podrobnosti metody
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Přidejte záznamy o spuštění koncového bodu služby.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Parametry
Záznamy spuštění koncového bodu služby, které se mají přidat.
- project
-
string
ID projektu nebo název projektu
Návraty
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
Návraty
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Parametry
- configurationParams
- OAuthConfigurationParams
Návraty
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Vytvoří nový koncový bod služby.
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Parametry
- endpoint
- ServiceEndpoint
Koncový bod služby, který se má vytvořit
Návraty
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parametry
- configurationId
-
string
Návraty
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Odstranění koncového bodu služby
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Parametry
- endpointId
-
string
ID koncového bodu, který se má odstranit
- projectIds
-
string[]
ID projektu, ze kterého je potřeba odstranit koncový bod
- deep
-
boolean
odstranění hlavního názvu služby vytvořeného koncovým bodem
Návraty
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Proxy pro požadavek GET definovaný koncovým bodem služby.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Parametry
- serviceEndpointRequest
- ServiceEndpointRequest
Žádost o koncový bod služby
- project
-
string
ID projektu nebo název projektu
- endpointId
-
string
ID koncového bodu služby.
Návraty
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Vrátí seznam předplatných Azure.
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Návraty
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Vrátí seznam předplatných Azure.
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Návraty
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parametry
- configurationId
-
string
Návraty
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Parametry
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Návraty
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter)
Získejte podrobnosti o koncovém bodu služby.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint>Parametry
- project
-
string
ID projektu nebo název projektu
- endpointId
-
string
ID koncového bodu služby.
- actionFilter
- ServiceEndpointActionFilter
Filtr akcí pro připojení služby. Určuje akci, kterou je možné provést u připojení služby.
Návraty
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Získejte záznamy o spuštění koncového bodu služby.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Parametry
- project
-
string
ID projektu nebo název projektu
- endpointId
-
string
ID koncového bodu služby.
- top
-
number
Počet záznamů o spuštění koncového bodu služby, které chcete získat.
- continuationToken
-
number
Pokračovací token vrácený předchozím voláním této metody, který lze použít k vrácení další sady záznamů
Návraty
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
Získejte koncové body služby.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Parametry
- project
-
string
ID projektu nebo název projektu
- type
-
string
Typ koncových bodů služby.
- authSchemes
-
string[]
Schémata autorizace používaná pro koncové body služby.
- endpointIds
-
string[]
ID koncových bodů služby.
- owner
-
string
Vlastník koncových bodů služby
- includeFailed
-
boolean
Příznak selhání pro koncové body služby
- includeDetails
-
boolean
Příznak, který obsahuje další podrobnosti o koncových bodech služby. Toto je jenom pro interní použití a příznak se bude pro všechny ostatní požadavky považovat za false.
- actionFilter
- ServiceEndpointActionFilter
Parametr actionFilter umožňuje uživatelům vyhodnotit oprávnění žadatele a načíst seznam koncových bodů, které odpovídají zadaným podmínkám, a zajistit tak, aby se na základě jejich oprávnění vracely jenom relevantní koncové body.
Návraty
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
Získejte koncové body služby podle názvu.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Parametry
- project
-
string
ID projektu nebo název projektu
- endpointNames
-
string[]
Názvy koncových bodů služby
- type
-
string
Typ koncových bodů služby.
- authSchemes
-
string[]
Schémata autorizace používaná pro koncové body služby.
- owner
-
string
Vlastník koncových bodů služby
- includeFailed
-
boolean
Příznak selhání pro koncové body služby
- includeDetails
-
boolean
Příznak, který obsahuje další podrobnosti o koncových bodech služby. Toto je jenom pro interní použití a příznak se bude pro všechny ostatní požadavky považovat za false.
Návraty
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Získá koncové body služby a opraví nové parametry autorizace.
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Parametry
- refreshAuthenticationParameters
Rozsah, platnost požadovaného tokenu.
- project
-
string
ID projektu nebo název projektu
- endpointIds
-
string[]
ID koncových bodů služby.
Návraty
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Získejte typy koncových bodů služby.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Parametry
- type
-
string
Typ koncového bodu služby
- scheme
-
string
Schéma koncového bodu služby
Návraty
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Návraty
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Proxy pro požadavek GET definovaný koncovým bodem služby. Žádost se autorizuje pomocí zdroje dat v koncovém bodu služby. Odpověď se filtruje pomocí selektoru založeného na XPath/JSON.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Parametry
- binding
- DataSourceBinding
Popisuje zdroj dat, který se má načíst.
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Parametry
- endpointId
-
string
- project
-
string
Návraty
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Parametry
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Návraty
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Sdílení koncového bodu služby mezi projekty
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Parametry
- endpointProjectReferences
Referenční podrobnosti projektu cílového projektu
- endpointId
-
string
ID koncového bodu, který se má sdílet
Návraty
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Parametry
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Návraty
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
Aktualizace koncového bodu služby
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Parametry
- endpoint
- ServiceEndpoint
Aktualizovaná data pro koncový bod
- endpointId
-
string
ID koncového bodu, který se má aktualizovat
- operation
-
string
typ operace
Návraty
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Aktualizujte koncové body služby.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Parametry
- endpoints
Názvy koncových bodů služby, které se mají aktualizovat
Návraty
Promise<ServiceEndpoint[]>