BuildService-Klasse

Vererbungshierarchie

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

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

Syntax

'Declaration
<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

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 die [BuildDefinition]-Objekte zum Server hinzu.Wenn das URI-Feld eingegeben wird, bevor sie zum Server gesendet wird, wird er ignoriert.Doppelte Builddefinitionen vorhanden sind möglicherweise nicht am selben Pfad.Daher wird eine Ausnahme ausgelöst werden, wenn dieser Fall erreicht wird.Das hinzugefügt sind für alle Definitionen transaktionale, damit fehlschlägt, wenn das hinzufügen, allen Fail hinzufügt.
Öffentliche Methode AddBuildQualities Fügt die Liste der Qualitäten dem Zielteamprojekt hinzu.Der Benutzer, der die add- ausgeführt wird, muss die Berechtigung "EditBuildStatus", um die Aktion auszuführen.
Öffentliche Methode CancelBuilds Löschenbuilder gerade in der Warteschlange, die entweder im hinausgeschobenen oder aktiven Zustand sind.Der Benutzer, der das Löschen ausgeführt wird, 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 verfügen, das auf die entspricht, die als der Arrayparameter übergeben werden.Definitionen, die noch Builds zugeordnet haben mit Symbolen enthalten, ob sie abgeschlossen oder in die Warteschlange gestellt werden und in den "aktiv", "wurde im Zustand" oder "InProgress", können nicht gelöscht werden.Die abhängigen Builds müssen gelöscht werden, 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" auf dem Teamprojekt.
Öffentliche Methode DeleteBuilds Löscht die Builds, die dem 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 Ablagespeicherortzugriffsprobleme 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.Es dient nur, das BuildService-webservice aktiv bleibt. Sie wird in regelmäßigen Abständen-jede 10 Minute-durch den TFSServerScheduler-Dienst bezeichnet.
Öffentliche Methode GetAffectedBuildDefinitions Bestimmt, das ggf. Builddefinitionen durch die bereitgestellten Serverelemente beeinflusst werden.
Öffentliche Methode GetBuildQualities Ruft die Buildqualität ab, die zum Zielteamprojekt vorhanden sind.Der Benutzer muss über die Berechtigung "GenericRead" auf dem Zielteamprojekt enthalten, damit die Buildqualität anzuzeigen.
Öffentliche Methode GetHashCode Fungiert als Hashfunktion für einen bestimmten Typ. (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 einen Index NULL in jeder Stelle verfügt, an der ein URI nicht gefunden wurde.
Öffentliche Methode QueryBuildDefinitionsByUri Abfragen für die Builddefinitionen einen Satz URI.Der Server gibt eine Definition für jedes gültige URIs im Array zurück.
Öffentliche Methode QueryBuildGroups Fragt den Server nach Elementen ab, die mit den [BuildItemSpec]-Eingabeobjekten übereinstimmen.Diese Methode verwendet werden, um Elemente mithilfe des Pfads zu ermitteln, wenn der URI unbekannt ist.
Öffentliche Methode QueryBuildQueue Fragt die Buildwarteschlange ab, die einen Satz von Spezifikation für Agents und Definitionen angegeben ist.
Öffentliche Methode QueryBuildQueueById Fragt die in der Warteschlange stehenden Builds nach ID abDie Ausgabeliste ist die gleiche Größe wie die Eingabeliste, die NULL Indizes entsprechend nicht vorhandenen Einträge verfügt.
Öffentliche Methode QueryBuilds Ein Array [BuildDetailSpec]-Objekte angegeben, gibt diese Internet-Methode eine 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 Abfragenbuilder durch URI anstelle von des Pfads mit bereitgestellten Optionen.Ein einzelnes [BuildQueryResult]-Objekt wird von der Abfrage, mit einer BuildDetail-Liste die dem Array der Eingabe URI zurückgegeben.Wenn eine bestimmte URI Builds nicht übereinstimmt, ist der entsprechende Index in der resultierenden BuildDetail-Liste NULL.Die Menge der Daten, die von der Abfrage zurückgegeben werden, wird mithilfe des Optionsparameters gesteuert.
Öffentliche Methode QueueBuild Versuche, Builds mithilfe der bereitgestellten Anforderungen in die Warteschlange zu verbinden.Wenn das Einreihen erfolgreich ist, wird eine Liste der in der Warteschlange enthaltenen Builds zurückgegeben.Das QueueId des in der Warteschlange enthaltenen Builds verwendet werden, um neuere Abfragen auf dem Element für die Abstimmung auszuführen.Wenn der Build ist, ist das einzige in der Warteschlange zum Zeitpunkt des Queuing und des Status auf "aktives." der Build beginnt sofort.
Öffentliche Methode StopBuilds Beendet in Bearbeitung befindliche Builds mit dem angegebenen URI.Wenn ein Build bereits abgeschlossen wurde, wird er ignoriert und einen Erfolg anzeigen.Der Benutzer, der diesen Aufruf ausführt, muss die AdministerBuild-Berechtigung für alle Teamprojekte verfügen, für das beendet 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 dem 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 und bedeutet, dass entweder alle oder keine Updates von ihnen Arbeit arbeiten.Das Ändern des hinausgeschobenen Flags eines Builds werden möglicherweise ihn gestartet werden.Daher wird die Eigenschaft des Objekts [Build][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