external connection schema add

Allows the administrator to add a schema to a specific external connection

Usage

m365 external connection schema add [options]

Alias

m365 search externalconnection schema add

Options

-i, --externalConnectionId <externalConnectionId>

ID of the External Connection.

-s, --schema [schema]

The schema object to be added.

--wait

Wait for the schema to be added before completing the command.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Permissions

Delegated

Resource	Permissions
Microsoft Graph	ExternalConnection.ReadWrite.OwnedBy

Application

Resource	Permissions
Microsoft Graph	ExternalConnection.ReadWrite.OwnedBy

Examples

Adds a new schema to a specific external connection.

m365 external connection schema add --externalConnectionId 'CliConnectionId' --schema '{"baseType":"microsoft.graph.externalItem","properties":[{"name":"ticketTitle","type":"String","isSearchable":"true","isRetrievable":"true","labels":["title"]},{"name":"priority","type":"String","isQueryable":"true","isRetrievable":"true","isSearchable":"false"},{"name":"assignee","type":"String","isRetrievable":"true"}]}'

Adds a new schema to a specific external connection and wait for its provisioning to complete.

m365 external connection schema add --externalConnectionId 'CliConnectionId' --schema '{"baseType":"microsoft.graph.externalItem","properties":[{"name":"ticketTitle","type":"String","isSearchable":"true","isRetrievable":"true","labels":["title"]},{"name":"priority","type":"String","isQueryable":"true","isRetrievable":"true","isSearchable":"false"},{"name":"assignee","type":"String","isRetrievable":"true"}]}' --wait

Response

Upon executing the command, you'll receive the job status URL. This URL enables manual checking of the job's progress if automated polling fails or for interactive monitoring purposes.

"https://graph.microsoft.com/v1.0/external/connections/MyApp/operations/795b6888-4093-0fe7-6270-ddbcac9ebd3a"