Skip to content

Commit

Permalink
rename 'externalconnection' commands
Browse files Browse the repository at this point in the history
  • Loading branch information
nanddeepn committed Oct 4, 2023
1 parent aca68bd commit 2dbe809
Show file tree
Hide file tree
Showing 21 changed files with 266 additions and 175 deletions.
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
import Global from '/docs/cmd/_global.mdx';

# search externalconnection add
# external connection add

Add a new external connection to be defined for Microsoft Search
Add a new external connection

## Usage

```sh
m365 search externalconnection add [options]
m365 external connection add [options]
```

## Alias

```sh
m365 search externalconnection add
```

## Options

```md definition-list
`-i, --id <id>`
: Developer-provided unique ID of the connection within the Azure Active Directory tenant
: Developer-provided unique ID of the connection within the Azure Active Directory tenant.

`-n, --name <name>`
: The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters
: The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters.

`-d, --description <description>`
: Description of the connection displayed in the Microsoft 365 admin center
: Description of the connection displayed in the Microsoft 365 admin center.

`--authorizedAppIds [authorizedAppIds]`
: Comma-separated collection of application IDs for registered Azure Active Directory apps that are allowed to manage the external connection and to index content in the external connection.
Expand All @@ -34,16 +40,16 @@ The `id` must be at least 3 and no more than 32 characters long. It can contain

## Examples

Adds a new external connection with name and description of test app
Adds a new external connection with name and description of test app.

```sh
m365 search externalconnection add --id MyApp --name "Test" --description "Test"
m365 external connection add --id MyApp --name "Test" --description "Test"
```

Adds a new external connection with a limited number of authorized apps
Adds a new external connection with a limited number of authorized apps.

```sh
m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
m365 external connection add --id MyApp --name "Test" --description "Test" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
```

## Response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,46 @@ import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# search externalconnection get
# external connection get

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

## Usage

```sh
m365 search externalconnection get [options]
m365 external connection get [options]
```

## Alias

```sh
m365 search externalconnection get
```

## Options

```md definition-list
`-i, --id [id]`
: ID of the External Connection to get. Specify either `id` or `name`
: 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`
: Name of the External Connection to get. Specify either `id` or `name`.
```

<Global />

## Examples

Get the External Connection by its id
Get the External Connection by its id.

```sh
m365 search externalconnection get --id "MyApp"
m365 external connection get --id "MyApp"
```

Get the External Connection by its name
Get the External Connection by its name.

```sh
m365 search externalconnection get --name "Test"
m365 external connection get --name "Test"
```

## Response
Expand Down Expand Up @@ -83,7 +89,7 @@ m365 search externalconnection get --name "Test"
<TabItem value="Markdown">

```md
# search externalconnection get --id "CLITest"
# external connection get --id "CLITest"

Date: 2022-11-05

Expand All @@ -99,4 +105,3 @@ m365 search externalconnection get --name "Test"

</TabItem>
</Tabs>

Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,20 @@ import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# search externalconnection list
# external connection list

Lists external connections defined in Microsoft Search
Lists external connections

## Usage

```sh
m365 search externalconnection list [options]
m365 external connection list [options]
```

## Alias

```sh
m365 search externalconnection list
```

## Options
Expand All @@ -18,10 +24,10 @@ m365 search externalconnection list [options]

## Examples

List external connections defined in Microsoft Search
List external connections.

```sh
m365 search externalconnection list
m365 external connection list
```

## Response
Expand Down Expand Up @@ -69,7 +75,7 @@ m365 search externalconnection list
<TabItem value="Markdown">

```md
# search externalconnection list
# external connection list

Date: 2022-09-05

Expand All @@ -85,4 +91,3 @@ m365 search externalconnection list

</TabItem>
</Tabs>

54 changes: 54 additions & 0 deletions docs/docs/cmd/external/connection/connection-remove.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import Global from '/docs/cmd/_global.mdx';

# external connection remove

Allow the administrator to remove a specific external connection

## Usage

```sh
m365 external connection remove [options]
```

## Alias

```sh
m365 search externalconnection remove
```

## Options

```md definition-list
`-i, --id [id]`
: ID of the External Connection to remove. Specify either `id` or `name`.

`-n, --name [name]`
: Name of the External Connection to remove. Specify either `id` or `name`.

`-f, --force`
: Don't prompt for confirming removing the connection.
```

<Global />

## Remarks

If the command finds multiple external connections with the specified name, it will prompt you to disambiguate which external connection it should remove, listing the discovered IDs.

## Examples

Removes external connection by its id.

```sh
m365 external connection remove --id "MyApp"
```

Removes external connection by its name. Will NOT prompt for confirmation before removing.

```sh
m365 external connection remove --name "Test" --force
```

## Response

The command won't return a response on success.
41 changes: 41 additions & 0 deletions docs/docs/cmd/external/connection/connection-schema-add.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import Global from '/docs/cmd/_global.mdx';

# external connection schema add

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

## Usage

```sh
m365 external connection schema add [options]
```

## Alias

```sh
m365 search externalconnection schema add
```

## Options

```md definition-list
`-i, --externalConnectionId <externalConnectionId>`
: ID of the External Connection.

`-s, --schema [schema]`
: The schema object to be added.
```

<Global />

## Examples

Adds a new schema to a specific external connection.

```sh
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"}]}'
```

## Response

The command won't return a response on success.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 2dbe809

Please sign in to comment.