Vorbereiten von Agent- und Power Platform-Connectordateien für die Zertifizierung

Nachdem Sie die Entwicklung des benutzerdefinierten Connectors abgeschlossen haben, müssen Sie die Dateien für die Zertifizierung vorbereiten. Führen Sie als bestätigter Herausgeber die folgenden Schritte aus, um die Dateien für die Zertifizierung vorzubereiten und die Connector- und Agent-fähigen Connectordateien zu generieren, die Sie an Microsoft übermitteln.

Schritt 1: Übermittlungsanforderungen für Connectors erfüllen

Um einen hohen Qualitäts- und Konsistenzstandard unter unseren zertifizierten Konnektoren aufrechtzuerhalten, enthält dieserAbschnitt eine Reihe von Anforderungen und Richtlinien, die Ihr benutzerdefinierter Konnektor für die Microsoft Zertifizierung einhalten muss.

Geben Sie Ihrem Konnektor einen Titel

Der Titel muss die folgenden Anforderungen erfüllen:

• Muss existieren und in englischer Sprache verfasst sein.
• Muss eindeutig sein und sich klar von jedem vorhandenen Verbindertitel unterscheiden.
• Sollte der Name Ihres Produktes oder Ihrer Organisation sein.
• Sollte den bestehenden Benennungsmustern für zertifizierte Steckverbinder folgen. Bei unabhängigen Publishern sollte der Name des Connectors dem Muster Connector Name (Independent Publisher) folgen.
• Darf nicht länger als 30 Zeichen sein.
• Darf nicht die Wörter API, Connector, Copilot Studio oder einen anderen Power Platform-Produktnamen enthalten (z. B. Power Apps).
• Darf nicht mit einem nicht alphanumerischen Zeichen enden, einschließlich Wagenrücklauf, neue Zeile oder Leerzeichen.

Beispiele

• Gute Verbindertitel: Azure Sentinel*, *Office 365 Outlook
• Schlechte Verbindertitel: Azure Sentinel's Power Apps Connector, Office 365 Outlook API

Schreiben Sie eine Beschreibung für Ihren Konnektor

Die Beschreibung muss die folgenden Bedingungen erfüllen:

• Stellen Sie sicher, dass Ihre Beschreibung den Marketplace-Richtlinien entspricht.
• Muss existieren und in englischer Sprache verfasst sein.
• Muss frei von grammatikalischen und Rechtschreibfehlern sein.
• Sollte den Hauptzweck und den Wert, den Ihr Konnektor bietet, prägnant beschreiben.
• Muss länger als 30 Zeichen sein und darf 500 Zeichen nicht überschreiten.
• Darf keinen der Copilot Studio- oder anderen Power Platform-Produktnamen enthalten (z. B. Power Apps).

Entwerfen Sie ein Symbol für Ihren Connector (gilt nur für verifizierte Herausgeber)

Dieser Abschnitt gilt nicht für unabhängige Herausgeber.

• Erstellen Sie ein Logo mit 1:1-Abmessungen in einem Bereich von 100 x 100 bis 230 × 230 Pixeln (keine abgerundeten Kanten).
• Verwenden Sie einen nicht transparenten, nicht weißen (#ffffff) Hintergrund und nicht Standardfarbe (#007ee5), die der angegebenen Hintergrundfarbe des Symbols entspricht.
• Stellen Sie sicher, dass das Symbol sich von allen anderen Symbolen für zertifizierte Konnektoren unterscheidet.
• Senden Sie das Logo im PNG-Format als <icon>.png.
• Stellen Sie die Logoabmessungen auf unter 70 % für die Höhe und Breite des Bildes mit einem einheitlichen Hintergrund ein.
• Stellen Sie sicher, dass die Markenfarbe eine gültige Hexadezimalfarbe ist und nicht Weiß (#ffffff) oder Standard (#007ee5) sein sollte.

Definieren Sie Zusammenfassungen und Beschreibungen von Vorgängen und Parametern

Die Zusammenfassungen und Beschreibungen müssen die folgenden Bedingungen erfüllen:

• Muss existieren und in englischer Sprache verfasst sein.
• Muss frei von grammatikalischen und Rechtschreibfehlern sein.
• Zusammenfassungen von Vorgängen und Parametern sollten Ausdrücke von 80 Zeichen oder weniger enthalten und nur alphanumerische Zeichen oder Klammern enthalten.
• Vorgangs- und Parameterbeschreibungen sollten vollständige, beschreibende Sätze sein, die mit Interpunktion enden.
• Darf keine Copilot Studio- oder andere Power Platform-Produktnamen enthalten (z. B. Power Apps).

Definieren Sie exakte Vorgangsantworten

Die Vorgangsantworten müssen die folgenden Bedingungen erfüllen:

• Definieren Sie Operationsantworten mit einem genauen Schema nur mit erwarteten Antworten.
• Verwenden Sie keine Standardantworten mit einer exakten Schemadefinition.
• Geben Sie gültige Antwortschemadefinitionen für alle Operationen im Swagger an.
• Leere Antwortschemata sind nicht zugelassen, außer in besonderen Fällen, in denen das Antwortschema dynamisch ist. Dies bedeutet, dass in der Ausgabe kein dynamischer Inhalt angezeigt wird und Ersteller JSON verwenden müssen, um die Antwort zu analysieren.
• Leere Vorgänge sind nicht zugelassen.
• Entfernen Sie leere Eigenschaften, sofern sie nicht erforderlich sind.

Überprüfen von Swagger-Eigenschaften

Die Eigenschaften müssen die folgenden Bedingungen erfüllen:

• Stellen Sie sicher, dass openapidefinition.json in einer korrekt formattierten JSON-Datei ist.
• Stellen Sie sicher, dass die Swagger-Definition dem OpenAPI Specification v2.0-Standard und dem erweiterten Standard der Connectors entspricht.

Verbindungsparameter überprüfen

Die Parameter müssen die folgenden Bedingungen erfüllen:

• Stellen Sie sicher, dass die Eigenschaft mit den entsprechenden Werten für uiDefinition (Anzeigename, Beschreibung) aktualisiert wird.

• Wenn Ihr Verbindungsparameter die Standardauthentifizierung verwendet, stellen Sie sicher, dass JSON wie im folgenden Beispiel richtig formatiert ist.

  {
    "username": {
      "type": "securestring",
      "uiDefinition": {
        "displayName": "YourUsernameLabel",
        "description": "The description of YourUsernameLabel for this api",
        "tooltip": "Provide the YourUsernameLabel tooltip text",
        "constraints": {
          "tabIndex": 2,
          "clearText": true,
          "required": "true"
          }
    }
  },
    "password": {
      "type": "securestring",
      "uiDefinition": {
        "displayName": "YourPasswordLabel",
        "description": "The description of YourPasswordLabel for this api",
        "tooltip": "Provide the YourPasswordLabel tooltip text",
        "constraints": {
          "tabIndex": 3,
          "clearText": false,
          "required": "true"
        }
      }
    }
  }
  

• Wenn Ihr Verbindungsparameter APIKey als Authentifizierung hat, stellen Sie sicher, dass JSON wie im folgenden Beispiel richtig formatiert ist.

  {
    "api_key": {
      "type": "securestring",
      "uiDefinition": {
        "displayName": "YourApiKeyParameterLabel",
        "tooltip": "Provide your YourApiKeyParameterLabel tooltip text",
        "constraints": {
          "tabIndex": 2,
          "clearText": false,
          "required": "true"
        }
      }
    }
  }
  

• Wenn Ihr Verbindungsparameter generisches OAuth als Authentifizierung aufweist, stellen Sie sicher, dass JSON korrekt formatiert ist, wie im folgenden Beispiel.

  {
    "token": {
      "type": "oAuthSetting",
      "oAuthSettings": {
        "identityProvider": "oauth2",
        "scopes": [
          "scope1"
        ],
        "redirectMode": "GlobalPerConnector",
        "customParameters": {
          "AuthorizationUrl": {
            "value": "https://contoso.com"
          },
          "TokenUrl": {
            "value": "https://contoso.com"
          },
          "RefreshUrl": {
            "value": "https://contoso.com"
          }
        },
        "clientId": "YourClientID"
      },
      "uiDefinition": null
    }
  }
  

• Wenn Ihr Verbindungsparameter einen OAuth2-Identitätsanbieter hat, stellen Sie sicher, dass der Identitätsanbieter aus der Liste der unterstützten OAuth2-Anbieter stammt. Hier ist ein Beispiel für einen GitHub OAuth2-Identitätsanbieter:

  {
    "token": {
      "type": "oAuthSetting",
      "oAuthSettings": {
        "identityProvider": "github",
        "scopes": [
          "scope1"
        ],
        "redirectMode": "GlobalPerConnector",
        "customParameters": {},
        "clientId": "YourClientId"
      },
      "uiDefinition": null
    }
  }
  

• Wenn Ihr Verbindungsparameter Microsoft Entra ID als Authentifizierung hat, stellen Sie sicher, dass JSON wie im folgenden Beispiel richtig formatiert ist.

  {
    "token": {
      "type": "oAuthSetting",
      "oAuthSettings": {
        "identityProvider": "aad",
        "scopes": [
          "scope1"
        ],
        "redirectMode": "GlobalPerConnector",
        "customParameters": {
          "LoginUri": {
            "value": "https://login.microsoftonline.com"
          },
          "TenantId": {
            "value": "common"
          },
          "ResourceUri": {
            "value": "resourceUri"
          },
          "EnableOnbehalfOfLogin": {
            "value": false
          }
        },
        "clientId": "AzureActiveDirectoryClientId"
      },
      "uiDefinition": null
    }
  }
  

Erstellen Sie hochwertige englische Sprachstrings

Connectors werden als Teil der Power Automate-Lokalisierung lokalisiert. Daher ist bei der Entwicklung eines Connectors die Qualität der englischsprachigen Zeichenfolgen der Schlüssel zur Übersetzungsqualität. Hier sind einige wichtige Bereiche, auf die Sie sich beim Erstellen der Werte der von Ihnen bereitgestellten Zeichenfolgen konzentrieren sollten.

• Führen Sie ein Rechtschreibprüfungsprogramm aus, um sicherzustellen, dass alle Zeichenfolgenwerte frei von Tippfehlern sind. Wenn eine unvollständige englische Zeichenfolge vorhanden ist, ist das Übersetzungsergebnis unvollständig oder im Kontext falsch.

• Stellen Sie sicher, dass sich der Satz in vollständiger Form befindet , d. h. er hat mindestens ein Thema und ein Prädikat. Wenn der Satz nicht vollständig ist, kann dies auch zu Übersetzungen von geringerer Qualität führen.

• Stellen Sie sicher, dass die Bedeutung des Satzes klar ist. Wenn die Bedeutung des Satzes mehrdeutig ist, kann dies auch zu schlechteren oder falschen Übersetzungen führen.

• Achten Sie darauf, dass Zusammenfassungen, x-ms-summaries und Beschreibungen grammatikalisch korrekt sind. Die Zusammenfassungen nicht kopieren und nicht einfügen. Wie sie im Produkt angezeigt werden, erfahren Sie unter Leitfaden für Connector-Zeichenfolgen.

• Vermeiden Sie nach Möglichkeit zusammengesetzte Laufzeitstrings. Verwenden Sie stattdessen vollständig gebildete Sätze. Verkettete Zeichenfolgen oder Sätze erschweren die Übersetzung oder können zu einer falschen Übersetzung führen.

• Stellen Sie sicher, dass die Abkürzungen groß geschrieben werden, um sie deutlich zu machen. Die Großschreibung verringert die Wahrscheinlichkeit, dass es mit einem typografischen Fehler verwechselt wird.

• Wenn Sie den Zeichenfolgen-Wert lokalisieren möchten, sollten Sie den CaMel-Formularzeichenwert korrigieren. Zeichenfolgen in CaMel-Form (z. B. minimizeHighways oder MinimizeHighways) werden normalerweise als nicht übersetzbar angesehen.

Schritt 2: Die Lösungsprüfung ausführen, um Ihren Konnektor zu überprüfen

Lösungsprüfung ist ein Mechanismus zur Durchführung statischer Analysen, um sicherzustellen, dass Ihr Konnektor den Microsoft-Zertifizierungsstandards entspricht. Fügen Sie Ihren Konnektor einer Lösung in Power Automate oder Power Apps hinzu, und befolgen Sie dann die Anweisungen unter Überprüfen eines benutzerdefinierten Konnektors mit Lösungsprüfung, um die Lösungsprüfung auszuführen.

Sehen Sie sich dieses Video an, um zu erfahren, wie Sie die Lösungsprüfung ausführen.

Schritt 3: Erfüllen der Übermittlungsanforderungen für Konnektoraktionen

Stellen Sie sicher, dass die Aktionen Ihres Connectors den folgenden Richtlinien entsprechen:

• Richtlinien für verantwortungsvolle KI beschreiben, welche Vorgaben alle agenten-fähigen Konnektoren befolgen müssen.
• 100.10 Unangemessener Inhalt hebt einen Abschnitt in den Nutzungsbedingungen des Microsoft Commercial Marketplace hervor, in dem die Standards beschrieben werden, nach denen alle Agent-fähigen Connectors konform sein müssen. Connector-Aktionen dürfen keine unangemessenen, schädlichen oder anstößigen KI-generierten Inhalte generieren, enthalten oder den Zugriff darauf ermöglichen.
• Verwenden Sie Connectors in Copilot Studio , um zu erfahren, wie Connectors Tools sind, die die Funktionalität von Microsoft Copilot Studio erweitern.

Schritt 4: Vorbereiten des Verbinders und verwandter Artefakte

Sie übermitteln eine Reihe von Dateien an Microsoft, bei der es sich um eine Lösungsgenerierung aus dem Maker-Portal oder Microsoft Copilot Studio handelt. Führen Sie die Schritte in diesem Abschnitt aus, um Ihre Dateien zu packen.

Verpacken Ihrer Verbindungsdateien

1. Erstellen Sie einen benutzerdefinierten Konnektor in einer Lösung.

2. Führen Sie die Lösungsprüfung aus für Ihre Connector-Lösung in Schritt 1.

3. Exportieren Sie die Connector-Lösung.

4. Erstellen Sie einen Test-Flow mit dem neu erstellten benutzerdefinierten Konnektor oder fügen Sie einen vorhandenen Flow in die Lösung ein.

5. Exportieren Sie die Flow-Lösung.

6. Erstellen Sie ein Paket mit den Lösungen aus den Schritten 3 und 5.

7. Erstellen Sie eine intro.md-Datei.

8. Erstellen Sie das endgültige Paket als ZIP-Datei im folgenden Format:

   

Anmerkung

Die Namen der Ordner und Dateien außerhalb der Lösung dienen nur zu Referenzzwecken. Sie können sie je nach Ihren Anforderungen auswählen. Bearbeiten Sie jedoch nicht die Dateien innerhalb der Lösung.

9. Laden Sie das Paket in einen Speicherblob hoch und generieren Sie eine SAS-URL. Stellen Sie sicher, dass Ihr SAS-URI mindestens 15 Tage lang gültig ist.
10. Senden Sie Ihr Paket an das Partner Center.

Sowohl verifizierte Herausgeber als auch unabhängige Herausgeber laden openapidefinition.json in ihren Artefakten herunter. Sie müssen die IconBrandColor in dieser Datei festlegen.

• Verifizierte Herausgeber: Legen Sie iconBrandColor auf die Farbe Ihrer Marke in der openapidefinition-Datei fest.
• Unabhängige Herausgeber: Setzen Sie iconBrandColor auf #da3b01 in der OpenAPI-Definitionsdatei.
  

Ein intro.md-Artefakt erstellen

Eine intro.md-Datei ist sowohl für unabhängige Herausgeber als auch für verifizierte Herausgeber erforderlich. Sie müssen eine intro.md-Datei erstellen, um die Features und Funktionen Ihres Connectors zu dokumentieren. Ein Beispiel für die einzuschließende Dokumentation finden Sie unter Readme.md-Beispiel. Um zu erfahren, wie Sie eine intro.md-Datei schreiben, sehen Sie sich andere intro.md-Dateien (auch bekannt als Readme.md-Dateien) in unserem GitHub-Repository an.

Wenn Sie ein unabhängiger Herausgeber sind und Ihr Connector OAuth verwendet, stellen Sie sicher, dass Sie Anweisungen für die Beschaffung von Anmeldeinformationen einfügen.

Schritt 5: Überprüfen der Struktur des Pakets

Das Paketüberprüfungsskript überprüft die Paketstruktur und hilft Ihnen, das Paket in einem akzeptablen Format für die Zertifizierung zu generieren. Laden Sie das Paket-Validator-Skript ConnectorPackageValidator.ps1herunter.

Führen Sie die folgenden Schritte aus, um das Paketüberprüfungsskript auszuführen:

1. Öffnen Sie Windows PowerShell im Admin-Modus.

   

2. Ändern Sie den Speicherort des Laufwerks durch Eingabe von cd /.

   Das folgende Beispiel nutzt C:\.

   

3. Wechseln Sie zu dem Pfad, in den Sie das Skript zur Paketprüfung heruntergeladen haben.

   Wenn der Pfad z. B. C:\Users\user01\Downloads lautet, geben Sie cd .\Users\user01\Downloads\ ein.

   

4. Legen Sie die Ausführungsrichtlinie auf „Uneingeschränkt“ fest, indem Sie den folgenden Befehl eingeben:

   Set-ExecutionPolicy -ExecutionPolicy Unrestricted

   

   Mit diesem Befehl kann die PowerShell ohne Einschränkung ausgeführt werden.

5. Bestätigen Sie Ihre Eingabe, indem Sie J eingeben, was für Ja steht.

6. Führen Sie die ConnectorPackageValidator.ps1aus, indem Sie den ZIP-Dateipfad eingeben, der das Connectorpaket enthält.

   Wie im folgenden Beispiel gezeigt, ist das erste Argument ein gültiger ZIP-Dateipfad, der das Paket enthält.

   

   Wenn die Paketstruktur korrekt ist, wird die folgende Erfolgsmeldung angezeigt:

   

   Wenn es ein Problem mit der Paketstruktur gibt, stellt das Skript Problemdetails bereit, indem es die Fehler in der Paketstruktur erkennt und hervorhebt.

   

Schritt 6: Reichen Sie den Connector zur Zertifizierung ein

Während des Übermittlungsprozesses geben Sie Ihren Connector als Open Source in unser Microsoft Power Platform Connectors-Repository.

1. (Für unabhängige Herausgeber) Um das Paket zur Zertifizierung an Microsoft zu senden, befolgen Sie die Anweisungen im Zertifizierungsprozess für unabhängige Herausgeber.

2. (Für verifizierte Herausgeber) Um das Paket zur Zertifizierung an Microsoft an das Partner Center zu senden, befolgen Sie die Anweisungen im Zertifizierungsprozess für verifizierte Herausgeber.

   Wenn Sie ein verifizierter Herausgeber sind, müssen Sie eine script.csx-Datei senden, wenn Sie angepassten Code verwenden.

   Wenn Ihr Connector OAuth hat, geben Sie die Client-ID und das Geheimnis im Partner Center an. Holen Sie sich außerdem den API-Namen aus Ihrer Connector-Übermittlungsanforderung, um Ihre App zu aktualisieren.

   Im Rahmen der Einreichung zertifiziert und/oder fügt Microsoft Ihren Connector hinzu. Wenn Sie Swagger-Fehler beheben müssen, gehen Sie zu Swagger Validator-Fehler beheben.

Checkliste vor dem Senden

Bevor Sie mit Senden Sie Ihren Konnektor für die Microsoft-Zertifizierung fortfahren, stellen Sie sicher, dass:

• Ihr benutzerdefinierter Connector erfüllt alle in Schritt 1 festgelegten Standards: Erfüllen der Einreichungsanforderungen für Connectoren und Schritt 3: Erfüllen der Einreichungsanforderungen für Connector-Aktionen.

• Bei keinem Vorgang fehlt eine Zusammenfassung, Beschreibung oder Sichtbarkeitsinformation.

• Sie haben Ihren benutzerdefinierten Connector getestet, um sicherzustellen, dass die Vorgänge erwartungsgemäß funktionieren (mindestens 10 erfolgreiche Anrufe pro Vorgang).

• Im Testabschnitt des Assistenten für angepasste Connectors werden keine Laufzeit- oder Schemavalidierungsfehler angezeigt.

Bei Fragen zur Zertifizierung

Sie müssen Microsoft Teams haben, um der Sprechstunde teilnehmen zu können. Wenn Sie Zugriff benötigen, finden Sie die entsprechenden Optionen unter Microsoft Teams.

Nehmen Sie an der Sprechstunde teil, die jeden Dienstag von 15:30 bis 16:30 Uhr UTC (koordinierte Weltzeit) stattfindet.

Nächster Schritt

• Zertifizierungsprozess für verifizierte Herausgeber
• Zertifizierungsprozess für unabhängige Herausgeber