ServiceEndpointRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes aux API REST VSS
- Extends
Constructeurs
| Service |
Propriétés
| RESOURCE_AREA_ID |
Méthodes
Détails du constructeur
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Paramètres
- options
- IVssRestClientOptions
Détails de la propriété
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValeur de propriété
string
Détails de la méthode
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Ajoutez des enregistrements d’exécution de point de terminaison de service.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Paramètres
Enregistrements d’exécution de point de terminaison de service à ajouter.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<ServiceEndpointExecutionRecord[]>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Paramètres
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Retours
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Paramètres
- configurationParams
- OAuthConfigurationParams
Retours
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Crée un point de terminaison de service
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Paramètres
- endpoint
- ServiceEndpoint
Point de terminaison de service à créer
Retours
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Paramètres
- configurationId
-
string
Retours
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Supprimer un point de terminaison de service
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Paramètres
- endpointId
-
string
ID de point de terminaison du point de terminaison à supprimer
- projectIds
-
string[]
ID de projet à partir desquels le point de terminaison doit être supprimé
- deep
-
boolean
supprimer le spn créé par point de terminaison
Retours
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Proxy pour une requête GET définie par un point de terminaison de service.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Paramètres
- serviceEndpointRequest
- ServiceEndpointRequest
Demande de point de terminaison de service.
- project
-
string
ID de projet ou nom du projet
- endpointId
-
string
ID du point de terminaison de service.
Retours
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Retourne la liste des abonnements Azure
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Retours
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Retourne la liste des abonnements Azure
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Retours
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Paramètres
- configurationId
-
string
Retours
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Paramètres
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Retours
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter)
Obtenez les détails du point de terminaison de service.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint>Paramètres
- project
-
string
ID de projet ou nom du projet
- endpointId
-
string
ID du point de terminaison de service.
- actionFilter
- ServiceEndpointActionFilter
Filtre d’action pour la connexion de service. Il spécifie l’action qui peut être effectuée sur la connexion de service.
Retours
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Obtenez les enregistrements d’exécution du point de terminaison de service.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Paramètres
- project
-
string
ID de projet ou nom du projet
- endpointId
-
string
ID du point de terminaison de service.
- top
-
number
Nombre d’enregistrements d’exécution de point de terminaison de service à obtenir.
- continuationToken
-
number
Jeton de continuation, retourné par un appel précédent à cette méthode, qui peut être utilisé pour retourner le jeu d’enregistrements suivant
Retours
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
Obtenez les points de terminaison de service.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Paramètres
- project
-
string
ID de projet ou nom du projet
- type
-
string
Type des points de terminaison de service.
- authSchemes
-
string[]
Schémas d’autorisation utilisés pour les points de terminaison de service.
- endpointIds
-
string[]
ID des points de terminaison de service.
- owner
-
string
Propriétaire des points de terminaison de service.
- includeFailed
-
boolean
Indicateur Échec pour les points de terminaison de service.
- includeDetails
-
boolean
Indicateur pour inclure plus de détails pour les points de terminaison de service. Il s’agit d’un usage interne uniquement et l’indicateur sera traité comme false pour toutes les autres demandes
- actionFilter
- ServiceEndpointActionFilter
Le paramètre « actionFilter » permet aux utilisateurs d’évaluer les autorisations du demandeur et de récupérer une liste de points de terminaison qui correspondent aux conditions spécifiées, en veillant à ce que seuls les points de terminaison pertinents soient retournés en fonction de leurs autorisations
Retours
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
Obtenez les points de terminaison de service par nom.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Paramètres
- project
-
string
ID de projet ou nom du projet
- endpointNames
-
string[]
Noms des points de terminaison de service.
- type
-
string
Type des points de terminaison de service.
- authSchemes
-
string[]
Schémas d’autorisation utilisés pour les points de terminaison de service.
- owner
-
string
Propriétaire des points de terminaison de service.
- includeFailed
-
boolean
Indicateur Échec pour les points de terminaison de service.
- includeDetails
-
boolean
Indicateur pour inclure plus de détails pour les points de terminaison de service. Il s’agit d’un usage interne uniquement et l’indicateur sera traité comme false pour toutes les autres demandes
Retours
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Obtient les points de terminaison de service et met à jour les nouveaux paramètres d’autorisation
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Paramètres
- refreshAuthenticationParameters
Étendue, Validité du jeton demandé.
- project
-
string
ID de projet ou nom du projet
- endpointIds
-
string[]
ID des points de terminaison de service.
Retours
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Obtenir les types de points de terminaison de service.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Paramètres
- type
-
string
Type de point de terminaison de service.
- scheme
-
string
Schéma du point de terminaison de service.
Retours
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Retours
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Proxy pour une requête GET définie par un point de terminaison de service. La demande est autorisée à l’aide d’une source de données dans le point de terminaison de service. La réponse est filtrée à l’aide d’un sélecteur basé sur XPath/Json.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Paramètres
- binding
- DataSourceBinding
Décrit la source de données à extraire.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Paramètres
- endpointId
-
string
- project
-
string
Retours
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Paramètres
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Retours
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Partager le point de terminaison de service entre les projets
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Paramètres
- endpointProjectReferences
Détails de référence du projet cible
- endpointId
-
string
ID de point de terminaison du point de terminaison à partager
Retours
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Paramètres
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Retours
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
Mettre à jour le point de terminaison de service
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Paramètres
- endpoint
- ServiceEndpoint
Données mises à jour pour le point de terminaison
- endpointId
-
string
ID de point de terminaison du point de terminaison à mettre à jour
- operation
-
string
type d’opération
Retours
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Mettez à jour les points de terminaison de service.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Paramètres
- endpoints
Noms des points de terminaison de service à mettre à jour.
Retours
Promise<ServiceEndpoint[]>
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour