DevOpsOrchestrationToolIntegrationHandler – Scoped

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

Ein benutzerdefiniertes DevOps Tool ist ein Tool, das nicht in DevOpsintegriert ist. Eine Liste der Tools mit DevOps -Integrationen finden Sie unter .

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

Diese API wird im Namespace sn_devops ausgeführt. Weitere Informationen zu DevOpsfinden Sie unter DevOps.

DevOpsOrchestrationToolIntegrationHandler – getNativeIdForOrchestrationTask(Object payload)

Gibt den Wert des Parameters orchestrationTaskName aus der Nutzlast für den POST-Endpunkt /devops/tool/{capability} zurück.

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

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Nutzlast	Objekt	Nutzlast, die Daten aus dem benutzerdefinierten Tool enthält, das vom REST-Endpunkt POST /devops/tool/{capability}akzeptiert wird, wobei capability für die Orchestrationsteht.

Tabelle : 2. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Wert des Parameters orchestrationTaskName aus der Nutzlast.

In diesem Beispiel implementiert eine Skripteinbindung mit dem Namen DevOpsOrchestrationCustomToolIntegrationHandler die Methoden handleTool und getNativeIdForOrchestrationTask. Die Methode getNativeIdForOrchestrationTask ist implementiert, um den Wert des Parameters orchestrationTaskName aus der Nutzlast für POST /devops/tool/{capability} zurückzugeben.

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 in einer Skripteinbindung implementieren, bevor Sie DevOps - POST /devops/tool/{capability}aufrufen.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
toolName	Zeichenfolge	Name des Tools. Befindet sich im Feld Toolname in der Tabelle „DevOps-Tool-Integration“ [sn_devops_tool_integration].

Tabelle : 4. Ergebnisse

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

In diesem Beispiel implementiert eine Skripteinbindung mit dem Namen DevOpsOrchestrationCustomToolIntegrationHandler die Methoden handleTool und getNativeIdForOrchestrationTask. Die Methode handleTool wird implementiert, um zu überprüfen, ob der übergebene Name für das richtige Tool ist. Ersetzen Sie „sn_devops_custom_tool“ durch den 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' 

};