Skip to content

search externalconnection get

Allow the administrator to get a specific external connection for use in Microsoft Search.

Usage

m365 search externalconnection get [options]

Options

-i, --id [id]
ID of the External Connection to get. Specify either id or name
-n, --name [name]
Name of the External Connection to get. Specify either id or name
-h, --help [help]
Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is full.
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text,csv. Default json
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Examples

Get the External Connection by its id

m365 search externalconnection get --id "MyApp"

Get the External Connection by its name

m365 search externalconnection get --name "Test"

Response

{
  "id": "CLITest",
  "name": "CLI-Test",
  "description": "CLI Test",
  "state": "draft",
  "configuration": {
    "authorizedApps": [
      "31359c7f-bd7e-475c-86db-fdb8c937548e"
    ],
    "authorizedAppIds": [
      "31359c7f-bd7e-475c-86db-fdb8c937548e"
    ]
  }
}
configuration: {"authorizedApps":["31359c7f-bd7e-475c-86db-fdb8c937548e"],"authorizedAppIds":["31359c7f-bd7e-475c-86db-fdb8c937548e"]}
description  : CLI Test
id           : CLITest
name         : CLI-Test
state        : draft
id,name,description,state,configuration
CLITest,CLI-Test,CLI Test,draft,"{""authorizedApps"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""],""authorizedAppIds"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""]}"