diff --git a/README-localized/README-es-es.md b/README-localized/README-es-es.md new file mode 100644 index 0000000..7115576 --- /dev/null +++ b/README-localized/README-es-es.md @@ -0,0 +1,139 @@ +--- +page_type: sample +products: +- office-outlook +- office-onedrive +- ms-graph +languages: +- csharp +description: "Un bot de ejemplo que usa tarjetas adaptables y el SDK de .NET Graph para enviar mensajes que requieren acción y que solicitan aprobación para publicar archivos en OneDrive." +extensions: + contentType: samples + technologies: + - Microsoft Graph + - Microsoft Bot Framework + services: + - Outlook + - OneDrive + createdDate: 4/23/2018 12:12:07 PM +--- +# Ejemplo de bot de aprobación + +## Ejecución local + +Siga los pasos que se indican a continuación para habilitar la ejecución del bot de forma local para la depuración. + +### Requisitos previos + +- [ngrok](https://ngrok.com/) +- [Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases) +- [Azure Cosmos DB Emulator](https://docs.microsoft.com/es-es/azure/cosmos-db/local-emulator) +- Visual Studio 2017 + +### Registrar la aplicación + +1. Abra el explorador y vaya al [Centro de administración de Azure Active Directory](https://aad.portal.azure.com). Inicie sesión con **una cuenta profesional o educativa**. + +1. Seleccione **Azure Active Directory** en el panel de navegación izquierdo y, después, seleccione **Registros de aplicaciones (versión preliminar)** en **Administrar**. + + ![Una captura de pantalla de los registros de la aplicación ](readme-images/aad-portal-app-registrations.png) + +1. Seleccione **Nuevo registro**. En la página **Registrar una aplicación**, establezca los valores siguientes. + + - Establezca un **Nombre** de preferencia; por ejemplo, `Bot de aprobación`. + - Establezca los **Tipos de cuenta compatibles** en **Cuentas de cualquier directorio organizativo**. + - En **URI de redirección**, establezca la primera lista desplegable en `Web` y el valor en `http://localhost:3979/callback`. + + ![Captura de pantalla de la página Registrar una aplicación](readme-images/aad-register-an-app.PNG) + +1. Haga clic en **Registrar**. En la página de **Bot de aprobación**, copie el valor de **Id. de aplicación (cliente)** y guárdelo, lo necesitará en el paso siguiente. + + ![Captura de pantalla del Id. de aplicación del nuevo registro](readme-images/aad-application-id.PNG) + +1. Seleccione **Certificados y secretos** en **Administrar**. Seleccione el botón **Nuevo secreto de cliente**. Escriba un valor en **Descripción** y seleccione una de las opciones de **Expirar** y luego seleccione **Agregar**. + + ![Captura de pantalla del diálogo Agregar un cliente secreto](readme-images/aad-new-client-secret.png) + +1. Copie el valor del secreto del cliente antes de salir de esta página. Lo necesitará en el siguiente paso. + + > [¡IMPORTANTE!] + > El secreto del cliente no volverá a ser mostrado, asegúrese de copiarlo en este momento. + + ![Captura de pantalla del nuevo secreto de cliente agregado](readme-images/aad-copy-client-secret.png) + +### Configurar el proxy ngrok + +Debe exponer un punto de conexión HTTPS público para recibir las notificaciones desde Bot Framework Emulator. Mientras realiza las pruebas, puede usar ngrok para permitir temporalmente que los mensajes de Bot Framework Emulator establezcan un túnel hacia un puerto de *localhost* en su computadora. + +Puede usar la interfaz web de ngrok ([http://127.0.0.1:4040](http://127.0.0.1:4040)) para inspeccionar el tráfico HTTP que pasa por el túnel. Para obtener más información sobre el uso de ngrok, visite el [sitio web de ngrok](https://ngrok.com/). + + +1. [Descargue ngrok](https://ngrok.com/download) para Windows. + +1. Descomprima el paquete y ejecute ngrok.exe. + +1. En la consola de ngrok, ejecute el siguiente comando: + + ```Shell + ngrok http 3979 --host-header=localhost:3979 + ``` + + ![Comando de ejemplo para ejecutar en la consola de ngrok](readme-images/ngrok1.PNG) + +1. Copie la dirección URL HTTPS que se muestra en la consola. Esto se usará para configurar la `NgrokRootUrl` en el ejemplo. + + ![La dirección URL HTTPS de reenvío en la consola de ngrok](readme-images/ngrok2.PNG) + + > **Nota:** Mantenga la consola abierta mientras realiza las pruebas. Si la cierra, el túnel también se cerrará y tendrá que generar una nueva dirección URL y actualizar el ejemplo. + +### Configurar y ejecutar el ejemplo + +1. Clone el repositorio de forma local. +1. Haga una copia del archivo **./ApprovalBot/PrivateSettings.example.config** en el mismo directorio y asigne a la copia el nombre `PrivateSettings.config`. +1. Abra **ApprovalBot.sln** en Visual Studio y luego abra el archivo **PrivateSettings.config**. + +1. Configure el valor de `MicrosoftAppId` con el Id. de aplicación (cliente) generado en el paso anterior y configure el valor de `MicrosoftAppPassword` con el secreto que generado posteriormente. + +1. Pegue el valor de la dirección URL HTTPS de ngrok copiado del paso anterior en el valor de `NgrokRootUrl` en **PrivateSettings.config** y guarde los cambios. + + > **IMPORTANTE**: Deje ngrok en ejecución mientras ejecuta el ejemplo. Si detiene ngrok y lo reinicia, la dirección URL de reenvío cambiará y tendrá que actualizar el valor de `NgrokRootUrl`. + +1. Inicie Azure Cosmos DB Emulator. Debe estar en ejecución antes de iniciar el ejemplo. + +1. Presione F5 para depurar el ejemplo. + +1. Ejecute Bot Framework Emulator. En la parte superior, donde dice **Enter your endpoint URL**, escriba `https://localhost:3979/api/messages`. + +1. Se le pedirá el Id. de aplicación y la contraseña. Escriba el Id. de aplicación y el secreto, y deje **Locale** en blanco. + + ![](readme-images/configure-emulator.PNG) + +1. Haga clic en **Connect**. + +1. Envíe `hola` para confirmar la conexión. + + ![](readme-images/hello-bot.PNG) + +## Limitaciones al ejecutar de forma local + +Cuando se ejecuta el ejemplo de forma local, el correo electrónico de solicitud de aprobación que se envía es un poco diferente. Debido a que no se ejecuta en un dominio registrado y confirmado, se envía el mensaje a y desde la misma cuenta. Esto significa que, cuando llegue al punto en el que solicita la aprobación, debe incluirse a usted mismo en la lista de aprobadores. + +Puede incluir otros aprobadores, pero el mensaje que reciben no mostrará la tarjeta adaptable. Inicie sesión en su propio buzón con Outlook para probar la tarjeta adaptable. + +## Contribuciones + +Este proyecto recibe las contribuciones y las sugerencias. +La mayoría de las contribuciones requiere que acepte un Contrato de Licencia de Colaborador (CLA) donde declara que tiene el derecho, y realmente lo tiene, de otorgarnos los derechos para usar su contribución. +Para obtener más información, visite https://cla.microsoft.com. + +Cuando envíe una solicitud de incorporación de cambios, un bot de CLA determinará automáticamente si necesita proporcionar un CLA y agregar el PR correctamente (por ejemplo, etiqueta, comentario). +Siga las instrucciones proporcionadas por el bot. +Solo debe hacerlo una vez en todos los repositorios que usen nuestro CLA. + +Este proyecto ha adoptado el [Código de conducta de código abierto de Microsoft](https://opensource.microsoft.com/codeofconduct/). +Para obtener más información, vea [Preguntas frecuentes sobre el código de conducta](https://opensource.microsoft.com/codeofconduct/faq/) +o póngase en contacto con [opencode@microsoft.com](mailto:opencode@microsoft.com) si tiene otras preguntas o comentarios. + +## Copyright + +Copyright (c) 2019 Microsoft. Todos los derechos reservados. diff --git a/README-localized/README-fr-fr.md b/README-localized/README-fr-fr.md new file mode 100644 index 0000000..47d4aed --- /dev/null +++ b/README-localized/README-fr-fr.md @@ -0,0 +1,139 @@ +--- +page_type: sample +products: +- office-outlook +- office-onedrive +- ms-graph +languages: +- csharp +description: « Un exemple de robot qui utilise des cartes adaptatives et le kit de développement logiciel (SDK) .NET Graph pour envoyer des messages actionnables demandant l’approbation de publier des fichiers sur OneDrive. » +extensions: + contentType: samples + technologies: + - Microsoft Graph + - Microsoft Bot Framework + services: + - Outlook + - OneDrive + createdDate: 4/23/2018 12:12:07 PM +--- +# Exemple de Robot d’approbation + +## Exécution locale + +Effectuez ces étapes pour activer l’exécution locale du robot pour le débogage. + +### Conditions préalables + +- [ngrok](https://ngrok.com/) +- [Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases) +- [Émulateur Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) +- Visual Studio 2017 + +### Inscrire l’application + +1. Ouvrez un navigateur et accédez au [Centre d’administration Azure Active Directory](https://aad.portal.azure.com). Connectez-vous en utilisant un **compte professionnel ou scolaire**. + +1. Sélectionnez **Azure Active Directory** dans le volet de navigation gauche, puis sélectionnez **Inscriptions d’applications (préversion)** sous **Gérer**. + + ![Capture d’écran des inscriptions d’applications ](readme-images/aad-portal-app-registrations.png) + +1. Sélectionnez **Nouvelle inscription**. Sur la page **Inscrire une application**, définissez les valeurs comme suit : + + - Donnez un **Nom** favori, par ex. `Robot d’approbation`. + - Définissez **Types de comptes pris en charge** sur **Comptes figurant dans un annuaire organisationnel**. + - Sous **URI de redirection**, définissez la première liste déroulante à `Web` et la valeur sur `http://localhost:3979/callback`. + + ![Capture d’écran de la page Inscrire une application](readme-images/aad-register-an-app.PNG) + +1. Choisissez **Inscrire**. Sur la page **Robot d’approbation**, copiez la valeur de l’**ID (client) d’application** et enregistrez-la, elle sera utilisée à l’étape suivante. + + ![Une capture d’écran de l’ID d’application de la nouvelle inscription d'application](readme-images/aad-application-id.PNG) + +1. Sélectionnez **Certificats et secrets** sous **Gérer**. Sélectionnez le bouton **Nouvelle clé secrète client**. Entrez une valeur dans la **Description**, sélectionnez l'une des options pour **Expire le**, puis choisissez **Ajouter**. + + ![Une capture d’écran de la boîte de dialogue Ajouter une clé secrète client](readme-images/aad-new-client-secret.png) + +1. Copiez la valeur due la clé secrète client avant de quitter cette page. Vous en aurez besoin à l’étape suivante. + + > [!IMPORTANT] + > Cette clé secrète client n’apparaîtra plus, aussi veillez à la copier maintenant. + + ![Une capture d’écran de la clé secrète client nouvellement ajoutée](readme-images/aad-copy-client-secret.png) + +### Configurer le proxy ngrok + +Vous devez exposer un point de terminaison public HTTPs pour recevoir des notifications de Bot Framework Emulator. Pendant le test, vous pouvez utiliser ngrok pour autoriser temporairement les messages de Bot Framework Emulator à passer par un tunnel vers un port *localhost* sur votre ordinateur. + +Vous pouvez utiliser l’interface web ngrok ([http://127.0.0.1:4040](http://127.0.0.1:4040)) pour inspecter le trafic HTTP qui traverse le tunnel. Pour en savoir plus sur l’utilisation de ngrok, consultez le [site web ngrok](https://ngrok.com/). + + +1. [Télécharger ngrok](https://ngrok.com/download) pour Windows. + +1. Décompressez le paquet et exécutez ngrok.exe. + +1. Exécutez la ligne de commande suivante dans la console ngrok : + + ```Shell + ngrok http 3979 --host-header=localhost:3979 + ``` + + ![Exemple de commande à exécuter dans la console ngrok](readme-images/ngrok1.PNG) + +1. Copiez l’URL HTTPs affichée dans la console. Vous l’utiliserez pour configurer `NgrokRootUrl` dans l’exemple. + + ![L’URL HTTPs de transfert dans la console ngrok](readme-images/ngrok2.PNG) + + > **Remarque :** Gardez la console ouverte pendant le test. Si vous la fermez, le tunnel se ferme également et vous devrez générer une nouvelle URL et mettre à jour l’exemple. + +### Configurer et exécuter l’exemple + +1. Cloner le référentiel localement. +1. Effectuez une copie du fichier ./ApprovalBot/PrivateSettings.example.config dans le même répertoire, puis nommez cette copie `PrivateSettings.config`. +1. Ouvrez ApprovalBot.sln dans Visual Studio, puis ouvrez le fichier **PrivateSettings.config**. + +1. Attribuez la valeur de `MicrosoftAppId` à l’ID (client) d’application que vous avez généré à l’étape précédente et attribuez la valeur de `MicrosoftAppPassword` à la clé secrète que vous avez générée par la suite. + +1. Collez la valeur ngrok URL HTTPs copiée à l’étape précédente dans la valeur de NgrokRootUrl dans **PrivateSettings.config** et enregistrez vos modifications. + + > **IMPORTANT** : Laissez ngrok en cours d’exécution pendant l’exécution de l’exemple. Si vous arrêtez ngrok et le redémarrez, l’URL de transfert change et vous devez mettre à jour la valeur de `NgrokRootUrl`. + +1. Démarrez l’émulateur Azure Cosmos DB. Celui-ci doit être en cours d’exécution avant le démarrage de l’exemple. + +1. Appuyez sur F5 pour déboguer l’exemple. + +1. Exécutez Bot Framework Emulator. Dans la partie supérieure, là où s’affiche **Entrez l’URL de votre point de terminaison**, entrez `https://localhost:3979/api/messages`. + +1. Vous serez invité à entrer l’ID d’application et le mot de passe. Entrez votre ID d’application et votre clé secrète, et laissez le champ **Paramètres régionaux** vide. + + ![](readme-images/configure-emulator.PNG) + +1. Cliquez sur **Connecter**. + +1. Envoyez `hi` pour confirmer la connexion. + + ![](readme-images/hello-bot.PNG) + +## Limitations lors de l’exécution locale + +Lors de l’exécution de l’exemple localement, le courrier de demande d’approbation envoyé est un peu différent. Étant donné qu’il n’est pas en cours d’exécution sur un domaine confirmé et inscrit, nous devons envoyer le message vers et à partir du même compte. Cela veut dire qu’au moment de demander une approbation, vous devez vous inclure vous-même dans la liste des approbateurs. + +Vous pouvez inclure d’autres approbateurs, mais le message qu’ils recevront n’affichera pas la carte adaptative. Connectez-vous à votre propre boîte aux lettres avec Outlook pour tester la carte adaptative. + +## Contribution + +Ce projet autorise les contributions et les suggestions. +Pour la plupart des contributions, vous devez accepter le contrat de licence de contributeur (CLA, Contributor License Agreement) stipulant que vous êtes en mesure, et que vous vous y engagez, de nous accorder les droits d’utiliser votre contribution. +Pour plus d’informations, visitez https://cla.microsoft.com. + +Lorsque vous soumettez une requête de tirage, un robot CLA détermine automatiquement si vous devez fournir un CLA et si vous devez remplir la requête de tirage appropriée (par exemple, étiquette, commentaire). +Suivez simplement les instructions données par le robot. +Vous ne devrez le faire qu’une seule fois au sein de tous les référentiels à l’aide du CLA. + +Ce projet a adopté le [code de conduite Open Source de Microsoft](https://opensource.microsoft.com/codeofconduct/). +Pour en savoir plus, reportez-vous à la [FAQ relative au code de conduite](https://opensource.microsoft.com/codeofconduct/faq/) +ou contactez [opencode@microsoft.com](mailto:opencode@microsoft.com) pour toute question ou tout commentaire. + +## Copyright + +Copyright (c) 2019 Microsoft. Tous droits réservés. diff --git a/README-localized/README-ja-jp.md b/README-localized/README-ja-jp.md new file mode 100644 index 0000000..9a9b774 --- /dev/null +++ b/README-localized/README-ja-jp.md @@ -0,0 +1,139 @@ +--- +page_type: sample +products: +- office-outlook +- office-onedrive +- ms-graph +languages: +- csharp +description: "アダプティブ カードと .NET Graph SDK を使用して、OneDrive 上のファイルを解放するために承認を要求するアクション可能メッセージを送信するサンプル ボット" +extensions: + contentType: samples + technologies: + - Microsoft Graph + - Microsoft Bot Framework + services: + - Outlook + - OneDrive + createdDate: 4/23/2018 12:12:07 PM +--- +# 承認ボットのサンプル + +## ローカルで実行 + +次の手順に従って、デバッグのためにボットをローカルで実行します。 + +### 必要条件 + +- [ngrok](https://ngrok.com/) +- [Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases) +- [Azure Cosmos DB Emulator](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) +- Visual Studio 2017 + +### アプリの登録 + +1. ブラウザーを開き、[Azure Active Directory 管理センター](https://aad.portal.azure.com)に移動します。**職場または学校アカウント**を使用してログインします。 + +1. 左側のナビゲーションで **[Azure Active Directory]** を選択し、それから **[管理]** で **[アプリの登録 (プレビュー)]** を選択します。 + + ![アプリの登録のスクリーンショット ](readme-images/aad-portal-app-registrations.png) + +1. **[新規登録]** を選択します。[**アプリケーションの登録**] ページで、次のように値を設定します。 + + - `Approval Bot` のように、優先する [**名前**] を設定します。 + - [**サポートされているアカウントの種類**] を [**組織のディレクトリ内のアカウント**] に設定します。 + - [**リダイレクト URI**] で、最初のドロップダウン リストを [`Web`] に設定し、それから `http://localhost:3979/callback` に値を設定します。 + + ![[アプリケーションを登録する] ページのスクリーンショット](readme-images/aad-register-an-app.PNG) + +1. [**登録**] を選択します。[**Approval Bot**] ページで、[**アプリケーション (クライアント) ID**] の値をコピーして保存します。この値は次の手順で必要になります。 + + ![新しいアプリ登録のアプリケーション ID のスクリーンショット](readme-images/aad-application-id.PNG) + +1. [**管理**] で [**証明書とシークレット**] を選択します。[**新しいクライアント シークレット**] ボタンを選択します。[**説明**] に値を入力し、[**有効期限**] のオプションのいずれかを選び、[**追加**] を選択します。 + + ![[クライアント シークレットの追加] ダイアログのスクリーンショット](readme-images/aad-new-client-secret.png) + +1. このページを離れる前に、クライアント シークレットの値をコピーします。この値は次の手順で必要になります。 + + > [重要!] + > このクライアント シークレットは今後表示されないため、この段階で必ずコピーするようにしてください。 + + ![新規追加されたクライアント シークレットのスクリーンショット](readme-images/aad-copy-client-secret.png) + +### ngrok プロキシをセットアップする + +Bot Framework Emulator から通知を受信するには、パブリック HTTPS エンドポイントを公開する必要があります。テスト中は、ngrok を使用して Bot Framework Emulator からのメッセージをコンピューター上の *localhost* ポートにトンネルすることを一時的に許可できます。 + +ngrok Web インターフェイス ([http://127.0.0.1:4040](http://127.0.0.1:4040)) を使用して、トンネルを通過する HTTP トラフィックを検査できます。ngrok の使用方法の詳細については、「[ngrok の Web サイト](https://ngrok.com/)」を参照してください。 + + +1. Windows 用の [ngrok をダウンロード](https://ngrok.com/download)します。 + +1. パッケージを解凍し、ngrok.exe を実行します。 + +1. ngrok コンソールで、次のコマンド ラインを実行します。 + + ```Shell + ngrok http 3979 --host-header=localhost:3979 + ``` + + ![ngrok コンソールで実行するコマンドの例](readme-images/ngrok1.PNG) + +1. コンソールに表示される HTTPS URL をコピーします。これを使用して、サンプル内で`NgrokRootUrl`を構成します。 + + ![ngrok コンソールに表示される転送用 HTTPS URL](readme-images/ngrok2.PNG) + + > **注:**テスト中はコンソールを開いたままにします。コンソールを閉じるとトンネルも閉じられるため、新しい URL を生成してサンプルを更新する必要があります。 + +### サンプルを構成して実行する + +1. ローカルでリポジトリを複製します。 +1. 同じディレクトリにある [**./ApprovalBot/PrivateSettings.example.config**] ファイルのコピーを作成し、`PrivateSettings.config` と名前を付けます。 +1. Visual Studio で、[**ApprovalBot.sln**] を開いて、[**PrivateSettings.config**] ファイルを開きます。 + +1. `MicrosoftAppId` の値を前の手順で生成したアプリケーション (クライアント) ID に設定し、`MicrosoftAppPassword` の値をその後で生成したシークレットに設定します。 + +1. 前の手順からコピーされた ngrok HTTPS URL の値を **PrivateSettings.config** の `NgrokRootUrl` の値に貼り付け、変更を保存します。 + + > **重要**:サンプルの実行中は、ngrok を実行したままにします。ngrok を停止して再起動すると、転送の URL が変更され、`NgrokRootUrl` の値を更新する必要があります。 + +1. Azure Cosmos DB Emulator を開始します。これは、サンプルを開始する前に実行している必要があります。 + +1. F5 キーを押してサンプルをデバッグします。 + +1. Bot Framework Emulator を実行します。一番上の **エンドポイント URL を入力する** で、`https://localhost:3979/api/messages` を入力します。 + +1. アプリ ID とパスワードの入力を求められます。アプリ ID とシークレットを入力し、**ロケール** を空白にします。 + + ![](readme-images/configure-emulator.PNG) + +1. [**接続**] をクリックします。 + +1. 接続を確認するために、`hi` と送信します。 + + ![](readme-images/hello-bot.PNG) + +## ローカルで実行する場合の制限事項 + +ローカルでサンプルを実行する場合、送信される承認要求のメールが異なります。これは、確認済みの登録済みドメインで実行されていないためで、メッセージの送信には同じアカウントを使う必要があります。つまり、承認を要求するポイントに到達したら、承認者のリストに自分自身を含める必要があります。 + +他の承認者を含めることはできますが、それらの承認者が受信するメッセージにはアダプティブ カードが表示されません。Outlook で自分のメールボックスにログインして、アダプティブ カードをテストしてください。 + +## 投稿 + +このプロジェクトは投稿や提案を歓迎します。たいていの投稿には、投稿者のライセンス契約 (CLA) +に同意することにより、投稿内容を使用する権利を Microsoft に付与する権利が自分にあり、 +実際に付与する旨を宣言していただく必要があります。詳細については、https://cla.microsoft.com をご覧ください。 + +プル要求を送信すると、CLA を提供する必要があるかどうかを CLA ボットが自動的に判断してプル要求を適切に修飾 (ラベル、コメントなど) します。 +ボットの指示に従ってください。この操作は、 +CLA を使用してすべてのリポジトリ全体に対して 1 度のみ行う必要があります。 + +このプロジェクトでは、[Microsoft Open Source Code of Conduct (Microsoft オープン ソース倫理規定)](https://opensource.microsoft.com/codeofconduct/) +が採用されています。詳細については、「[倫理規定の FAQ](https://opensource.microsoft.com/codeofconduct/faq/)」を参照してください。また、その他の質問やコメントがあれば、 +[opencode@microsoft.com](mailto:opencode@microsoft.com) までお問い合わせください。 + +## 著作権 + +Copyright (c) 2019 Microsoft.All rights reserved. diff --git a/README-localized/README-pt-br.md b/README-localized/README-pt-br.md new file mode 100644 index 0000000..dfc5dee --- /dev/null +++ b/README-localized/README-pt-br.md @@ -0,0 +1,139 @@ +--- +page_type: sample +products: +- office-outlook +- office-onedrive +- ms-graph +languages: +- csharp +description: "Exemplo de Bot que usa cartões adaptativo e o SDK do Graph para .NET a fim de enviar mensagens acionáveis solicitando a aprovação de liberação de arquivos no OneDrive." +extensions: + contentType: samples + technologies: + - Microsoft Graph + - Microsoft Bot Framework + services: + - Outlook + - OneDrive + createdDate: 4/23/2018 12:12:07 PM +--- +# Exemplo de Bot de Aprovação + +## Executado localmente + +Siga estas etapas para habilitar a execução local do bot para depuração. + +### Pré-requisitos + +- [ngrok](https://ngrok.com/) +- [Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases) +- [Emulador do Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) +- Visual Studio 2017 + +### Registrar o aplicativo + +1. Abra um navegador e navegue até o [centro de administração do Azure Active Directory](https://aad.portal.azure.com). Faça o login usando uma **Conta Corporativa ou de Estudante**. + +1. Selecione **Azure Active Directory** na navegação à esquerda e, em seguida, selecione **Registros de aplicativo (Visualizar)** em **Gerenciar**. + + ![Captura de tela dos Registros de aplicativo](readme-images/aad-portal-app-registrations.png) + +1. Selecione **Novo registro**. Na página **Registrar um aplicativo**, defina os valores da seguinte forma. + + - Defina um **Nome** adequado, por exemplo, `Bot de Aprovação`. + - Defina os **Tipos de conta com suporte** como **Contas em qualquer diretório organizacional**. + - Em **URI de Redirecionamento**, defina o primeiro menu suspenso como `Web` e defina o valor como `http://localhost:3979/callback`. + + ![Captura de tela da página Registrar um aplicativo](readme-images/aad-register-an-app.PNG) + +1. Escolha **Registrar**. Na página **Bot de Aprovação**, copie e salve o valor da **ID do aplicativo (cliente)**, você precisará dele na próxima etapa. + + ![Captura de tela da ID do aplicativo do novo registro do aplicativo](readme-images/aad-application-id.PNG) + +1. Selecione **Certificados e segredos** em **Gerenciar**. Selecione o botão **Novo segredo do cliente**. Insira um valor em **Descrição**, selecione uma das opções para **Expira** e escolha **Adicionar**. + + ![Uma captura de tela da caixa de diálogo Adicionar um segredo do cliente](readme-images/aad-new-client-secret.png) + +1. Copie o valor secreto do cliente antes de sair desta página. Você precisará dele na próxima etapa. + + > [!IMPORTANTE] + > Este segredo do cliente nunca é mostrado novamente, portanto, copie-o agora. + + ![Captura de tela do segredo do cliente recém-adicionado](readme-images/aad-copy-client-secret.png) + +### Configurar o proxy ngrok + +Você deve expor um ponto de extremidade HTTPS público para receber notificações do Bot Framework Emulator. Ao testar, você pode usar o ngrok para permitir temporariamente que as mensagens do Bot Framework Emulator sejam encapsuladas para uma porta do *localhost* em seu computador. + +Você pode usar a interface da Web do ngrok ([http://127.0.0.1:4040](http://127.0.0.1:4040)) para inspecionar o tráfego HTTP que passa pelo encapsulamento. Para saber mais sobre como usar o ngrok, confira o [site do ngrok](https://ngrok.com/). + + +1. [Baixar ngrok](https://ngrok.com/download) para Windows. + +1. Descompacte o pacote e execute ngrok.exe. + +1. Execute o seguinte comando no console do ngrok: + + ```Shell + ngrok http 3979 --host-header=localhost:3979 + ``` + + ![Exemplo do comando a executar no console ngrok](readme-images/ngrok1.PNG) + +1. Copie a URL HTTPS exibida no console. Você usará essa configuração para configurar a `NgrokRootUrl` no exemplo. + + ![A URL HTTPS de encaminhamento no console ngrok](readme-images/ngrok2.PNG) + + > **Observação:** Mantenha o console aberto durante o teste. Caso você o feche, o encapsulamento também será fechado, e você precisará gerar uma nova URL e atualizar o exemplo. + +### Configurar e executar o exemplo + +1. Clonar o repositório localmente. +1. Faça uma cópia do arquivo **./ApprovalBot/PrivateSettings.example.config** no mesmo diretório e nomeie a cópia como `PrivateSettings.config`. +1. Abra **ApprovalBot.sln** no Visual Studio e abra o arquivo **PrivateSettings.config**. + +1. Configure o valor de `MicrosoftAppId` com a ID do aplicativo (cliente) gerada na etapa anterior e configure o valor de `MicrosoftAppPassword` com o segredo gerado posteriormente. + +1. Cole o valor da URL HTTPS do ngrok copiado na etapa anterior no valor de `NgrokRootUrl` em **PrivateSettings.config**e salve suas alterações. + + > **IMPORTANTE**: deixe ngrok funcionando enquanto você executa o exemplo. Se você interromper e reiniciar o ngrok, a URL de encaminhamento será alterada, e você precisará atualizar o valor de `NgrokRootUrl`. + +1. Inicie o Emulador do Azure Cosmos DB. Ele deve estar em execução antes de iniciar o exemplo. + +1. Pressione F5 para depurar o exemplo. + +1. Execute o Bot Framework Emulator. Na parte superior, onde diz **Insira a URL do ponto de extremidade**, digite `https://localhost:3979/api/messages`. + +1. Isso solicita a ID do aplicativo e a senha. Insira a ID do aplicativo e o segredo e deixe a **Localidade** em branco. + + ![](readme-images/configure-emulator.PNG) + +1. Clique em **Conectar**. + +1. Envie `hi`para confirmar a conexão. + + ![](readme-images/hello-bot.PNG) + +## Limitações durante a execução local + +Ao executar o exemplo localmente, os emails da solicitação de aprovação enviados são um pouco diferentes. Como não está sendo executado em um domínio registrado e confirmado, devemos enviar a mensagem de e para a mesma conta. Isso significa que, quando você chegar ao ponto em que solicitou a aprovação, você deve incluir a si mesmo na lista de aprovadores. + +Você pode incluir outros aprovadores, mas a mensagem que receber não mostrará o cartão adaptável. Entre em sua caixa de correio com o Outlook para testar o cartão adaptável. + +## Colaboração + +Este projeto recebe e agradece as contribuições e sugestões. +A maioria das contribuições exige que você concorde com um Contrato de Licença de Colaborador (CLA) declarando que você tem o direito a, +nos conceder os direitos de uso de sua contribuição, e de fato o faz. Para saber mais, acesse https://cla.microsoft.com. + +Quando você envia uma solicitação de pull, um bot de CLA determina automaticamente se você precisa fornecer um CLA e decora o PR adequadamente (por exemplo, rótulo, comentário). +Basta seguir as instruções fornecidas pelo bot. +Você só precisa fazer isso uma vez em todos os repos que usam nosso CLA. + +Este projeto adotou o [Código de Conduta de Código Aberto da Microsoft](https://opensource.microsoft.com/codeofconduct/). +Para saber mais, confira as [Perguntas frequentes sobre o Código de Conduta](https://opensource.microsoft.com/codeofconduct/faq/) +ou entre em contato pelo [opencode@microsoft.com](mailto:opencode@microsoft.com) se tiver outras dúvidas ou comentários. + +## Direitos autorais + +Copyright (c) 2019 Microsoft. Todos os direitos reservados. diff --git a/README-localized/README-ru-ru.md b/README-localized/README-ru-ru.md new file mode 100644 index 0000000..7fd1867 --- /dev/null +++ b/README-localized/README-ru-ru.md @@ -0,0 +1,139 @@ +--- +page_type: sample +products: +- office-outlook +- office-onedrive +- ms-graph +languages: +- csharp +description: "Образец ленты, использующий использование адаптивных карт и пакета SDK .NET Graph для отправки транзактных сообщений, запрашивающих утверждение, для освобождения файлов в OneDrive." +extensions: + contentType: samples + technologies: + - Microsoft Graph + - Microsoft Bot Framework + services: + - Outlook + - OneDrive + createdDate: 4/23/2018 12:12:07 PM +--- +# Образец Bot по утверждению + +## Локальное выполнение + +Выполните следующие действия, чтобы разрешить локальный запуск бота для отладки. + +### Предварительные требования + +- [ngrok](https://ngrok.com/) +- [Эмулятор Bot Framework](https://github.com/Microsoft/BotFramework-Emulator/releases) +- [Эмулятор Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) +- Visual Studio 2017 + +### Регистрация приложения + +1. Откройте браузер и перейдите в [Центр администрирования Azure Active Directory](https://aad.portal.azure.com). Войдите с помощью **рабочей или учебной учетной записи**. + +1. Выберите **Azure Active Directory** на панели навигации слева, затем выберите **Регистрация приложения (предварительный просмотр)** в разделе **Управление**. + + ![Снимок экрана раздела регистрации приложений](readme-images/aad-portal-app-registrations.png) + +1. Выберите **Новая регистрация**. На странице **Регистрация приложения** задайте необходимые значения следующим образом: + + - Установите предпочтительное **Имя**, например, `Бот Утверждения`. + - Задайте для параметра **Поддерживаемые типы учетных записей** значение **Учетные записи в любом каталоге организации**. + - В разделе **перенаправления URI** выберите в первом раскрывающемся списке значение `веб` и задайте для него значение `http://localhost:3979/callback`. + + ![Снимок экрана: страница "Регистрация приложения"](readme-images/aad-register-an-app.PNG) + +1. Нажмите кнопку **Зарегистрировать**. На странице **Утверждение бота** скопируйте значение **идентификатора приложения (клиента)** и сохраните его, оно понадобится вам на следующем шаге. + + ![Снимок экрана: идентификатор приложения для новой регистрации](readme-images/aad-application-id.PNG) + +1. Выберите **Сертификаты и секреты** в разделе **Управление**. Нажмите кнопку **Новый секрет клиента**. Введите значение в поле **Описание**, выберите один из вариантов для **Срок действия** и нажмите **Добавить**. + + ![Снимок экрана: диалоговое окно "Добавление секрета клиента"](readme-images/aad-new-client-secret.png) + +1. Скопируйте значение секрета клиента, а затем покиньте эту страницу. Оно вам понадобится на следующем шаге. + + > [ВАЖНО!] + > Этот секрет клиента больше не будет отображаться, поэтому обязательно скопируйте его. + + ![Снимок экрана: только что добавленный секрет клиента](readme-images/aad-copy-client-secret.png) + +### Настройте прокси-сервер ngrok + +Вы должны предоставить общедоступную конечную точку HTTPS для получения уведомлений от эмулятора Bot Framework. Во время тестирования вы можете использовать ngrok, чтобы временно разрешить сообщения из эмулятора Bot Framework для туннелирования на порт *localhost* на вашем компьютере. + +Можно использовать веб-интерфейс ngrok ([http://127.0.0.1:4040](http://127.0.0.1:4040)), чтобы проверить трафик HTTP, проходящий по туннелю. Дополнительные сведения об использовании ngrok см. в статье [веб-сайт ngrok](https://ngrok.com/). + + +1. [Скачайте ngrok](https://ngrok.com/download) для Windows. + +1. Распакуйте пакет и запустите ngrok. exe. + +1. Запустите следующую командную строку в консоли ngrok: + + ```Shell + ngrok http 3979 --host-header=localhost:3979 + ``` + + ![Пример команды для выполнения в консоли ngrok](readme-images/ngrok1.PNG) + +1. Скопируйте URL-адрес HTTPS, который отображается на консоли. Вы будете использовать это для настройки вашего `NgrokRootUrl`в примере. + + ![URL-адрес переадресации HTTPS на консоли ngrok](readme-images/ngrok2.PNG) + + > **Примечание.** Не закрывайте консоль во время тестирования. Если вы ее закроете, то также закроется туннель и вам потребуется создать новый URL-адрес и обновить пример. + +### Настройка и запуск примера + +1. Создайте копию репозитория локально. +1. Сделайте копию файла **./ApprovalBot/PrivateSettings.example.config** в том же каталоге и назовите копию `PrivateSettings.config`. +1. Откройте **ApprovalBot.sln** в Visual Studio, затем откройте файл **PrivateSettings.config**. + +1. Задайте в качестве значения `MicrosoftAppId`идентификатор приложения (клиента), сгенерированный на предыдущем шаге, а в качестве значения `MicrosoftAppPassword`укажите секрет, созданный впоследствии. + +1. Вставьте значение URL-адреса ngrok HTTPS, скопированное из предыдущего шага, в значение `NgrokRootUrl` в **PrivateSettings.config**и сохраните изменения. + + > **Внимание!** При запуске примера оставьте ngrok запущенным. Если вы перейдете на ngrok, а затем перезапустите его, URL-адрес пересылки изменится, и вам потребуется обновить значение `NgrokRootUrl`. + +1. Запустите эмулятор Azure Cosmos DB. Это должно быть запущено до запуска образца. + +1. Нажмите F5, чтобы отладить образец. + +1. Запустите Bot Framework Emulator. Вверху, где написано: **Введите URL-адрес вашей конечной точки**, введите `https://localhost:3979/api/messages`. + +1. Это запросит идентификатор приложения и пароль. Введите идентификатор приложения и секрет и оставьте **Locale** пустым. + + ![](readme-images/configure-emulator.PNG) + +1. Щелкните **Подключить**. + +1. Чтобы убедиться в подключении `Привет`. + + ![](readme-images/hello-bot.PNG) + +## Ограничения при запуске локально + +При запуске примера на локальном компьютере отправляются сообщения с запросом на утверждение. Поскольку он не работает на подтвержденном, зарегистрированном домене, мы должны отправить сообщение в одну и ту же учетную запись. Это означает, что когда вы достигаете точки, в которой вы запрашиваете одобрение, вы должны включить себя в список утверждающих. + +Вы можете включить других утверждающих, но сообщение, которое они получают, не будет отображать адаптивную карту. Войдите в свой почтовый ящик с Outlook, чтобы проверить адаптивную карту. + +## Участие + +Мы всегда рады предложениям и помощи в работе над проектом. +Обычно для добавления своих вариантов необходимо принять Лицензионное соглашение с участником (CLA), заявив, +что вы имеете право предоставлять и предоставляете нам права на использование своего варианта. Подробности см. на сайте https://cla.microsoft.com. + +Когда вы будете отправлять запрос на вытягивание, CLA-бот автоматически определит, нужно ли вам предоставить CLA и соответствующим образом изменит внешний вид запроса на вытягивание (например, добавит метку, комментарий). +Просто следуйте инструкциям бота. +Это нужно будет сделать всего один раз для добавления своих вариантов во все репозитории, использующие наш CLA. + +Этот проект соответствует [Правилам поведения разработчиков открытого кода Майкрософт](https://opensource.microsoft.com/codeofconduct/). +Дополнительные сведения см. в разделе [Часто задаваемые вопросы о правилах поведения](https://opensource.microsoft.com/codeofconduct/faq/). +Если у вас возникли вопросы или замечания, напишите нам по адресу [opencode@microsoft.com](mailto:opencode@microsoft.com). + +## Авторские права + +(c) Корпорация Майкрософт (Microsoft Corporation), 2019. Все права защищены. diff --git a/README-localized/README-zh-cn.md b/README-localized/README-zh-cn.md new file mode 100644 index 0000000..6d06598 --- /dev/null +++ b/README-localized/README-zh-cn.md @@ -0,0 +1,139 @@ +--- +page_type: sample +products: +- office-outlook +- office-onedrive +- ms-graph +languages: +- csharp +description: "示例机器人，使用自适应卡和 .NET Graph SDK 发送可操作邮件，请求审批，以在 OneDrive 上发布文件。" +extensions: + contentType: samples + technologies: + - Microsoft Graph + - Microsoft Bot Framework + services: + - Outlook + - OneDrive + createdDate: 4/23/2018 12:12:07 PM +--- +# 审批机器人示例 + +## 本地运行 + +按照下列步骤启用本地运行机器人，以进行调试。 + +### 先决条件 + +- [ngrok](https://ngrok.com/) +- [机器人框架模拟器](https://github.com/Microsoft/BotFramework-Emulator/releases) +- [Azure Cosmos DB 模拟器](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) +- Visual Studio 2017 + +### 注册应用 + +1. 打开浏览器，并转到 [Azure Active Directory 管理中心](https://aad.portal.azure.com)。使用**工作或学校帐户**登录。 + +1. 选择左侧导航栏中的**“Azure Active Directory”**，再选择**“管理”**下的**“应用注册(预览版)”**。 + + ![“应用注册”的屏幕截图 ](readme-images/aad-portal-app-registrations.png) + +1. 选择**“新注册”**。在“**注册应用**”页上，按如下方式设置值。 + + - 设置首选**名称** ，如`Approval Bot`。 + - 将“**支持的帐户类型**”设置为“**任何组织目录中的帐户**”。 + - 在“**重定向 URI**”下，将第一个下拉列表设置为“`Web`”，并将值设置为 `http://localhost:3979/callback`。 + + ![“注册应用程序”页的屏幕截图](readme-images/aad-register-an-app.PNG) + +1. 选择“**注册**”。在“**Approval Bot**” 页面上，复制并保存“**应用(客户端) ID**”的值，将在下一步中用到它。 + + ![新应用注册的应用程序 ID 的屏幕截图](readme-images/aad-application-id.PNG) + +1. 选择“**管理**”下的“**证书和密码**”。选择**新客户端密码**按钮。在**说明**中输入值，并选择一个**过期**选项，再选择**添加**。 + + ![“添加客户端密码”对话框的屏幕截图](readme-images/aad-new-client-secret.png) + +1. 离开此页前，先复制客户端密码值。将在下一步中用到它。 + + > [重要提示！] + > 此客户端密码不会再次显示，所以请务必现在就复制它。 + + ![新添加的客户端密码的屏幕截图](readme-images/aad-copy-client-secret.png) + +### 设置 ngrok 代理 + +必须公开公共 HTTPS 终结点才能从机器人框架模拟器接收通知。测试时，你可以使用 ngrok 临时允许消息从“机器人框架模拟器”经隧道传输至计算机上的 *localhost* 端口。 + +你可以使用 ngrok Web 界面 ([http://127.0.0.1:4040](http://127.0.0.1:4040)) 检查流经隧道的 HTTP 流量。若要了解与使用 ngrok 相关的详细信息，请参阅 [ngrok 网站](https://ngrok.com/)。 + + +1. [下载 Windows 版 ngrok](https://ngrok.com/download)。 + +1. 解压包并运行 ngrok.exe。 + +1. 在 ngrok 控制台上，运行以下命令： + + ```Shell + ngrok http 3979 --host-header=localhost:3979 + ``` + + ![在 ngrok 控制台中运行的示例命令](readme-images/ngrok1.PNG) + +1. 复制控制台中显示的 HTTPS URL。你将使用它来配置示例中的 `NgrokRootUrl`。 + + ![ngrok 控制台中的转发 HTTPS URL](readme-images/ngrok2.PNG) + + > **注意：**测试时，请保持控制台处于打开状态。如果关闭，则隧道也会关闭，并且你需要生成新的 URL 并更新示例。 + +### 配置并运行示例 + +1. 本地克隆存储库。 +1. 在同一目录中创建文件 **./ApprovalBot/PrivateSettings.example.config** 的副本，并命名副本为 `PrivateSettings.config`。 +1. 在 Visual Studio 中打开 **ApprovalBot.sln**，随后打开 **PrivateSettings.config** 文件。 + +1. 将 `MicrosoftAppId` 值设置为在上一步中生成的应用程序（客户端） ID，并将 `MicrosoftAppPassword` 值设置为之后生成的密码。 + +1. 将复制自上一步的 ngrok HTTPS URL 值粘贴至 **PrivateSettings.config** 的 `NgrokRootUrl` 值中，并保存更改。 + + > **重要提示**：运行示例时，保持 ngrok 运行。如果停止 ngrok 并重启，转发 URL 发生更改，则需要更新 `NgrokRootUrl` 值。 + +1. 启动 Azure Cosmos DB 模拟器。启动示例前，需要运行此模拟器。 + +1. 按下 F5 以调试示例。 + +1. 运行“机器人框架模拟器”。在显示“**输入终结点 URL**”的顶部，输入 `https://localhost:3979/api/messages`。 + +1. 此操作将提示应用 ID 和密码。输入应用 ID 和密码，并将**区域设置**留空。 + + ![](readme-images/configure-emulator.PNG) + +1. 单击“**连接**”。 + +1. 发送 `hi` 以确认连接。 + + ![](readme-images/hello-bot.PNG) + +## 本地运行时的限制 + +本地运行示例时，已发送的审批请求稍有不同。因为未在经过确认的注册域上运行，所以发送和接收的账户是同一账户。即到达请求审批的位时，必须将自身包含在审批列表中。 + +可包含其他审批，但是收到的邮件不显示自适应卡。使用 Outlook 登录到邮箱，以测试自适应卡。 + +## 参与 + +本项目欢迎供稿和建议。 +大多数的供稿都要求你同意“参与者许可协议 (CLA)”，声明你有权并确定授予我们使用你所供内容的权利。 +有关详细信息，请访问 https://cla.microsoft.com。 + +在提交拉取请求时，CLA 机器人会自动确定你是否需要提供 CLA 并适当地修饰 +PR（例如标记、批注）。只需按照机器人提供的说明操作即可。 +只需在所有存储库上使用我们的 CLA 执行此操作一次。 + +此项目已采用 [Microsoft 开放源代码行为准则](https://opensource.microsoft.com/codeofconduct/)。 +有关详细信息，请参阅[行为准则常见问题解答](https://opensource.microsoft.com/codeofconduct/faq/)。 +如有其他任何问题或意见，也可联系 [opencode@microsoft.com](mailto:opencode@microsoft.com)。 + +## 版权信息 + +版权所有 (c) 2019 Microsoft。保留所有权利。