ServiceEndpointRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Service |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
Details zum Konstruktor
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Parameter
- options
- IVssRestClientOptions
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
string
Details zur Methode
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Hinzufügen von Dienstendpunktausführungsdatensätzen.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Parameter
Hinzuzufügende Dienstendpunkt-Ausführungsdatensätze.
- project
-
string
Project-ID oder Projekt-Name
Gibt zurück
Promise<ServiceEndpointExecutionRecord[]>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Parameter
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Gibt zurück
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Parameter
- configurationParams
- OAuthConfigurationParams
Gibt zurück
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Erstellt einen neuen Dienstendpunkt.
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Parameter
- endpoint
- ServiceEndpoint
Zu erstellende Dienstendpunkt
Gibt zurück
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parameter
- configurationId
-
string
Gibt zurück
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Löschen eines Dienstendpunkts
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Parameter
- endpointId
-
string
Endpunkt-ID des zu löschenden Endpunkts
- projectIds
-
string[]
Projekt-IDs, von denen der Endpunkt gelöscht werden muss
- deep
-
boolean
löschen Sie den spn, der vom Endpunkt erstellt wurde.
Gibt zurück
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Proxy für eine GET-Anforderung, die von einem Dienstendpunkt definiert wurde.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Parameter
- serviceEndpointRequest
- ServiceEndpointRequest
Serviceendpunktanforderung.
- project
-
string
Project-ID oder Projekt-Name
- endpointId
-
string
ID des Dienstendpunkts.
Gibt zurück
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Rücksendungsliste der Azure-Abonnements
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Gibt zurück
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Rücksendungsliste der Azure-Abonnements
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Gibt zurück
Promise<AzureSubscriptionQueryResult>
getFilteredServiceEndpointTypes(string[])
Abrufen von Dienstendpunkttypen mit übergebenen Typenfiltern.
function getFilteredServiceEndpointTypes(typesFilter: string[]): Promise<ServiceEndpointType[]>Parameter
- typesFilter
-
string[]
Filtern, um zurückgegebene Typen einzuschränken
Gibt zurück
Promise<ServiceEndpointType[]>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parameter
- configurationId
-
string
Gibt zurück
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Parameter
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Gibt zurück
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)
Rufen Sie die Details des Dienstendpunkts ab.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter, loadConfidentialData?: boolean): Promise<ServiceEndpoint>Parameter
- project
-
string
Project-ID oder Projekt-Name
- endpointId
-
string
ID des Dienstendpunkts.
- actionFilter
- ServiceEndpointActionFilter
Aktionsfilter für die Dienstverbindung. Sie gibt die Aktion an, die für die Dienstverbindung ausgeführt werden kann.
- loadConfidentialData
-
boolean
Kennzeichnen, um vertrauliche Details des Dienstendpunkts einzuschließen. Dies ist nur für die interne Verwendung vorgesehen.
Gibt zurück
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Abrufen von Dienstendpunktausführungsdatensätzen.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Parameter
- project
-
string
Project-ID oder Projekt-Name
- endpointId
-
string
ID des Dienstendpunkts.
- top
-
number
Anzahl der abzurufenden Aufzeichnungen für die Ausführung von Dienstendpunkten.
- continuationToken
-
number
Ein Fortsetzungstoken, das von einem vorherigen Aufruf dieser Methode zurückgegeben wird, das verwendet werden kann, um den nächsten Satz von Datensätzen zurückzugeben.
Gibt zurück
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
Rufen Sie die Dienstendpunkte ab.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Parameter
- project
-
string
Project-ID oder Projekt-Name
- type
-
string
Typ der Dienstendpunkte.
- authSchemes
-
string[]
Autorisierungsschemas, die für Dienstendpunkte verwendet werden.
- endpointIds
-
string[]
IDs der Dienstendpunkte.
- owner
-
string
Besitzer für Dienstendpunkte.
- includeFailed
-
boolean
Fehlerkennzeichnung für Dienstendpunkte.
- includeDetails
-
boolean
Kennzeichnung, um weitere Details für Dienstendpunkte einzuschließen. Dies ist nur für die interne Verwendung vorgesehen, und die Kennzeichnung wird für alle anderen Anforderungen als "false" behandelt.
- actionFilter
- ServiceEndpointActionFilter
Mit dem Parameter "actionFilter" können Benutzer Anfordererberechtigungen auswerten und eine Liste von Endpunkten abrufen, die den angegebenen Bedingungen entsprechen, um sicherzustellen, dass nur relevante Endpunkte basierend auf ihren Berechtigungen zurückgegeben werden.
Gibt zurück
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
Rufen Sie die Dienstendpunkte anhand des Namens ab.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Parameter
- project
-
string
Project-ID oder Projekt-Name
- endpointNames
-
string[]
Namen der Dienstendpunkte.
- type
-
string
Typ der Dienstendpunkte.
- authSchemes
-
string[]
Autorisierungsschemas, die für Dienstendpunkte verwendet werden.
- owner
-
string
Besitzer für Dienstendpunkte.
- includeFailed
-
boolean
Fehlerkennzeichnung für Dienstendpunkte.
- includeDetails
-
boolean
Kennzeichnung, um weitere Details für Dienstendpunkte einzuschließen. Dies ist nur für die interne Verwendung vorgesehen, und die Kennzeichnung wird für alle anderen Anforderungen als "false" behandelt.
Gibt zurück
Promise<ServiceEndpoint[]>
getServiceEndpointsByTypeAndOwner(string, string)
Abrufen von Dienstendpunkten für die Organisation nach Typ und Besitzer. Gibt nur die ID, den Namen und die URL zurück und wird nur intern vom Lizenzierungsdienst verwendet
function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>Parameter
- type
-
string
Typ der Dienstendpunkte.
- owner
-
string
Besitzer für Dienstendpunkte.
Gibt zurück
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Ruft die Dienstendpunkte ab und patcht neue Autorisierungsparameter
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Parameter
- refreshAuthenticationParameters
Bereich, Gültigkeit des angeforderten Tokens.
- project
-
string
Project-ID oder Projekt-Name
- endpointIds
-
string[]
IDs der Dienstendpunkte.
Gibt zurück
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Abrufen von Dienstendpunkttypen.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Parameter
- type
-
string
Typ des Dienstendpunkts.
- scheme
-
string
Schema des Dienstendpunkts.
Gibt zurück
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Gibt zurück
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Proxy für eine GET-Anforderung, die von einem Dienstendpunkt definiert wurde. Die Anforderung wird mithilfe einer Datenquelle im Dienstendpunkt autorisiert. Die Antwort wird mithilfe eines XPath/Json-basierten Selektors gefiltert.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Parameter
- binding
- DataSourceBinding
Beschreibt die abzurufende Datenquelle.
- project
-
string
Project-ID oder Projekt-Name
Gibt zurück
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Parameter
- endpointId
-
string
- project
-
string
Gibt zurück
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Parameter
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Gibt zurück
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Gemeinsame Nutzung des Dienstendpunkts über Projekte hinweg
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Parameter
- endpointProjectReferences
Project-Referenzdetails des Ziel-Projekts
- endpointId
-
string
Endpunkt-ID des zu teilenden Endpunkts
Gibt zurück
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Parameter
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Gibt zurück
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
Aktualisieren des Dienstendpunkts
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Parameter
- endpoint
- ServiceEndpoint
Aktualisierte Daten für den Endpunkt
- endpointId
-
string
Endpunkt-ID des zu aktualisierenden Endpunkts
- operation
-
string
Art der Operation
Gibt zurück
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Aktualisieren Sie die Dienstendpunkte.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Parameter
- endpoints
Namen der zu aktualisierenden Dienstendpunkte.
Gibt zurück
Promise<ServiceEndpoint[]>