m365pnp/cli-microsoft365

CLI for Microsoft 365 镜像文档

镜像概述和主要用途

CLI for Microsoft 365 是一款轻量级命令行工具，专为管理Microsoft 365租户和SharePoint Framework (SPFx)项目设计。该工具提供统一的操作体验，支持在多种操作系统和shell环境中运行，可高效管理各类Microsoft 365工作负载，并简化SPFx项目的开发与维护流程，适用于管理员、开发者及DevOps工程师。

核心功能和特性

跨平台与环境兼容性

• 多操作系统支持：Linux、macOS、Windows
• 多shell环境兼容：Azure Cloud Shell、bash、cmder、PowerShell、zsh

统一身份验证与访问

• 统一登录体验：单次认证即可访问所有Microsoft 365工作负载
• 多样化认证方式：
  • Azure Managed Identity
  • 证书认证
  • 设备代码流
  • 用户名密码认证

全面的工作负载管理

支持管理多种Microsoft 365服务：

• Azure Active Directory
• Microsoft Teams
• Microsoft To Do
• OneDrive
• Outlook
• Planner
• Power Automate
• Power Apps
• Skype for Business
• SharePoint Online
• Yammer

SharePoint Framework项目管理

• 项目升级与版本管理
• 环境兼容性检查
• 开发配置验证

使用场景和适用范围

目标用户

• Microsoft 365租户管理员
• SharePoint Framework开发者
• DevOps工程师（自动化Microsoft 365环境配置）
• IT运维团队（批量操作与报表生成）

典型应用场景

• 日常Microsoft 365租户配置管理（如站点创建、用户权限设置）
• SPFx项目生命周期管理（初始化、升级、打包）
• 自动化脚本开发（租户健康检查、数据迁移、合规性报告）
• 多环境部署（开发/测试/生产环境一致性维护）

使用方法和配置说明

前提条件

• Docker引擎（20.10.0+）
• Microsoft 365租户账号（需具备相应管理权限）
• 网络连接（用于身份验证和API调用）

获取镜像

bash
docker pull pnp/cli-microsoft365:latest

基础操作

登录Microsoft 365租户

通过设备代码流进行身份验证：

bash
docker run -it --rm pnp/cli-microsoft365 m365 login

首次登录说明：系统将引导您访问微软登录页面并输入设备代码，完成后需同意"PnP Management Shell"应用的权限请求。如需使用自定义Azure AD应用身份，参考https://pnp.github.io/cli-microsoft365/user-guide/using-own-identity/%E6%8C%87%E5%8D%97%E3%80%82

获取命令帮助

查看所有可用命令：

bash
docker run -it --rm pnp/cli-microsoft365 m365 --help

查看特定命令详情（以SharePoint站点获取为例）：

bash
docker run -it --rm pnp/cli-microsoft365 m365 spo site get --help

命令执行示例

获取SharePoint站点信息（文本输出）

bash
docker run -it --rm pnp/cli-microsoft365 m365 spo site get --webUrl https://contoso.sharepoint.com

JSON格式输出

使用--output参数指定输出格式：

bash
docker run -it --rm pnp/cli-microsoft365 m365 spo site get --webUrl https://contoso.sharepoint.com --output json

结果过滤与查询

通过--query参数使用JMESPath查询语言筛选结果：

bash
docker run -it --rm pnp/cli-microsoft365 m365 spo site list --output json --query '[?Template==`GROUP#0`].{Title:Title, Url:Url}'

高级配置

持久化认证状态

默认情况下，容器退出后认证状态会丢失。通过挂载本地目录持久化配置：

bash
docker run -it --rm -v ~/.m365:/root/.m365 pnp/cli-microsoft365 m365 login

挂载路径~/.m365用于存储认证令牌和配置，下次运行可直接执行命令无需重新登录。

证书认证配置

挂载证书文件并使用证书认证：

bash
docker run -it --rm \
  -v /local/path/to/certificate.pem:/cert.pem \
  pnp/cli-microsoft365 m365 login \
  --authType certificate \
  --certificateFile /cert.pem \
  --tenant contoso.onmicrosoft.com \
  --appId 00000000-0000-0000-0000-000000000000

SPFx项目管理

在容器中处理本地SPFx项目（需挂载项目目录）：

bash
# 升级SPFx项目
docker run -it --rm -v $(pwd):/project pnp/cli-microsoft365 m365 spfx project upgrade --path /project

# 环境兼容性检查
docker run -it --rm -v $(pwd):/project pnp/cli-microsoft365 m365 spfx doctor --path /project

参考资源

• https://pnp.github.io/cli-microsoft365/
• https://pnp.github.io/cli-microsoft365/cmd/
• https://pnp.github.io/cli-microsoft365/sample-scripts/
• https://github.com/pnp/cli-microsoft365