DevOpsOrchestrationToolIntegrationHandler – Umfang

Die DevOpsOrchestrationToolIntegrationHandler API ermöglicht die Verarbeitung von Nutzlasten aus anwenderdefinierten DevOps Tools.

Ein anwenderdefinierter DevOps Das Tool ist ein Tool, das keine Integration mit aufweist DevOps. Für eine Liste der Tools, die haben DevOps Integrationen, siehe DevOps Change Velocity integrations.

Diese API ermöglicht die Verarbeitung von Nutzlasten, die vom REST-Endpunkt verwendet werden DevOps – POST /devops/Tool/{ability} . Sie müssen die Methoden dieser API in einer Skripteinbindung implementieren, bevor Sie aufrufen /devops/Tool/{Capability} VERÖFFENTLICHEN Endpunkt.

Diese API wird in ausgeführt sn_devops Namespace. Weitere Informationen zu DevOps finden Sie unter DevOps Config.

DevOpsOrchestrationToolIntegrationHandler – getNativeIdForOrchestrationTask(Objekt-Nutzlast)

Gibt den Wert von zurück orchestrationTaskNameParameter aus der Nutzlast für /devops/Tool/{Capability} VERÖFFENTLICHEN Endpunkt.

Sie müssen diese Methode in einer Skripteinbindung implementieren, bevor Sie den REST-Endpunkt aufrufen DevOps – POST /devops/Tool/{ability} .

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Nutzlast	Objekt	Nutzlast, die Daten aus dem anwenderdefinierten Tool enthält, das vom REST-Endpunkt akzeptiert wird /devops/Tool/{Capability} VERÖFFENTLICHEN , Wo capabilityIst Orchestration .

Tabelle : 2. Rückgaben

Typ	Beschreibung
Zeichenfolge	Wert von orchestrationTaskNameParameter aus der Nutzlast.

In diesem Beispiel eine Skripteinbindung mit dem Namen DevOpsOrchestrationCustomToolIntegrationHandler Implementiert die Methoden HandleTool Und GetNativeIdForOrchestrationTask . Die GetNativeIdForOrchestrationTask Die Methode ist implementiert, um den Wert von zurückzugeben orchestrationTaskNameParameter aus der Nutzlast für POST /devops/Tool/{ability}.

var DevOpsOrchestrationCustomToolIntegrationHandler = Class.create(); 

DevOpsOrchestrationCustomToolIntegrationHandler.prototype = {     

    handleTool: function(toolName) { 
        if (!gs.nil(toolName) && toolName == 'sn_devops_custom_tool') 
            return true; 
        return false; 
    }, 

    getNativeIdForOrchestrationTask: function(payload) { 
        return payload.orchestrationTaskName; 
    }, 

    type: 'DevOpsOrchestrationCustomToolIntegrationHandler' 

}; 

DevOpsOrchestrationToolIntegrationHandler – handleTool(String toolName)

Überprüft, ob dieser Handler für das angegebene Tool gültig ist.

Sie müssen diese Methode vor dem Aufruf in einer Skripteinbindung implementieren DevOps – POST /devops/Tool/{ability} .

Tabelle : 3. Parameter

Name	Typ	Beschreibung
toolName	Zeichenfolge	Name des Tools. Tabelle: Toolname Feld der Tabelle „DevOps-Toolintegration“ [sn_devops_Tool_Integration]

Tabelle : 4. Rückgaben

Typ	Beschreibung
Boolean	Kennzeichnung, die angibt, ob dieser Handler für das angegebene Tool gültig ist. Mögliche Werte: Wahr: Dieser Handler kann für das angegebene Tool verwendet werden. Falsch: Dieser Handler kann nicht für das angegebene Tool verwendet werden.

In diesem Beispiel eine Skripteinbindung mit dem Namen DevOpsOrchestrationCustomToolIntegrationHandler Implementiert die Methoden HandleTool Und GetNativeIdForOrchestrationTask . Die HandleTool Die Methode wird implementiert, um zu überprüfen, ob der übergebene Name für das richtige Tool gilt. Ersetzen „sn_devops_custom_Tool“ Mit dem Namen des Tools, das Sie verwenden.

var DevOpsOrchestrationCustomToolIntegrationHandler = Class.create(); 

DevOpsOrchestrationCustomToolIntegrationHandler.prototype = {     

  handleTool: function(toolName) { 
    if (!gs.nil(toolName) && toolName == 'sn_devops_custom_tool') 
      return true; 
    return false; 
  }, 

  getNativeIdForOrchestrationTask: function(payload) { 
    return payload.orchestrationTaskName; 
  }, 

  type: 'DevOpsOrchestrationCustomToolIntegrationHandler' 

};