ServiceEndpointRestClient class
Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).
- 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 Endpunktausführungsdatensätze des Dienstendpunkts.
- project
-
string
Projekt-ID oder Projektname
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, aus denen der Endpunkt gelöscht werden muss
- deep
-
boolean
löschen Sie den vom Endpunkt erstellten SPN.
Gibt zurück
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Proxy für eine GET-Anforderung, die von einem Dienstendpunkt definiert wird.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Parameter
- serviceEndpointRequest
- ServiceEndpointRequest
Dienstendpunktanforderung.
- project
-
string
Projekt-ID oder Projektname
- endpointId
-
string
ID des Dienstendpunkts.
Gibt zurück
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Gibt die Liste der Azure-Abonnements zurück
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Gibt zurück
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Gibt die Liste der Azure-Abonnements zurück
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Gibt zurück
Promise<AzureSubscriptionQueryResult>
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)
Rufen Sie die Details des Dienstendpunkts ab.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint>Parameter
- project
-
string
Projekt-ID oder Projektname
- endpointId
-
string
ID des Dienstendpunkts.
- actionFilter
- ServiceEndpointActionFilter
Aktionsfilter für die Dienstverbindung. Es gibt die Aktion an, die für die Dienstverbindung ausgeführt werden kann.
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
Projekt-ID oder Projektname
- endpointId
-
string
ID des Dienstendpunkts.
- top
-
number
Anzahl der abzurufenden Endpunktausführungsdatensätze des Dienstendpunkts.
- 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
Projekt-ID oder Projektname
- 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
Fehlerhaftes Flag für Dienstendpunkte.
- includeDetails
-
boolean
Flag, um weitere Details für Dienstendpunkte aufzunehmen. Dies ist nur für die interne Verwendung bestimmt, und das Flag wird für alle anderen Anforderungen als false behandelt.
- actionFilter
- ServiceEndpointActionFilter
Mit dem Parameter "actionFilter" können Benutzer die Berechtigungen des Anforderers auswerten und eine Liste von Endpunkten abrufen, die den angegebenen Bedingungen entsprechen. Dadurch wird sichergestellt, 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 nach Name ab.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- 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
Fehlerhaftes Flag für Dienstendpunkte.
- includeDetails
-
boolean
Flag, um weitere Details für Dienstendpunkte aufzunehmen. Dies ist nur für die interne Verwendung bestimmt, und das Flag wird für alle anderen Anforderungen als false behandelt.
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
Projekt-ID oder Projektname
- 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 wird. 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
Projekt-ID oder Projektname
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)
Projektübergreifendes Freigeben von Dienstendpunkten
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Parameter
- endpointProjectReferences
Projektreferenzdetails des Zielprojekts
- endpointId
-
string
Endpunkt-ID des endpunkts, der freigegeben werden soll
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
Vorgangstyp
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[]>