Freigeben über


BuildService-Klasse

Vererbungshierarchie

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

Namespace:  Microsoft.TeamFoundation.Build.Server.Compatibility
Assembly:  Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)

Syntax

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

Der BuildService-Typ macht die folgenden Member verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode BuildService

Zum Seitenanfang

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft Application Ruft das Anwendungsobjekt für die aktuelle HTTP-Anforderung ab. (Von WebService geerbt.)
Öffentliche Eigenschaft Container Ruft den Container für die Komponente ab. (Von MarshalByValueComponent geerbt.)
Öffentliche Eigenschaft Context Ruft HttpContext von ASP.NET für die aktuelle Anforderung ab, wodurch der gesamte HTTP-spezifische Kontext gekapselt wird, der durch den HTTP-Server zum Verarbeiten von Webanforderungen verwendet wird. (Von WebService geerbt.)
Öffentliche Eigenschaft DesignMode Ruft einen Wert ab, der angibt, ob sich die Komponente gegenwärtig im Entwurfsmodus befindet. (Von MarshalByValueComponent geerbt.)
Öffentliche Eigenschaft Server Ruft das HttpServerUtility für die aktuelle Anforderung ab. (Von WebService geerbt.)
Öffentliche Eigenschaft Session Ruft die HttpSessionState-Instanz für die aktuelle Anforderung ab. (Von WebService geerbt.)
Öffentliche Eigenschaft Site Ruft die Site der Komponente ab oder legt diese fest. (Von MarshalByValueComponent geerbt.)
Öffentliche Eigenschaft SoapVersion Ruft die Version des SOAP-Protokolls ab, mit dem die SOAP-Anforderung an den XML-Webdienst ausgeführt wird. (Von WebService geerbt.)
Öffentliche Eigenschaft User Ruft das User-Objekt des ASP.NET-Servers ab.Kann verwendet werden, um zu authentifizieren, ob ein Benutzer zum Ausführen der Anforderung berechtigt ist. (Von WebService geerbt.)

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode AddBuildAgents
Öffentliche Methode AddBuildDefinitions Fügt den BuildDefinition-Objekten zum Server hinzu.Wenn das URI-Feld eingegeben werden, bevor sie zum Server übermittelt wird, wird es ignoriert.Doppelte Builddefinitionen vorhanden sind möglicherweise nicht am selben Pfad.Daher wird eine Ausnahme ausgelöst werden, wenn dieser Fall auftritt.Das hinzugefügt ist über alle Definitionen transaktionale, sodass fehlschlägt, wenn von hinzufügen, alle Hinzufügen fehlschlägt.
Öffentliche Methode AddBuildQualities Fügt der Liste der Qualitäten das Zielteamprojekt hinzu.Der Benutzer, der die add- ausführt, muss die Berechtigung "EditBuildStatus" haben, um die Aktion auszuführen.
Öffentliche Methode CancelBuilds Löschen erstellt nur in der Warteschlange, das entweder im hinausgeschobenen oder aktiven Zustand sind.Der Benutzer, der die Löschoperation ausführt, muss die Verwaltungsbuildberechtigung auf dem Teamprojekt verfügen, um erfolgreich abzuschließen.
Öffentliche Methode DeleteBuildAgents
Öffentliche Methode DeleteBuildDefinitions Löscht Builddefinitionen vom Server, die URIs weisen, die denen entsprechen, die als der Arrayparameter übergeben werden.Definitionen, die immer noch Builds zugeordnet haben damit haben, ob sie abgeschlossen oder in die Warteschlange gestellt und in das "aktiv", "zurückgestellt wurde" oder Status "In Bearbeitung", können nicht gelöscht werden.Die abhängige Builds gelöscht werden müssen, bevor die Definition entfernt.
Öffentliche Methode DeleteBuildQualities Löscht die angegebene Buildqualität vom Zielteamprojekt.Der Benutzer, der diese Aktion ausführt, muss die Berechtigung "EditBuildStatus" im Teamprojekt.
Öffentliche Methode DeleteBuilds Löscht die Builds, die den angegebenen URIs entsprechen.Wenn ein bestimmter Build nicht vorhanden ist, wird er automatisch ignoriert.Wenn diese Methode keine Ausnahmen auslöst, kann davon ausgegangen werden, dass der Buildteil Lösch- o.k. gewechselt ist.Nichtfatale Fehler wie Testergebnislöschenfehler (außer Berechtigungsprobleme) und Ablageortzugriffsprobleme werden nur das Ereignisprotokoll und nicht den sollten Fehler protokolliert.
Öffentliche Methode Dispose Gibt alle vom MarshalByValueComponent verwendeten Ressourcen frei. (Von MarshalByValueComponent geerbt.)
Öffentliche Methode Equals Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist. (Von Object geerbt.)
Öffentliche Methode EvaluateSchedules Diese Methode ist wirkungslos nur.Ihr Zweck ist, den BuildService-Webdienst aktiv bleibt. Er wird in regelmäßigen Abständen-jede 10 Minute-durch den TFSServerScheduler-Dienst aufgerufen.
Öffentliche Methode GetAffectedBuildDefinitions Bestimmt, das ggf. Builddefinitionen durch die angebotenen Serverelemente beeinflusst werden.
Öffentliche Methode GetBuildQualities Ruft die Buildqualität ab, die für das Zielteamprojekt vorhanden sind.Der Benutzer muss die Berechtigung "GenericRead" auf das Zielteamprojekt haben, um die Buildqualität anzuzeigen.
Öffentliche Methode GetHashCode Fungiert als die Standardhashfunktion. (Von Object geerbt.)
Öffentliche Methode GetService Ruft die Implementierung von IServiceProvider ab. (Von MarshalByValueComponent geerbt.)
Öffentliche Methode GetType Ruft den Type der aktuellen Instanz ab. (Von Object geerbt.)
Öffentliche Methode ProcessChangeset
Öffentliche Methode QueryBuildAgentsByUri Fragt die Build-Agents ab, die eine Liste von URIs verwenden.Die Ausgabeliste ist die gleiche Größe wie die Eingabeliste, die NULL einen Index in jeder Stelle verfügt, an der ein URI nicht gefunden wurde.
Öffentliche Methode QueryBuildDefinitionsByUri Abfragen für die Builddefinitionen einen Satz URIs angegeben.Der Server gibt eine Definition für jeden gültigen URI im Array zurück.
Öffentliche Methode QueryBuildGroups Er fragt den Server für Elemente ab, die die Eingabe BuildItemSpec-Objekte übereinstimmen.Diese Methode kann verwendet werden, um Elemente mithilfe des Pfades zu erkennen, wenn der URI unbekannt ist.
Öffentliche Methode QueryBuildQueue Abfragen der Buildwarteschlange ab, die einen Satz Spezifikation für Agents und Definitionen zugewiesen wird.
Öffentliche Methode QueryBuildQueueById Abfragen in die Warteschlange gestellten Builds nach ID abDie Ausgabeliste ist die gleiche Größe wie die Eingabeliste, die Indizes UNGÜLTIGE entsprechend nicht vorhandenen Einträge verfügt.
Öffentliche Methode QueryBuilds Ein Array BuildDetailSpec-Objekte angegeben, gibt diese Webmethode einer Ergebnisliste von BuildQueryResult-Objekten die gleiche Größe wie das Eingabearray zurück.Wenn keine Übereinstimmungen gefunden wurden, hat das BuildQueryResult-Objekt gegenwärtig leere Listen.
Öffentliche Methode QueryBuildsByUri Abfragen erstellt durch URIs nicht durch Pfads mit bereitgestellten Optionen.Ein einzelnes BuildQueryResult-Objekt wird von der Abfrage, mit einer BuildDetail-Liste die dem Eingabe URI-Array zurückgegeben.Wenn ein bestimmter URI keine Builds entspricht, ist der zugehörige Index in der resultierenden BuildDetail-Liste ungültig.Die Menge von Daten, die von der Abfrage zurückgegeben werden, wird mithilfe des Optionsparameters gesteuert.
Öffentliche Methode QueueBuild Versucht, Builds mit der angegebenen Anforderungen in die Warteschlange zu verbinden.Wenn das in die Warteschlange stellen erfolgreich ist, wird eine Liste der in der Warteschlange enthaltenen Builds zurückgegeben.Das QueueId des in der Warteschlange enthaltenen Builds verwendet werden, um spätere Abfragen auf dem Element für Abruf auszuführen.Wenn der Build ist, wird das einzige in der Warteschlange zum Zeitpunkt des In die Queueing und des Status auf "aktiv festgelegt." der Build startet sofort.
Öffentliche Methode StopBuilds Beendet in Bearbeitung befindlichen Builds mit bereitgestellten URIs.Wenn ein Build bereits abgeschlossen wurde, wird es ignoriert und erfolgreich anzeigen.Der Benutzer, der den Aufruf ausführt, muss die AdministerBuild-Berechtigung allen Teamprojekten haben, für die Stopps gemacht werden.
Öffentliche Methode ToString Gibt einen String zurück, der den Namen dieser Component enthält, sofern vorhanden.Diese Methode sollte nicht überschrieben werden. (Von MarshalByValueComponent geerbt.)
Öffentliche Methode UpdateBuildAgents
Öffentliche Methode UpdateBuildDefinitions
Öffentliche Methode UpdateBuildInformation
Öffentliche Methode UpdateBuilds Updatebuilddetails mit bereitgestellten Informationen.Der Benutzer muss die AdministerBuild-Berechtigung auf das Teamprojekt verfügen, das den Build enthält, diese Aktion auszuführen.
Öffentliche Methode UpdateQueuedBuilds Aktualisierungen in die Warteschlange gestellte Builds mit bereitgestellten Informationen.Der Benutzer muss die AdministerBuild-Berechtigung auf dem Teamprojekt verfügen, das den Build in der Warteschlange enthält, diese Aktion auszuführen.Diese Methode ist alle oder nichts heißt, dass entweder alle Aktualisierungen oder keine Arbeit davon arbeiten.Das Ändern des hinausgeschobenen Flags eines Builds wird kann es gestartet werden.Daher wird die Buildeigenschaft des Objekts QueuedBuild festgelegt, wenn der Build gestartet wird.

Zum Seitenanfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis Disposed Fügt einen Ereignishandler hinzu, der das Disposed-Ereignis für die Komponente überwacht. (Von MarshalByValueComponent geerbt.)

Zum Seitenanfang

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Siehe auch

Referenz

Microsoft.TeamFoundation.Build.Server.Compatibility-Namespace