ServiceEndpointRestClient class
Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er
- Extends
Konstruktorer
| Service |
Egenskaper
| RESOURCE_AREA_ID |
Metoder
Konstruktorinformation
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Parametrar
- options
- IVssRestClientOptions
Egenskapsinformation
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEgenskapsvärde
string
Metodinformation
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Lägg till tjänstslutpunktskörningsposter.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Parametrar
Tjänstslutpunktskörningsposter att lägga till.
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<ServiceEndpointExecutionRecord[]>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Parametrar
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Returer
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Parametrar
- configurationParams
- OAuthConfigurationParams
Returer
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Skapar en ny tjänstslutpunkt
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Parametrar
- endpoint
- ServiceEndpoint
Tjänstslutpunkt att skapa
Returer
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parametrar
- configurationId
-
string
Returer
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Ta bort en tjänstslutpunkt
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Parametrar
- endpointId
-
string
Slutpunkts-ID för slutpunkt att ta bort
- projectIds
-
string[]
projekt-ID:er från vilka slutpunkten måste tas bort
- deep
-
boolean
ta bort spn som skapats av slutpunkten
Returer
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Proxy för en GET-begäran som definierats av en tjänstslutpunkt.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Parametrar
- serviceEndpointRequest
- ServiceEndpointRequest
Tjänstslutpunktsbegäran.
- project
-
string
Projekt-ID eller projektnamn
- endpointId
-
string
ID för tjänstslutpunkten.
Returer
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Returnerar lista över Azure-prenumerationer
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Returer
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Returnerar lista över Azure-prenumerationer
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Returer
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parametrar
- configurationId
-
string
Returer
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Parametrar
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Returer
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)
Hämta information om tjänstslutpunkten.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter, loadConfidentialData?: boolean): Promise<ServiceEndpoint>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- endpointId
-
string
ID för tjänstslutpunkten.
- actionFilter
- ServiceEndpointActionFilter
Åtgärdsfilter för tjänstanslutningen. Den anger vilken åtgärd som kan utföras på tjänstanslutningen.
- loadConfidentialData
-
boolean
Flagga för att inkludera konfidentiell information om tjänstslutpunkten. Detta är endast för internt bruk.
Returer
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Hämta tjänstslutpunktskörningsposter.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- endpointId
-
string
ID för tjänstslutpunkten.
- top
-
number
Antal tjänstslutpunktskörningsposter som ska hämtas.
- continuationToken
-
number
En fortsättningstoken, som returnerades av ett tidigare anrop till den här metoden, som kan användas för att returnera nästa uppsättning poster
Returer
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
Hämta tjänstslutpunkterna.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- type
-
string
Typ av tjänstslutpunkter.
- authSchemes
-
string[]
Auktoriseringsscheman som används för tjänstslutpunkter.
- endpointIds
-
string[]
ID:t för tjänstslutpunkterna.
- owner
-
string
Ägare för tjänstslutpunkter.
- includeFailed
-
boolean
Flaggan misslyckades för tjänstslutpunkter.
- includeDetails
-
boolean
Flagga för att inkludera mer information om tjänstslutpunkter. Detta är endast för internt bruk och flaggan behandlas som falsk för alla andra begäranden
- actionFilter
- ServiceEndpointActionFilter
Parametern "actionFilter" gör det möjligt för användare att utvärdera begärandebehörigheter och hämta en lista över slutpunkter som matchar de angivna villkoren, vilket säkerställer att endast relevanta slutpunkter returneras baserat på deras behörigheter
Returer
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
Hämta tjänstslutpunkterna efter namn.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- endpointNames
-
string[]
Namn på tjänstslutpunkterna.
- type
-
string
Typ av tjänstslutpunkter.
- authSchemes
-
string[]
Auktoriseringsscheman som används för tjänstslutpunkter.
- owner
-
string
Ägare för tjänstslutpunkter.
- includeFailed
-
boolean
Flaggan misslyckades för tjänstslutpunkter.
- includeDetails
-
boolean
Flagga för att inkludera mer information om tjänstslutpunkter. Detta är endast för internt bruk och flaggan behandlas som falsk för alla andra begäranden
Returer
Promise<ServiceEndpoint[]>
getServiceEndpointsByTypeAndOwner(string, string)
Hämta tjänstslutpunkter för organisationen efter typ och ägare. Returnerar endast id, namn och url och används endast internt av licensieringstjänsten
function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>Parametrar
- type
-
string
Typ av tjänstslutpunkter.
- owner
-
string
Ägare för tjänstslutpunkter.
Returer
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Hämtar tjänstslutpunkterna och korrigerar nya auktoriseringsparametrar
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Parametrar
- refreshAuthenticationParameters
Omfattning, Giltighet för begärd token.
- project
-
string
Projekt-ID eller projektnamn
- endpointIds
-
string[]
ID:t för tjänstslutpunkterna.
Returer
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Hämta tjänstslutpunktstyper.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Parametrar
- type
-
string
Typ av tjänstslutpunkt.
- scheme
-
string
Schema för tjänstslutpunkt.
Returer
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Returer
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Proxy för en GET-begäran som definierats av en tjänstslutpunkt. Begäran är auktoriserad med hjälp av en datakälla i tjänstslutpunkten. Svaret filtreras med en XPath/Json-baserad väljare.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Parametrar
- binding
- DataSourceBinding
Beskriver datakällan som ska hämtas.
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Parametrar
- endpointId
-
string
- project
-
string
Returer
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Parametrar
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Returer
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Dela tjänstslutpunkt mellan projekt
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Parametrar
- endpointProjectReferences
Projektreferensinformation för målprojektet
- endpointId
-
string
Slutpunkts-ID för slutpunkten som ska delas
Returer
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Parametrar
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Returer
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
Uppdatera tjänstslutpunkten
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Parametrar
- endpoint
- ServiceEndpoint
Uppdaterade data för slutpunkten
- endpointId
-
string
Slutpunkts-ID för slutpunkten som ska uppdateras
- operation
-
string
Typ av åtgärd
Returer
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Uppdatera tjänstslutpunkterna.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Parametrar
- endpoints
Namn på de tjänstslutpunkter som ska uppdateras.
Returer
Promise<ServiceEndpoint[]>