From 4077bcac5253363a4a0776394fe221b9d6bbbda8 Mon Sep 17 00:00:00 2001 From: Waldek Mastykarz Date: Thu, 4 Jan 2018 11:22:37 +0100 Subject: [PATCH] Added documentation on using REST and CSOM in the CLI --- docs/manual/docs/concepts/communicating-o365.md | 5 +++++ docs/manual/mkdocs.yml | 1 + 2 files changed, 6 insertions(+) create mode 100644 docs/manual/docs/concepts/communicating-o365.md diff --git a/docs/manual/docs/concepts/communicating-o365.md b/docs/manual/docs/concepts/communicating-o365.md new file mode 100644 index 00000000000..5b5df24ae11 --- /dev/null +++ b/docs/manual/docs/concepts/communicating-o365.md @@ -0,0 +1,5 @@ +# Communication with Office 365 + +To manage settings of the different Office 365 services, the Office 365 CLI uses REST APIs exposed by the corresponding services. Using the REST APIs is meant to promote consistency and reusability of code and tests across the CLI no matter which Office 365 service the CLI is communicating with. + +Some SharePoint Online commands deviate from this rule and mimic SharePoint CSOM calls instead. This is done out of necessity as some operations, such as managing Office 365 CDN settings or tenant properties, are not exposed through REST APIs. Whenever REST APIs become available for these operations, the affected commands will be changed to use REST APIs instead of mimicking CSOM calls. \ No newline at end of file diff --git a/docs/manual/mkdocs.yml b/docs/manual/mkdocs.yml index c463cb28024..f5a5a33f699 100644 --- a/docs/manual/mkdocs.yml +++ b/docs/manual/mkdocs.yml @@ -63,6 +63,7 @@ pages: - 'Persisting connection': 'concepts/persisting-connection.md' - 'Authorization and access tokens': 'concepts/authorization-tokens.md' - 'Command completion': 'concepts/completion.md' + - 'Communication with Office 365': 'concepts/communicating-o365.md' - About: - 'Why this CLI': 'about/why-cli.md' - 'Comparison to SharePoint PowerShell': 'about/comparison-powershell.md'