Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renames "search externalconnection" commands to "external connection" commands. Closes #5531 #5545

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/docs/about/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,7 @@ sidebar_position: 4

**Search:**

- [search externalconnection schema add](../cmd/search/externalconnection/externalconnection-schema-add.mdx) - adds a schema to a specific external connection [#3171](https://github.com/pnp/cli-microsoft365/issues/3171)
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved
- [search externalconnection schema add](../cmd/external/connection/connection-schema-add.mdx) - adds a schema to a specific external connection [#3171](https://github.com/pnp/cli-microsoft365/issues/3171)

**SharePoint:**

Expand Down Expand Up @@ -1047,7 +1047,7 @@ sidebar_position: 4

**Search:**

- [search externalConnections remove](../cmd/search/externalconnection/externalconnection-remove.mdx) - allows the administrator to remove a specific external connection used in Microsoft Search [#3170](https://github.com/pnp/cli-microsoft365/issues/3170)
- [search externalConnections remove](../cmd/external/connection/connection-remove.mdx) - allows the administrator to remove a specific external connection used in Microsoft Search [#3170](https://github.com/pnp/cli-microsoft365/issues/3170)

### Changes

Expand Down Expand Up @@ -1090,7 +1090,7 @@ sidebar_position: 4

**Search:**

- [search externalconnection get](../cmd/search/externalconnection/externalconnection-get.mdx) - allows the administrator to get a specific external connection for use in Microsoft Search [#3169](https://github.com/pnp/cli-microsoft365/issues/3169)
- [search externalconnection get](../cmd/external/connection/connection-get.mdx) - allows the administrator to get a specific external connection for use in Microsoft Search [#3169](https://github.com/pnp/cli-microsoft365/issues/3169)

**SharePoint:**

Expand Down Expand Up @@ -1220,7 +1220,7 @@ sidebar_position: 4

**Search:**

- [search externalConnections list](../cmd/search/externalconnection/externalconnection-list.mdx) - lists external connections defined in Microsoft Search [#2790](https://github.com/pnp/cli-microsoft365/issues/2790)
- [search externalConnections list](../cmd/external/connection/connection-list.mdx) - lists external connections defined in Microsoft Search [#2790](https://github.com/pnp/cli-microsoft365/issues/2790)

**Tenant:**

Expand Down Expand Up @@ -1467,7 +1467,7 @@ sidebar_position: 4

**Microsoft Search:**

- [search externalconnection add](../cmd/search/externalconnection/externalconnection-add.mdx) - adds a new external connection to be defined for Microsoft Search [#2662](https://github.com/pnp/cli-microsoft365/issues/2662)
- [search externalconnection add](../cmd/external/connection/connection-add.mdx) - adds a new external connection to be defined for Microsoft Search [#2662](https://github.com/pnp/cli-microsoft365/issues/2662)

**Planner:**

Expand Down Expand Up @@ -2566,7 +2566,7 @@ sidebar_position: 4

**SharePoint Online:**

- [spo apppage set](../cmd/spo/apppage/apppage-set.mdx) - updates the single-part app page [#875](https://github.com/pnp/cli-microsoft365/issues/875)
- [spo apppage set](../cmd/spo/apppage/apppage-set.mdx) - updates the single-part app page [#875](https://github.com/pnp/cli-microsoft365/issues/875)
- [spo feature enable](../cmd/spo/feature/feature-enable.mdx) - enables feature for the specified site or web [#675](https://github.com/pnp/cli-microsoft365/issues/675)

**Microsoft Teams:**
Expand Down Expand Up @@ -3409,4 +3409,4 @@ Initial release.
- [spo storageentity get](../cmd/spo/storageentity/storageentity-get.mdx) - get value of a tenant property
- [spo storageentity list](../cmd/spo/storageentity/storageentity-list.mdx) - list all tenant properties
- [spo storageentity remove](../cmd/spo/storageentity/storageentity-remove.mdx) - remove a tenant property
- [spo storageentity set](../cmd/spo/storageentity/storageentity-set.mdx) - set a tenant property
- [spo storageentity set](../cmd/spo/storageentity/storageentity-set.mdx) - set a tenant property
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.

Loading