ServiceEndpointRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni
- Extends
Konstruktorok
| Service |
Tulajdonságok
| RESOURCE_AREA_ID |
Metódusok
Konstruktor adatai
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Paraméterek
- options
- IVssRestClientOptions
Tulajdonság adatai
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringTulajdonság értéke
string
Metódus adatai
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Szolgáltatásvégpont végrehajtási rekordjainak hozzáadása.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Paraméterek
A hozzáadni kívánt szolgáltatásvégpont végrehajtási rekordjai.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ServiceEndpointExecutionRecord[]>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Paraméterek
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Válaszok
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Paraméterek
- configurationParams
- OAuthConfigurationParams
Válaszok
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Új szolgáltatásvégpont létrehozása
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Paraméterek
- endpoint
- ServiceEndpoint
Létrehozandó szolgáltatásvégpont
Válaszok
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Paraméterek
- configurationId
-
string
Válaszok
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Szolgáltatásvégpont törlése
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Paraméterek
- endpointId
-
string
A törölni kívánt végpont végpontazonosítója
- projectIds
-
string[]
projektazonosítók, amelyekből a végpontot törölni kell
- deep
-
boolean
a végpont által létrehozott spn törlése
Válaszok
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Szolgáltatásvégpont által definiált GET-kérés proxyja.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Paraméterek
- serviceEndpointRequest
- ServiceEndpointRequest
Szolgáltatásvégpont-kérés.
- project
-
string
Projektazonosító vagy projektnév
- endpointId
-
string
A szolgáltatásvégpont azonosítója.
Válaszok
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Az Azure-előfizetések listáját adja vissza
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Válaszok
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Az Azure-előfizetések listáját adja vissza
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Válaszok
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Paraméterek
- configurationId
-
string
Válaszok
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Paraméterek
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Válaszok
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)
A szolgáltatásvégpont részleteinek lekérése.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter, loadConfidentialData?: boolean): Promise<ServiceEndpoint>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- endpointId
-
string
A szolgáltatásvégpont azonosítója.
- actionFilter
- ServiceEndpointActionFilter
A szolgáltatáskapcsolat műveletszűrője. Megadja a szolgáltatáskapcsolaton végrehajtható műveletet.
- loadConfidentialData
-
boolean
A szolgáltatásvégpont bizalmas adatainak megjelölése. Ez csak belső használatra készült.
Válaszok
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Szolgáltatásvégpont végrehajtási rekordjainak lekérése.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- endpointId
-
string
A szolgáltatásvégpont azonosítója.
- top
-
number
Lekérendő szolgáltatásvégpont végrehajtási rekordjainak száma.
- continuationToken
-
number
A metódus egy korábbi hívása által visszaadott folytatási jogkivonat, amely a következő rekordkészlet visszaadására használható
Válaszok
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
A szolgáltatásvégpontok lekérése.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- type
-
string
A szolgáltatásvégpontok típusa.
- authSchemes
-
string[]
Szolgáltatásvégpontokhoz használt engedélyezési sémák.
- endpointIds
-
string[]
A szolgáltatásvégpontok azonosítójai.
- owner
-
string
Szolgáltatásvégpontok tulajdonosa.
- includeFailed
-
boolean
A szolgáltatásvégpontok sikertelen jelzője.
- includeDetails
-
boolean
Jelölő a szolgáltatásvégpontok további részleteinek megadásához. Ez csak belső használatra vonatkozik, és a jelölő minden más kérés esetén hamisként lesz kezelve
- actionFilter
- ServiceEndpointActionFilter
Az "actionFilter" paraméterrel a felhasználók kiértékelhetik a kérelmező engedélyeit, és lekérhetik a megadott feltételeknek megfelelő végpontok listáját, biztosítva, hogy csak a releváns végpontok legyenek visszaadva az engedélyeik alapján
Válaszok
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
A szolgáltatásvégpontok lekérése név szerint.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- endpointNames
-
string[]
A szolgáltatásvégpontok nevei.
- type
-
string
A szolgáltatásvégpontok típusa.
- authSchemes
-
string[]
Szolgáltatásvégpontokhoz használt engedélyezési sémák.
- owner
-
string
Szolgáltatásvégpontok tulajdonosa.
- includeFailed
-
boolean
A szolgáltatásvégpontok sikertelen jelzője.
- includeDetails
-
boolean
Jelölő a szolgáltatásvégpontok további részleteinek megadásához. Ez csak belső használatra vonatkozik, és a jelölő minden más kérés esetén hamisként lesz kezelve
Válaszok
Promise<ServiceEndpoint[]>
getServiceEndpointsByTypeAndOwner(string, string)
Szerezze be a szervezeti szolgáltatásvégpontokat típus és tulajdonos szerint. Csak az azonosítót, a nevet és az URL-címet adja vissza, és csak a licencelési szolgáltatás belsőleg használja
function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>Paraméterek
- type
-
string
A szolgáltatásvégpontok típusa.
- owner
-
string
Szolgáltatásvégpontok tulajdonosa.
Válaszok
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Lekéri a szolgáltatásvégpontokat, és kijavítja az új engedélyezési paramétereket
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Paraméterek
- refreshAuthenticationParameters
A kért jogkivonat hatóköre, érvényessége.
- project
-
string
Projektazonosító vagy projektnév
- endpointIds
-
string[]
A szolgáltatásvégpontok azonosítójai.
Válaszok
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Szolgáltatásvégponttípusok lekérése.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Paraméterek
- type
-
string
A szolgáltatásvégpont típusa.
- scheme
-
string
A szolgáltatásvégpont sémája.
Válaszok
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Válaszok
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Szolgáltatásvégpont által definiált GET-kérés proxyja. A kérés a szolgáltatásvégpont adatforrásával van engedélyezve. A válasz egy XPath/Json-alapú választóval lesz szűrve.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Paraméterek
- binding
- DataSourceBinding
A beolvasandó adatforrást ismerteti.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Paraméterek
- endpointId
-
string
- project
-
string
Válaszok
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Paraméterek
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Válaszok
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Szolgáltatásvégpont megosztása projektek között
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Paraméterek
- endpointProjectReferences
A célprojekt projekthivatkozási adatai
- endpointId
-
string
A megosztani kívánt végpont végpontazonosítója
Válaszok
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Paraméterek
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Válaszok
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
A szolgáltatásvégpont frissítése
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Paraméterek
- endpoint
- ServiceEndpoint
A végpont adatainak frissítése
- endpointId
-
string
A frissíteni kívánt végpont végpontazonosítója
- operation
-
string
Művelet típusa
Válaszok
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Frissítse a szolgáltatásvégpontokat.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Paraméterek
- endpoints
A frissíteni kívánt szolgáltatásvégpontok nevei.
Válaszok
Promise<ServiceEndpoint[]>