Partager via


BuildService, classe

Hiérarchie d'héritage

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Web.Services.WebService
      Microsoft.TeamFoundation.Framework.Server.Alm.WebServices.TeamFoundationWebService
        Microsoft.TeamFoundation.Build.Server.BuildWebServiceBase
          Microsoft.TeamFoundation.Build.Server.Compatibility.BuildService

Espace de noms :  Microsoft.TeamFoundation.Build.Server.Compatibility
Assembly :  Microsoft.TeamFoundation.Build.Server (dans Microsoft.TeamFoundation.Build.Server.dll)

Syntaxe

'Déclaration
<WebServiceAttribute(Namespace := "https://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03",  _
    Description := "Team Foundation Build web service")> _
<ClientServiceAttribute(ComponentName := "TeamBuild", RegistrationName := "Build",  _
    ServiceName := "BuildService", CollectionServiceIdentifier := "543cf133-319b-4c7b-800a-fafff734f291")> _
Public NotInheritable Class BuildService _
    Inherits BuildWebServiceBase
[WebServiceAttribute(Namespace = "https://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03", 
    Description = "Team Foundation Build web service")]
[ClientServiceAttribute(ComponentName = "TeamBuild", RegistrationName = "Build", 
    ServiceName = "BuildService", CollectionServiceIdentifier = "543cf133-319b-4c7b-800a-fafff734f291")]
public sealed class BuildService : BuildWebServiceBase

Le type BuildService expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique BuildService

Début

Propriétés

  Nom Description
Propriété publique Application Obtient l'objet Application de la requête HTTP en cours. (Hérité de WebService.)
Propriété publique Container Obtient le conteneur du composant. (Hérité de MarshalByValueComponent.)
Propriété publique Context Obtient HttpContext ASP.NET pour la demande en cours, qui encapsule tout le contexte spécifique à HTTP utilisé par le serveur HTTP pour traiter les demandes Web. (Hérité de WebService.)
Propriété publique DesignMode Obtient une valeur indiquant si le composant est actuellement en mode design. (Hérité de MarshalByValueComponent.)
Propriété publique Server Obtient le HttpServerUtility pour la demande en cours. (Hérité de WebService.)
Propriété publique Session Obtient l'instance HttpSessionState pour la demande en cours. (Hérité de WebService.)
Propriété publique Site Obtient ou définit le site du composant. (Hérité de MarshalByValueComponent.)
Propriété publique SoapVersion Obtient la version du protocole SOAP utilisée pour faire la demande SOAP au service Web XML. (Hérité de WebService.)
Propriété publique User Obtient l'objet User du serveur ASP.NET.Peut être utilisé pour déterminer par l'authentification si un utilisateur est autorisé à exécuter la demande. (Hérité de WebService.)

Début

Méthodes

  Nom Description
