Skip to content

Commit def55a6

Browse files
committed
documentation and rename of file
1 parent 1701ea6 commit def55a6

4 files changed

Lines changed: 40 additions & 1 deletion

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# spo web list
2+
3+
Gets all webs within the specified site
4+
5+
## Usage
6+
7+
```sh
8+
spo web list [options]
9+
```
10+
11+
## Options
12+
13+
Option|Description
14+
------|-----------
15+
`--help`|output usage information
16+
`-u, --webUrl <webUrl>`|URL of the site where the lists to retrieve are located
17+
`-o, --output [output]`|Output type. `json|text`. Default `text`
18+
`--verbose`|Runs command with verbose logging
19+
`--debug`|Runs command with debug logging
20+
21+
!!! important
22+
Before using this command, connect to a SharePoint Online site, using the [spo connect](../connect.md) command.
23+
24+
## Remarks
25+
26+
To get all webs, you have to first connect to a SharePoint Online site using the [spo connect](../connect.md) command, eg. `spo connect https://contoso.sharepoint.com`.
27+
28+
## Examples
29+
30+
Return all webs located in site _https://contoso.sharepoint.com/_
31+
32+
```sh
33+
spo web list -u https://contoso.sharepoint.com
34+
```
35+
36+
## More information
37+
38+
- Web REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn499819.aspx#bk_WebCollection](https://msdn.microsoft.com/en-us/library/office/dn499819.aspx#bk_WebCollection)

docs/manual/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ pages:
9696
- web:
9797
- web add: 'cmd/spo/web/web-add.md'
9898
- web remove: 'cmd/spo/web/web-remove.md'
99+
- web list: 'cmd/spo/web/web-list.md'
99100
- Microsoft Graph (graph):
100101
- connect: 'cmd/graph/connect.md'
101102
- disconnect: 'cmd/graph/disconnect.md'

src/o365/spo/commands/web/spo-web-list.spec.ts renamed to src/o365/spo/commands/web/web-list.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import Command, { CommandValidate, CommandOption, CommandError } from '../../../
33
import * as sinon from 'sinon';
44
import appInsights from '../../../../appInsights';
55
import auth, { Site } from '../../SpoAuth';
6-
const command: Command = require('./spo-web-list');
6+
const command: Command = require('./web-list');
77
import * as assert from 'assert';
88
import * as request from 'request-promise-native';
99
import Utils from '../../../../Utils';

0 commit comments

Comments
 (0)