Skapa en anpassad anslutningsapp med CLI

Kommandoradsverktyget paconn hjälper dig att skapa anpassade anslutningsprogram för Copilot Studio och Power Platform.

Anmärkning

Den här funktionen kanske inte har släppts ännu.
Information om hur du tar reda på versionsinformation finns i Vad är nytt och planerat för Common Data Model och dataintegrering.
Leveranstidslinjer och planerade funktioner kan ändras eller kanske inte lanseras. Mer information finns i Microsofts policy).

Installera Python och paconn

Installera Python 3.5 eller senare från [https://www.python.org/downloads](Nedladdningar för Python). Välj länken Ladda ned för valfri version av Python senare än Python 3.5. För Linux och macOS följer du lämplig länk på sidan. Du kan också installera Python med hjälp av valfri os-specifik pakethanterare.
Kör installationsprogrammet för att påbörja installationen och markera kryssrutan Lägg till Python X.X i PATH.
Kontrollera att installationssökvägen finns i PATH-variabeln genom att köra:

python --version
När Python har installerats installerar du paconn genom att köra:

pip install paconn

Om du får felmeddelanden om att åtkomst nekas, bör du överväga att använda --user alternativet eller köra kommandot som administratör (Windows).

Katalog för anpassad anslutning och filer

En anpassad anslutning består av två till fyra filer:

en Open API- eller Swagger-definition
En egenskapsfil för API
En valfri ikon för anslutning
en valfri C#-skriptfil

Du hittar filerna i en katalog som använder anslutnings-ID:t som namn.

Ibland innehåller den anpassade anslutningskatalogen en settings.json fil. Även om den här filen inte ingår i anslutningsdefinitionen kan du använda den som lagring för argument för CLI.

API-definitionsfil för Swagger

API-definitionsfilen beskriver API:et för det anpassade anslutningsprogrammet med hjälp av OpenAPI-specifikationen. Den här specifikationen kallas även Swagger-filen. Mer information om hur en API-definitionsfil hjälper dig att skapa en anpassad anslutning finns i Skapa en anpassad anslutning från en OpenAPI-definition. Läs även självstudien i artikeln Utöka en OpenAPI-definition för en anpassad anslutning.

API-egenskapsfil

API-egenskapsfilen innehåller egenskaper för den anpassade anslutningen som inte ingår i API-definitionen. Den innehåller information som varumärkesfärg och autentiseringsinformation. En typisk API-egenskapsfil ser ut som det här exemplet:

{
  "properties": {
    "capabilities": [],
    "connectionParameters": {
      "api_key": {
        "type": "securestring",
        "uiDefinition": {
          "constraints": {
            "clearText": false,
            "required": "true",
            "tabIndex": 2
          },
          "description": "The KEY for this API",
          "displayName": "KEY",
          "tooltip": "Provide your KEY"
        }
      }
    },
    "iconBrandColor": "#007EE6",
    "scriptOperations": [
        "getCall",
        "postCall",
        "putCall"
    ],
    "policyTemplateInstances": [
      {
        "title": "MyPolicy",
        "templateId": "setqueryparameter",
        "parameters": {
            "x-ms-apimTemplateParameter.name": "queryParameterName",
            "x-ms-apimTemplateParameter.value": "queryParameterValue",
            "x-ms-apimTemplateParameter.existsAction": "override"
        }
      }
    ]    
  }
}

Här är mer information om varje attribut:

properties: Behållaren för informationen.
connectionParameters: Definierar anslutningsparametern för tjänsten.
iconBrandColor: Ikonens varumärkesfärg i HTML hexadecimal kod för den anpassade kopplingen.
scriptOperations: En lista över de åtgärder som körs av skriptfilen. En tom scriptOperations lista anger att alla åtgärder körs med skriptfilen.
capabilities: Beskrivning av anslutningsprogrammets funktioner, till exempel molnbaserad och lokal gateway.
policyTemplateInstances: En valfri lista över principmallinstanser och värden som det anpassade anslutningsprogrammet använder.

ikonfil

Ikonfilen är en liten bild som representerar ikonen för det anpassade anslutningsprogrammet.

Skriptfil

CSX-skriptfilen (Visual C# Script) distribueras för det anpassade anslutningsprogrammet och körs för varje anrop till en delmängd av anslutningsprogrammets operationer.

Inställningsfil

I stället för att ange argumenten på kommandoraden använder du en settings.json fil för att ange dem. En typisk settings.json fil ser ut som i det här exemplet:

{
  "connectorId": "CONNECTOR-ID",
  "environment": "ENVIRONMENT-GUID",
  "apiProperties": "apiProperties.json",
  "apiDefinition": "apiDefinition.swagger.json",
  "icon": "icon.png",
  "script": "script.csx",
  "powerAppsApiVersion": "2016-11-01",
  "powerAppsUrl": "https://api.powerapps.com"
}

Dessa objekt finns i inställningsfilen. Om ett alternativ saknas men krävs frågar konsolen efter den information som saknas.

connectorId: Anslutningens ID-sträng för den anpassade anslutningen. Ladda ned- och uppdateringsåtgärder kräver parametern anslutnings-ID, medan åtgärderna för att skapa och verifiera inte gör det. Kommandot create skapar en ny anpassad anslutning med ett nytt ID. Om du behöver uppdatera en befintlig anpassad anslutning med hjälp av samma inställningsfil kontrollerar du att du uppdaterar inställningsfilen med det nya anslutnings-ID:t från skapandeåtgärden.
environment: Miljö-ID-strängen för det anpassade anslutningsprogrammet. Alla åtgärder kräver den här parametern, förutom valideringsåtgärden.
apiProperties: Sökvägen till API-egenskapsfilen. Skapa- och uppdateringsåtgärder kräver API-egenskapsfilen. När det här alternativet finns under nedladdningen laddas filen ner på den angivna platsen. I annat fall sparas filen som apiProperties.json.
apiDefinition: Sökvägen till Swagger-filen. Åtgärderna för att skapa, uppdatera och validera kräver API-definitionsfilen. När det här alternativet finns under nedladdningen laddas filen ned till sin plats. I annat fall sparas filen som apiDefinition.swagger.json.
icon: Sökvägen till den valfria ikonfilen. Om det inte finns någon specifikation för den här parametern använder åtgärderna skapa och uppdatera standardikonen. När det här alternativet finns under nedladdningen laddas filen ned till den angivna platsen. I annat fall sparas filen som icon.png.
script: Sökvägen till den valfria skriptfilen. Operationerna för att skapa och uppdatera använder endast värdet inom den angivna parametern. När det här alternativet finns under nedladdningen laddas filen ner till sin plats; I annat fall sparas filen som script.csx.
powerAppsUrl: API-URL:en för Power Apps. Den här parametern är valfri och är som standard inställd på https://api.powerapps.com.
powerAppsApiVersion: Den API-version som ska användas för Power Apps. Den här parametern är valfri och är som standard inställd på 2016-11-01.

Åtgärder på kommandoraden

Logga in på Power Platform genom att köra:

paconn login

Med det här kommandot uppmanas du att logga in med autentiseringsprocessen för enhetskod. Följ uppmaningen för autentisering. Det här kommandot stöder inte autentisering med tjänstens huvudnamnidentitet.

Logga ut

Logga ut genom att köra:

paconn logout

Ladda ned anpassade anslutningsfiler

Ladda alltid ned anslutningsfilerna till en underkatalog med anslutningens ID som katalognamn. När du anger en målkatalog blir den här katalogen den överordnade katalogen för den nya underkatalogen. Om du inte anger en målkatalog skapas underkatalogen i den aktuella katalogen. Förutom de tre anslutningsfilerna skapar nedladdningsåtgärden en fjärde fil med namnet settings.json som innehåller de parametrar som används för att ladda ned filerna.

Ladda ned filerna för det anpassade anslutningsprogrammet genom att köra:

paconn download

eller

paconn download -e [Power Platform Environment GUID] -c [Connector ID]

paconn download -s [Path to settings.json]

Om du inte anger miljö- eller anslutnings-ID uppmanas du att ange de argument som saknas. Om nedladdningen lyckas matar kommandot ut nedladdningsplatsen för anslutningsprogrammet.

Du kan också ange alla argument med hjälp av en settings.json fil.

Arguments
   --cid -c       : The custom connector ID.
   --dest -d      : Destination directory.
   --env -e       : Power Platform environment GUID.
   --overwrite -w : Overwrite all the existing connector and settings files.
   --pau -u       : Power Platform URL.
   --pav -v       : Power Platform API version.
   --settings -s  : A settings file containing required parameters.
                    When a settings file is specified some command 
                    line parameters are ignored.

Skapa ett nytt anpassat anslutningsprogram

Du kan skapa en ny anpassad anslutning från kopplingsfilerna genom att köra åtgärden create. Skapa en anslutning genom att köra:

paconn create --api-prop [Path to apiProperties.json] --api-def [Path to apiDefinition.swagger.json]

eller

paconn create -e [Power Platform Environment GUID] --api-prop [Path to apiProperties.json] --api-def [Path to apiDefinition.swagger.json] --icon [Path to icon.png] --secret [The OAuth2 client secret for the connector]

paconn create -s [Path to settings.json] --secret [The OAuth2 client secret for the connector]

När du inte anger miljön uppmanar kommandot dig att ange den. Du måste dock ange API-definitionen och API-egenskapsfilen som en del av kommandoradsargumentet eller en inställningsfil. Ange OAuth2-hemligheten för en anslutning med hjälp av OAuth2. Kommandot skriver ut anslutnings-ID:t för det nyligen skapade anpassade anslutningsprogrammet när den har slutförts. Om du använder en settings.json fil för kommandot create kontrollerar du att du uppdaterar den med det nya anslutnings-ID:t innan du uppdaterar den nyligen skapade anslutningen.

Arguments
   --api-def     : Location for the Open API definition JSON document.
   --api-prop    : Location for the API properties JSON document.
   --env -e      : Power Platform environment GUID.
   --icon        : Location for the icon file.
   --script -x   : Location for the script file.
   --pau -u      : Power Platform URL.
   --pav -v      : Power Platform API version.
   --secret -r   : The OAuth2 client secret for the connector.
   --settings -s : A settings file containing required parameters.
                   When a settings file is specified some command 
                   line parameters are ignored.

Uppdatera ett befintligt anpassat anslutningsprogram

Precis som med åtgärden create kan du uppdatera en befintlig anpassad anslutning med hjälp av åtgärden update. Uppdatera ett anslutningsprogram genom att köra:

paconn update --api-prop [Path to apiProperties.json] --api-def [Path to apiDefinition.swagger.json]

eller

paconn update -e [Power Platform Environment GUID] -c [Connector ID] --api-prop [Path to apiProperties.json] --api-def [Path to apiDefinition.swagger.json] --icon [Path to icon.png] --secret [The OAuth2 client secret for the connector]

eller

paconn update -s [Path to settings.json] --secret [The OAuth2 client secret for the connector]

När du inte anger miljö- eller anslutnings-ID uppmanar kommandot dig att ange argumenten som saknas. Du måste dock ange API-definitionen och API-egenskapsfilen som en del av kommandoradsargumenten eller i en inställningsfil. Ange OAuth2-hemligheten för ett anslutningsprogram med hjälp av OAuth2. Kommandot skriver ut det uppdaterade anslutnings-ID:t vid lyckad slutföring. Om du använder en settings.json fil för uppdateringskommandot kontrollerar du att du anger rätt miljö- och anslutnings-ID.

Arguments
   --api-def     : Location for the Open API definition JSON document.
   --api-prop    : Location for the API properties JSON document.
   --cid -c      : The custom connector ID.
   --env -e      : Power Platform environment GUID.
   --icon        : Location for the icon file.
   --script -x   : Location for the script file.
   --pau -u      : Power Platform URL.
   --pav -v      : Power Platform API version.
   --secret -r   : The OAuth2 client secret for the connector.
   --settings -s : A settings file containing required parameters.
                   When a settings file is specified some command 
                   line parameters are ignored.

Verifiera en Swagger JSON-fil

Valideringsåtgärden tar en swagger-fil och verifierar om den följer alla rekommenderade regler. Validera en swagger-fil genom att köra:

paconn validate --api-def [Path to apiDefinition.swagger.json]

paconn validate -s [Path to settings.json]

Kommandot skriver ut fel-, varnings- eller meddelande om att åtgärden lyckades beroende på resultatet av valideringen.

Arguments
   --api-def     : Location for the Open API definition JSON document.
   --pau -u      : Power Platform URL.
   --pav -v      : Power Platform API version.
   --settings -s : A settings file containing required parameters.
                   When a settings file is specified some command 
                   line parameters are ignored.

Bästa praxis

Ladda ned alla anpassade anslutningar och använd Git eller något annat källkontrollsystem för att spara filerna. Om du har en felaktig uppdatering distribuerar du om anslutningen genom att köra uppdateringskommandot på nytt med rätt uppsättning filer från källkontrollsystemet.

Testa det anpassade anslutningsprogrammet och inställningsfilen i en testmiljö innan du distribuerar i produktionsmiljön. Kontrollera alltid att miljö- och anslutnings-ID är korrekta.

Begränsningar

paconn CLI är begränsat till att skapa, uppdatera och ladda ned en anpassad anslutning i miljöer för Copilot Studio, Power Automate och Power Apps. När du inte anger en miljö har du bara möjlighet att välja en Power Automate miljö. För ett icke-anpassat anslutningsprogram returneras inte Swagger-filen.

Anmärkning

egenskapen stackOwner och API-egenskapsfilen

För närvarande finns det en begränsning som hindrar dig från att uppdatera anslutningsappens artefakter i din miljö med hjälp av Paconn när stackOwner egenskapen finns i API-egenskapsfilen. Skapa två versioner av dina anslutningsartefakter som en tillfällig lösning:

Skapa en version som innehåller stackOwner egenskapen och skicka in den för certifiering.
Skapa en andra version som utelämnar stackOwner så att du kan göra uppdateringar i din egen miljö.

Vi arbetar med att ta bort begränsningen och kommer att uppdatera det här avsnittet när det är klart.

Rapportera problem och feedback

Om du stöter på buggar med verktyget kan du rapportera ett ärende i avsnittet Issues på vår GitHub-lagringsplats.

Om du tror att du har hittat en säkerhetsrisk som uppfyller Microsoft definition av en säkerhetsrisk skickar du en rapport till MSRC. Mer information finns i MSRC:s vanliga frågor om rapportering.

Ge feedback

Vi uppskattar feedback på problem med vår anslutningsplattform eller nya funktioner. Om du vill ge feedback går du till Skicka problem eller få hjälp med anslutningsprogram och väljer din feedbacktyp.

Uppdaterades senast 2026-10-31

Skapa en anpassad anslutningsapp med CLI

Installera Python och paconn

Katalog för anpassad anslutning och filer

API-definitionsfil för Swagger

API-egenskapsfil

ikonfil

Skriptfil

Inställningsfil

Åtgärder på kommandoraden

Logga in

Logga ut

Ladda ned anpassade anslutningsfiler

Skapa ett nytt anpassat anslutningsprogram

Uppdatera ett befintligt anpassat anslutningsprogram

Verifiera en Swagger JSON-fil

Bästa praxis

Begränsningar

Rapportera problem och feedback

Ge feedback

Ytterligare resurser