Méthode publique AddBuildAgents
Méthode publique AddBuildDefinitions Ajoute les objets d' [BuildDefinition] au serveur.Si le champ d'URI est entré avant d'être envoyée au serveur, il sera ignoré.Les définitions de build en double ne pas exister au même chemin d'accès.Par conséquent une exception peut être levée si ce cas est produit.L'ajout est transactionnel entre toutes les définitions de sorte que si vous ajoutez de échec, tous les ajoute l'échec.
Méthode publique AddBuildQualities Ajoute la liste des qualités au projet d'équipe cible.L'utilisateur exécutant l'ajout doit avoir l'autorisation de « EditBuildStatus » pour exécuter l'action.
Méthode publique CancelBuilds Annule les génère actuel dans la file d'attente qui ont l'état différé ou actif à plus tard.L'utilisateur exécutant l'annulation doit avoir l'autorisation de génération de gérer sur le projet d'équipe afin de se terminer avec succès.
Méthode publique DeleteBuildAgents
Méthode publique DeleteBuildDefinitions Supprime les définitions de build du serveur qui ont des URI identiques à celles qui sont passés comme paramètre de tableau.Les définitions qui ont toujours des builds ont associé à elles, qu'elles soient terminées ou mises en file d'attente et dans « actif », « réinitialiser ultérieurement », ou l'état « InProgress », ne peuvent pas être supprimées.Les builds dépendantes doivent être supprimées avant de supprimer la définition.
Méthode publique DeleteBuildQualities Supprime les qualités de build spécifiées du projet d'équipe cible.l'utilisateur effectuant cette action doit avoir l'autorisation de « EditBuildStatus » sur le projet d'équipe.
Méthode publique DeleteBuilds Supprime les builds qui correspondent aux URI donnés.Si une build donnée n'existe pas, elle est en mode silencieux ignorée.Si cette méthode ne lève pas d'exception, il peut supposer que la partie de génération de la suppression est allée correct.Les erreurs récupérables telles que les échecs de suppression de résultat de test (autre que des problèmes d'autorisation) et les problèmes d'accès de l'emplacement cible sont simplement enregistrées dans le journal des événements et des erreurs non prises en compte.
Méthode publique Dispose Libère toutes les ressources utilisées par MarshalByValueComponent. (Hérité de MarshalByValueComponent.)
Méthode publique Equals Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode publique EvaluateSchedules Cette méthode ne fait rien actuel.Son objectif est de conserver le webservice de BuildService actif. Il est appelé périodique-chaque 10 minute-par le service de TFSServerScheduler.
Méthode publique GetAffectedBuildDefinitions Détermine que, le cas échéant, des définitions de build sont affectées par les éléments du serveur fournis.
Méthode publique GetBuildQualities Récupère les qualités de build existant pour le projet d'équipe cible.L'utilisateur doit avoir l'autorisation de « GenericRead » sur le projet d'équipe cible pour afficher les qualités de build.
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
Méthode publique GetService Obtient l'implémenteur du IServiceProvider. (Hérité de MarshalByValueComponent.)
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique ProcessChangeset
Méthode publique QueryBuildAgentsByUri Interroge les agents de build à l'aide d'une liste d'URI.La liste de sortie est la même taille qu'liste d'entrée qui a un index NULL dans chaque position où l'URI est introuvable.
Méthode publique QueryBuildDefinitionsByUri Requêtes pour les définitions de build données un ensemble d'URI.Le serveur retourne une définition pour chaque URI valide dans le tableau.
Méthode publique QueryBuildGroups Interroge le serveur pour les éléments qui correspondent aux objets d'entrée d' [BuildItemSpec] .Cette méthode peut être utilisée pour découvrir des éléments au moyen de le tracé si l'URI est inconnu.
Méthode publique QueryBuildQueue Interroge la file d'attente de build donnée un ensemble de fonctionnalités pour les agents et des définitions.
Méthode publique QueryBuildQueueById Interroge les builds en file d'attente par ID.La liste de sortie est la même taille qu'liste d'entrée qui a des index nulle correspondant aux entrées inexistantes.
Méthode publique QueryBuilds Étant donné un tableau d'objets d' [BuildDetailSpec] , cette méthode Web retourne une liste de résultats d'objets d' [BuildQueryResult] la même taille qu'un tableau d'entrée.Si aucune correspondance n'est trouvée, l'objet d' [BuildQueryResult] sera simplement les listes vides.
Méthode publique QueryBuildsByUri Les requêtes génère par un URI au lieu de le tracé avec les options fournies.Un objet unique d' [BuildQueryResult] est retourné de la requête, avec une liste de BuildDetail la même longueur que l'URI d'entrée range.Si l'URI particulier ne correspond à aucune génération, l'index correspondant dans la liste résultante de BuildDetail est null.La quantité de données retournées par la requête est contrôlée par l'intermédiaire de le paramètre d'options.
Méthode publique QueueBuild Essaie de mettre des builds en file d'attente à l'aide de les demandes fournies.Si la mise en file d'attente est réussi, une liste des builds en file d'attente est retournée.Le QueueId de la génération en file d'attente peut être utilisé pour exécuter des requêtes ultérieures sur l'élément pour l'interrogation.Si la génération est la seule dans la file d'attente au moment de la mise en file d'attente et du mode a la valeur « actif ». la génération commence immédiatement.
Méthode publique StopBuilds Désactive les builds en cours avec les URI fournis.Si une génération a déjà été terminée, elle sera ignorée et est considéré comme un succès.L'utilisateur exécutant cet appel doit avoir l'autorisation d'AdministerBuild à tous les projets d'équipe pour lequel les abandons sont apportées.
Méthode publique ToString Retourne String contenant le nom du Component, s'il existe.Cette méthode ne doit pas être substituée. (Hérité de MarshalByValueComponent.)
Méthode publique UpdateBuildAgents
Méthode publique UpdateBuildDefinitions
Méthode publique UpdateBuildInformation
Méthode publique UpdateBuilds Détails de build de mises à jour avec les informations fournies.L'utilisateur doit avoir l'autorisation d'AdministerBuild sur le projet d'équipe qui contient la génération pour exécuter cette action.
Méthode publique UpdateQueuedBuilds Builds mises en file d'attente par mises à jour avec les informations fournies.L'utilisateur doit avoir l'autorisation d'AdministerBuild sur le projet d'équipe qui contient la génération en file d'attente pour exécuter cette action.Cette méthode est tout ou rien, ce qui signifie que toutes les mises à jour ou fonctionnent pas de leur travail.Modifier la balise réinitialisée à la suite d'une génération peut provoquer la devant être lancée.Par conséquent, la propriété d' [Build] de l'objet d' [QueuedBuild] est définie si la génération est lancée.

Début

Événements

  Nom Description
Événement public Disposed Ajoute un gestionnaire d'événements qui doit écouter l'événement Disposed pour le composant. (Hérité de MarshalByValueComponent.)

Début

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.TeamFoundation.Build.Server.Compatibility, espace de noms