Skip to content

New command: check if an external connection is properly configured for use with copilot #5675

@waldekmastykarz

Description

@waldekmastykarz

Usage

m365 external connection copilot doctor

Description

Checks if the external connection is correctly configured for use with Copilot for Microsoft 365

Options

Option Description
-i, --externalConnectionId <externalConnectionId> The ID of the external connection to check
--ux [ux] Microsoft 365 experience for which to check compatibility. Allowed values copilot, search, all (default)

Examples

Checks if the external connection with the specified ID is correctly configured for use with Copilot for Microsoft 365

m365 external connection copilot doctor --externalConnectionId contosoproducts

Default properties

No response

Additional Info

Uses this guidance to check the configuration: https://learn.microsoft.com/en-us/graph/connecting-external-content-experiences#microsoft-365-copilot

Implements the following checks:

  • required semantic labels configured (required)
  • schema contains searchable properties (required)
  • items have content ingested (required)
  • connection is configured for inline results (required)
  • connection has an urlToItemResolver configured (recommended)
  • urlToItemResolver base URL is protocol + host without path (required, if urlToItemResolver configured)
  • items have activities recorded (recommended)
  • connection has a meaningful title and description (manual)

When executed, checks are displayed using a spinner like ora to show the progress. Some checks can't be automated and will need to be done manually and we should display them for completeness. When the command is ran in text mode, it doesn't produce any other output than the spinner summary. For JSON output, it returns an object with the status of the different checks. For MD and CSV, it prints a key-value pair output/table.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions