N 型云指挥官(预览版)

云指挥官允许跨 Microsoft 365 和 Azure 自动执行常见任务,而无需切换控制台或客户。

此连接器在以下产品和区域中可用:

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部(DoD)
Power Apps 高级 除以下各项外的所有 Power Apps 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
Power Automate 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
联系人​​
Name 云指挥官支持
URL https://documentation.cloudcommander.management/kb/en
Email technicalsupport@n-able.com
连接器元数据
发布者 N-Able Technologies Ltd.
网站 https://www.n-able.com
隐私策略 https://www.n-able.com/legal/privacy
类别 业务管理;IT 运营

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

为用户添加命令阻止作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

为组添加命令块作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

为组织添加命令块作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

为设备添加命令块作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

从Microsoft Entra ID 组中删除成员

通过成员导航属性从组中删除成员。

从云指挥官组中删除成员

将成员删除到云指挥官组。

分配管理器

将经理分配给用户。

列出命令块

检索可用命令块的列表。

列出用户

检索用户列表。

列出组织

列出你有权查看的所有组织。

列出组织域

检索域对象列表。

创建Microsoft Entra ID 组

创建Microsoft Entra ID 组。

创建用户

请求正文包含要创建的用户。 至少必须指定用户所需的属性。 可以选择指定任何其他可写属性。

删除云指挥官组

删除云指挥官组。

删除用户

删除用户。 删除后,用户资源将移动到临时容器,并且可以在 30 天内还原。 此后,它们将被永久删除。

向用户分配许可证

添加或删除用户的许可证。 还可以启用和禁用与许可证关联的特定计划。

将成员添加到Microsoft Entra ID 组

通过成员导航属性将成员添加到 Microsoft 365 组或安全组。

将成员添加到云指挥官组

将成员添加到云指挥官组,该成员应属于与该组相同的组织。

更新合作伙伴中心订阅数量

更新订阅的数量。

更新用户

更新用户。

获取Microsoft Entra ID 安全组

获取有权查看的所有组织的Microsoft Entra ID 安全组的列表。

获取云指挥官组

获取有权查看的所有组织的云指挥官组的列表。

获取云指挥官组成员的列表

获取特定组的云指挥官组成员的列表。

获取区域设置

获取区域设置。

获取单个用户作业的详细信息

获取单个用户作业、提供程序和作验证的详细信息取决于特定的命令块。

获取合作伙伴中心订阅

按合作伙伴的 Active Directory 租户标识符检索合作伙伴客户的所有订阅。

获取命令块详细信息

获取命令块的详细信息。 提供程序和作验证取决于特定的命令块。

获取命令类别

获取所有可用的类别和子类别。

获取所有已授权组织的命令块作业的统计信息

获取有权查看的命令块的命令块作业的统计信息。

获取所有已授权组织的命令阻止作业

获取有权查看的命令块的命令块作业。

获取特定组织的命令块作业

获取有权查看的命令块的命令块作业。

获取用户许可证详细信息

检索企业用户的许可证详细信息对象列表。

获取用户详细信息

通过Microsoft对象标识符获取用户。

获取管理器

获取用户的经理。

获取组织订阅的 SKU

获取组织已获取的商业订阅的列表。

设置 OneDrive 网站权限

设置 OneDrive 网站权限。

设置邮箱转发地址

设置邮箱转发地址。

转换为共享邮箱

将用户邮箱转换为共享邮箱。

为用户添加命令阻止作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

命令块 ID
commandBlockId True string

格式 - uuid。 命令块的唯一标识符。

目标用户 ID
targetUserId True string

格式 - uuid。 目标用户的唯一标识符。

技术 ID
technicalIdentifier string

技术标识符。

价值
value string

价值。

计划 ID
scheduleId string

计划标识符。

返回

名称 路径 类型 说明
价值
value string

价值。

为组添加命令块作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

命令块 ID
commandBlockId True string

格式 - uuid。 命令块的唯一标识符。

目标组 ID
targetGroupId True string

格式 - uuid。 目标组的唯一标识符。

技术 ID
technicalIdentifier string

技术标识符。

价值
value string

价值。

计划 ID
scheduleId string

计划标识符。

返回

名称 路径 类型 说明
价值
value string

价值。

为组织添加命令块作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

命令块 ID
commandBlockId True string

格式 - uuid。 命令块的唯一标识符。

目标组织 ID
targetOrganizationId True string

格式 - uuid。 目标组织的唯一标识符。

技术 ID
technicalIdentifier string

技术标识符

价值
value string

价值。

计划 ID
scheduleId string

计划标识符。

返回

名称 路径 类型 说明
价值
value string

价值。

为设备添加命令块作业

添加命令块作业。 提供程序和作验证基于特定的命令块。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

命令块 ID
commandBlockId True string

格式 - uuid。 命令块的唯一标识符。

目标设备 ID
targetDeviceId True string

格式 - uuid。 目标设备的唯一标识符。

技术 ID
technicalIdentifier string

技术标识符。

价值
value string

价值。

计划 ID
scheduleId string

计划标识符。

返回

名称 路径 类型 说明
价值
value string

价值。

从Microsoft Entra ID 组中删除成员

通过成员导航属性从组中删除成员。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft组的对象 ID。
groupMicrosoftObjectId True string

Microsoft组的对象标识符。

Microsoft用户的对象 ID。
userMicrosoftObjectId True string

Microsoft用户的对象标识符。

从云指挥官组中删除成员

将成员删除到云指挥官组。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

云指挥官用户组 ID。
userGroupId True string

云指挥官用户组标识符。

云指挥官用户 ID。
userId True string

云指挥官用户标识符。

分配管理器

将经理分配给用户。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft用户的对象 ID。
microsoftObjectId True string

Microsoft用户的对象标识符。

经理
@odata.id string

要添加的用户对象的 URI。

列出命令块

检索可用命令块的列表。

参数

名称 密钥 必需 类型 说明
$top项
$top string

仅返回第一个$top项。

$skip项
$skip string

要跳过的项目数。

选择筛选器
$select string

$select odata 筛选器。

订单依据
$orderby string

确定用于对记录集合进行排序的值。

过滤器
$filter string

一个函数,必须计算结果为 true 才能返回记录。

计数
$count string

确定不要在集合中包含项计数。

返回

名称 路径 类型 说明
OData 上下文
@odata.context string

OData 上下文。

OData 计数
@odata.count integer

OData 计数。

OData 下一个链接
@odata.nextLink string

OData 下一个链接。

value
value array of object

价值。

Id
value.id string

标识符。

技术 ID
value.technicalIdentifier string

技术标识符。

类型
value.type string

类型。

版本
value.version integer

版本。

类别 ID
value.categoryId string

类别标识符。

所需的读取作
value.requiredReadAction string

所需的读取作。

所需的写入作
value.requiredWriteAction string

所需的写入作。

必需的提供程序
value.requiredProvider string

必需的提供程序。

菜单类别 ID
value.menuCategory.id string

菜单类别的标识符。

技术 ID
value.menuCategory.technicalIdentifier string

技术标识符。

父类别 ID
value.parentCategory.id string

父类别的标识符。

技术 ID
value.parentCategory.technicalIdentifier string

技术标识符。

Id
value.category.id string

类别的 ID。

技术标识符
value.category.technicalIdentifier string

技术标识符。

列出用户

检索用户列表。

参数

名称 密钥 必需 类型 说明
筛选用户。
$filter True string

筛选组织中的用户。 使用:{organizationId}'中的 organizationId。

最大结果。
$top True integer

最大结果

要跳过的结果。
$skip integer

跳过结果

返回

名称 路径 类型 说明
总计计数
@odata.count integer

用户计数。

value
value array of object

value

组织编号
value.organizationId string

用户所属的组织的唯一标识符。

Microsoft对象标识符
value.microsoftObjectIdentifier string

唯一Microsoft用户标识符。

UPN
value.upn string

用户主体名称。

名字
value.firstName string

用户的名字。

姓氏
value.lastName string

用户的姓氏。

显示名称
value.displayName string

用户的显示名称。

语言
value.language string

用户的语言。

使用位置
value.usageLocation string

使用位置。

混合用户
value.isHybridUser boolean

设置用户是否从本地同步。

Id
value.id string

用户的唯一标识符。

创建时间
value.createdOn date-time

用户创建时间戳。

修改时间
value.modifiedOn date-time

用户修改时间戳。

列出组织

列出你有权查看的所有组织。

返回

名称 路径 类型 说明
计数
@odata.count integer

组织计数。

value
value array of object

value

Name
value.name string

组织的名称。

Microsoft租户 ID
value.microsoftTenantId string

唯一Microsoft用户标识符。

Microsoft CSP 类型
value.type string

Microsoft CSP 合作伙伴类型。

产品 ID
value.productIdentifier string

N 个可识别的产品标识符。

产品 ID 类型
value.productIdentifierType string

N 型产品标识符类型。

已启用混合标识
value.hybridADEnabled boolean

已启用混合标识。

创建时间
value.createdOn string

创建时间。

修改时间
value.modifiedOn string

已修改。

Id
value.id string

组织的唯一标识符。

列出组织域

检索域对象列表。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

返回

名称 路径 类型 说明
value
value array of object

价值。

身份验证类型
value.authenticationType string

域的身份验证类型。

可用性状态
value.availabilityStatus string

域的可用性状态。

Id
value.id string

域的标识符。

管理员管理
value.isAdminManaged boolean

指示域是否由管理员管理。

违约
value.isDefault boolean

指示此域是否为默认域。

初始
value.isInitial boolean

指示此域是否为初始域。

value.isRoot boolean

指示此域是否为根域。

Verified
value.isVerified boolean

指示域是否已验证。

supportedServices
value.supportedServices array of string

支持的服务。

密码有效性
value.passwordValidityPeriodInDays integer

指示密码有效期(以天为单位)。

密码通知窗口
value.passwordNotificationWindowInDays integer

指示密码通知窗口(以天为单位)。

State
value.state string

域的状态。

创建Microsoft Entra ID 组

创建Microsoft Entra ID 组。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Description
description string

组的说明。

显示名称
displayName string

组的显示名称。

groupTypes
groupTypes array of string

组类型。

已启用邮件
mailEnabled boolean

指示组是否已启用邮件。

邮件昵称
mailNickname string

组的邮件昵称。

已启用安全性
securityEnabled boolean

指示组是否已启用安全性。

返回

名称 路径 类型 说明
Id
id string

组的标识符。

删除日期
deletedDateTime string

已将其删除。

Classification
classification string

组的分类。

创建时间
createdDateTime string

创建时间。

creationOptions
creationOptions array of string

创建选项。

Description
description string

Description.

显示名称
displayName string

显示名称。

groupTypes
groupTypes array of string

groupTypes

邮件
mail string

组的电子邮件地址。

已启用邮件
mailEnabled boolean

指示组已启用邮件。

邮件昵称
mailNickname string

组的邮件昵称。

本地上次同步
onPremisesLastSyncDateTime string

指示组何时同步到本地。

本地安全标识符
onPremisesSecurityIdentifier string

组的本地安全标识符。

已启用本地同步
onPremisesSyncEnabled string

指示是否启用了本地同步。

首选数据位置
preferredDataLocation string

组的首选数据位置。

代理地址
proxyAddresses array of string

代理地址。

更新
renewedDateTime string

组的续订日期时间。

resourceBehaviorOptions
resourceBehaviorOptions array of string

资源行为选项。

resourceProvisioningOptions
resourceProvisioningOptions array of string

资源预配选项。

已启用安全性
securityEnabled boolean

指示组是否已启用安全性。

能见度
visibility string

组的可见性。

onPremisesProvisioningErrors
onPremisesProvisioningErrors array of string

本地预配错误。

创建用户

请求正文包含要创建的用户。 至少必须指定用户所需的属性。 可以选择指定任何其他可写属性。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

已启用帐户
accountEnabled boolean

帐户已启用 true 或 false。

显示名称
displayName string

用户的显示名称。

邮件昵称
mailNickname string

用户的邮件昵称。

用户主体名称
userPrincipalName string

用户的用户主体名称。

强制更改下一个登录密码
forceChangePasswordNextSignIn boolean

强制用户在下次登录时更改密码。

密码
password string

用户的新密码。

返回

名称 路径 类型 说明
OData 上下文
@odata.context string

OData 上下文。

Id
id string

云指挥官标识符。

businessPhones
businessPhones array of string

用户的商务电话。

显示名称
displayName string

用户的显示名称。

givenName string

名。

职务
jobTitle string

用户的职务。

邮件
mail string

用户的电子邮件地址。

移动电话
mobilePhone string

用户的移动电话编号。

Office 位置
officeLocation string

用户的 Office 位置。

首选语言
preferredLanguage string

Azure AD 中配置的首选语言。

Surname
surname string

用户的姓氏。

用户主体名称
userPrincipalName string

用户的用户主体名称。

删除云指挥官组

删除云指挥官组。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

用户组的云指挥官标识符。
userGroupId True string

用户组的云指挥官标识符。

删除用户

删除用户。 删除后,用户资源将移动到临时容器,并且可以在 30 天内还原。 此后,它们将被永久删除。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft用户的对象 ID。
microsoftObjectId True string

Microsoft用户的对象标识符。

向用户分配许可证

添加或删除用户的许可证。 还可以启用和禁用与许可证关联的特定计划。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft用户的对象 ID。
microsoftObjectId True string

Microsoft用户的对象标识符。

disabledPlans
disabledPlans array of string

disabledPlans

addLicenses
skuId True string

指定要添加的许可证的 assignedLicense 对象的集合。

removeLicenses
removeLicenses array of string

removeLicenses

返回

名称 路径 类型 说明
value
value array of object

价值。

Id
value.id string

许可证对象的标识符。

货号
value.skuId string

Microsoft sku 标识符。

Sku partnumber
value.skuPartNumber string

Microsoft Sku 部分编号。

servicePlans
value.servicePlans array of object

服务计划。

servicePlanId
value.servicePlans.servicePlanId string

Serviceplan 标识符。

servicePlanName
value.servicePlans.servicePlanName string

Serviceplan 名称。

provisioning状态
value.servicePlans.provisioningStatus string

预配状态。

应用到
value.servicePlans.appliesTo string

适用于<

将成员添加到Microsoft Entra ID 组

通过成员导航属性将成员添加到 Microsoft 365 组或安全组。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft组的对象 ID。
microsoftObjectId True string

Microsoft组的对象标识符。

成员
@odata.id True string

要添加的目录、用户、组或组织联系人对象的 URI。

将成员添加到云指挥官组

将成员添加到云指挥官组,该成员应属于与该组相同的组织。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

云指挥官用户组 ID。
userGroupId True string

云指挥官用户组标识符。

云指挥官用户 ID。
userId True string

云指挥官用户标识符。

更新合作伙伴中心订阅数量

更新订阅的数量。

参数

名称 密钥 必需 类型 说明
云指挥官合作伙伴 ID。
partnerId True string

云指挥官合作伙伴标识符。

云指挥官客户 ID。
customerId True string

云指挥官客户标识符。

Microsoft客户的租户 ID。
tenantId True string

Microsoft客户的租户标识符。

订阅 ID。
subscriptionId True string

客户的订阅标识符。

数量
quantity integer

订阅的数量。

更新用户

更新用户。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft用户的对象 ID。
microsoftObjectId True string

Microsoft用户的对象标识符。

显示名称
displayName string

用户的显示名称。

givenName string

给定用户的名称。

职务
jobTitle string

用户的职务。

邮件昵称
mail string

用户的邮件昵称。

移动电话
mobilePhone string

用户的移动电话号码。

Office 位置
officeLocation string

用户的 Office 位置。

首选语言
preferredLanguage string

用户的首选语言。

Surname
surname string

用户的姓氏。

用户主体名称
userPrincipalName string

用户的用户主体名称。

已启用帐户
accountEnabled boolean

帐户已启用 true 或 false。

强制更改下一个登录密码
forceChangePasswordNextSignIn boolean

强制用户在下次登录时更改密码。

密码
password string

用户的新密码。

获取Microsoft Entra ID 安全组

获取有权查看的所有组织的Microsoft Entra ID 安全组的列表。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

返回

名称 路径 类型 说明
value
value array of object

价值。

创建时间
value.createdDateTime string

创建时间。

Displayname
value.displayName string

显示名称。

groupTypes
value.groupTypes array of string

组类型。

Id
value.id string

Microsoft组的对象标识符。

已启用安全性
value.securityEnabled boolean

指示组是否已启用安全性。

邮件
value.mail string

组的电子邮件地址。

获取云指挥官组

获取有权查看的所有组织的云指挥官组的列表。

参数

名称 密钥 必需 类型 说明
筛选组。
$filter True string

筛选组织中的组。 使用:{organizationId}'中的 organizationId。

返回

名称 路径 类型 说明
计数
@odata.count integer

OData 计数。

value
value array of object

价值。

组织编号
value.organizationId string

云指挥官组织标识符。

Name
value.name string

组名称。

Description
value.description string

组的说明。

Id
value.id string

组的标识符。

创建时间
value.createdOn string

创建时间。

修改时间
value.modifiedOn string

已修改。

获取云指挥官组成员的列表

获取特定组的云指挥官组成员的列表。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

组的云指挥官标识符。
userGroupId True string

组的云指挥官标识符。

返回

名称 路径 类型 说明
计数
@odata.count integer

OData 计数。

value
value array of object

价值。

Name
value.name string

名称。

用户主体名称
value.upn string

组的用户主体名称。

Id
value.id string

组成员对象的标识符。

组 ID
value.groupId string

组的云指挥官标识符。

创建时间
value.createdOn string

创建时间。

修改时间
value.modifiedOn string

已修改。

获取区域设置

获取区域设置。

返回

名称 路径 类型 说明
OData 上下文
@odata.context string

OData 上下文。

计数
@odata.count integer

OData 计数。

OData nextLink
@odata.nextLink string

OData nextlink。

value
value array of object

价值。

Id
value.id string

区域设置标识符。

区域设置代码
value.localeCode string

ISO-639 语言代码。

国家/地区代码
value.countryCode string

ISO-3166 国家/地区代码。

国家/地区名称
value.countryName string

国家/地区名称。

获取单个用户作业的详细信息

获取单个用户作业、提供程序和作验证的详细信息取决于特定的命令块。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

命令块 ID
commandBlockId True string

格式 - uuid。 命令块的唯一标识符。

作业 ID
jobId True string

格式 - uuid。 作业的唯一标识符。

返回

名称 路径 类型 说明
Id
id string

ID。

命令块 ID
commandBlockId string

命令块标识符。

命令集名称
commandSetName string

命令集名称。

命令集 ID
commandSetId string

命令集标识符。

命令集块 ID
commandSetBlockId string

命令集块标识符。

用户 ID
userId string

用户标识符。

用户 upn
userUpn string

用户的用户主体名称。

组 ID
groupId string

组标识符。

组名称
groupName string

组名称。

组织 ID
organizationId string

组织标识符。

组织名称
organizationName string

组织名称。

执行组件 upn
actorUserUpn string

执行组件用户主体名称。

执行组件组织 ID
actorOrganizationId string

执行组件组织标识符。

执行组件组织名称
actorOrganizationName string

执行组件组织名称。

状态
status string

状态。

执行时间
executedOn string

已执行。

命令块技术 ID
commandBlockTechnicalIdentifier string

命令块技术标识符。

命令块版本
commandBlockVersion integer

命令块版本。

layoutGroups
output.body.layoutGroups array of object

布局组格式。

layoutGroupFormats
output.body.layoutGroups.layoutGroupFormats array of object

布局组格式。

类型
output.body.layoutGroups.layoutGroupFormats.type string

类型。

属性
output.body.layoutGroups.layoutGroupFormats.property string

财产。

属性
output.body.layoutGroups.layoutGroupFormats.properties array of string

性能。

parameters
output.body.parameters array of object

参数。

技术 ID
output.body.parameters.technicalIdentifier string

技术标识符。

价值
output.body.parameters.value string

价值。

Schema
output.body.parameters.schema string

架构。

命令集
output.body.parameters.placeholderEnabled.commandSet boolean

命令集。

命令块
output.body.parameters.placeholderEnabled.commandBlock boolean

命令块。

错误代码
output.errorCode string

错误代码。

成功
output.isSuccess boolean

成功的。

layoutGroups
input.layoutGroups array of object

布局组。

layoutGroupFormats
input.layoutGroups.layoutGroupFormats array of object

布局组格式。

类型
input.layoutGroups.layoutGroupFormats.type string

类型。

属性
input.layoutGroups.layoutGroupFormats.property string

财产。

属性
input.layoutGroups.layoutGroupFormats.properties array of string

性能。

多个组织
input.multiSelection.multipleOrganizations boolean

多个组织。

多用户
input.multiSelection.multipleUsers boolean

多个用户。

parameters
input.parameters array of object

参数。

技术 ID
input.parameters.technicalIdentifier string

技术标识符。

价值
input.parameters.value string

价值。

默认值
input.parameters.defaultValue string

默认值。

类型
input.parameters.schema.type string

类型。

Format
input.parameters.schema.format string

格式。

图案
input.parameters.schema.pattern string

模式。

最小长度
input.parameters.schema.minLength string

最小长度。

命令集
input.parameters.placeholderEnabled.commandSet boolean

命令集。

命令块
input.parameters.placeholderEnabled.commandBlock boolean

命令块。

linkedCommandBlocks
input.parameters.placeholderEnabled.linkedCommandBlocks array of object

链接的命令块。

technicalIdentifier
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

技术标识符。

版本
input.parameters.placeholderEnabled.linkedCommandBlocks.version integer

版本。

获取合作伙伴中心订阅

按合作伙伴的 Active Directory 租户标识符检索合作伙伴客户的所有订阅。

参数

名称 密钥 必需 类型 说明
云指挥官合作伙伴标识符。
partnerId True string

云指挥官合作伙伴标识符。

云指挥官客户标识符。
customerId True string

云指挥官客户标识符。

Microsoft客户的租户 ID。
tenantId True string

Microsoft客户的租户标识符。

返回

名称 路径 类型 说明
总计计数
totalCount integer

订阅对象的总数。

items
items array of object

项目。

Id
items.id string

订阅的标识符。

权利 ID
items.entitlementId string

订阅的权利标识符。

友好的名称
items.friendlyName string

订阅的友好名称。

数量
items.quantity integer

订阅的数量。

单元类型
items.unitType string

订阅的单位类型。

创建时间
items.creationDate string

在订阅的日期创建。

生效日期
items.effectiveStartDate string

订阅的有效开始日期。

承诺结束日期
items.commitmentEndDate string

订阅的承诺结束日期。

状态
items.status string

订阅的状态。

自动续订
items.autoRenewEnabled boolean

指示是否为订阅启用了自动续订。

计费类型
items.billingType string

订阅的计费类型。

协定类型
items.contractType string

订阅的协定类型。

Uri
items.links.offer.uri string

订阅的 URI。

方法
items.links.offer.method string

订阅的方法。

标题
items.links.offer.headers array of

头。

Uri
items.links.self.uri string

订阅的 URI。

方法
items.links.self.method string

订阅的方法。

标题
items.links.self.headers array of

头。

订单 ID
items.orderId string

订阅的订单标识符。

Etag
items.attributes.etag string

订阅的 Etag。

对象类型
items.attributes.objectType string

订阅的对象类型。

对象类型
attributes.objectType string

订阅的对象类型。

获取命令块详细信息

获取命令块的详细信息。 提供程序和作验证取决于特定的命令块。

参数

名称 密钥 必需 类型 说明
命令块 ID
commandBlockId True string

格式 - uuid。 命令块的唯一标识符。

返回

名称 路径 类型 说明
Id
id string

ID。

版本
version integer

版本。

类别 ID
categoryId string

类别 ID。

技术 ID
technicalIdentifier string

技术标识符。

所需的读取作
requiredReadAction string

所需的读取作。

所需的写入作
requiredWriteAction string

所需的写入作。

必需的提供程序
requiredProvider string

必需的提供程序。

类型
type string

类型。

Id
category.id string

ID。

技术 ID
category.technicalIdentifier string

技术标识符。

Id
parentCategory.id string

ID。

技术 ID
parentCategory.technicalIdentifier string

技术标识符。

Id
menuCategory.id string

ID。

技术 ID
menuCategory.technicalIdentifier string

技术标识符。

多选
commandInput.multiSelection string

多选。

layoutGroups
commandInput.layoutGroups array of object

布局组。

技术 ID
commandInput.layoutGroups.technicalIdentifier string

技术标识符。

layoutGroupFormats
commandInput.layoutGroups.layoutGroupFormats array of object

布局组格式。

类型
commandInput.layoutGroups.layoutGroupFormats.type string

类型。

属性
commandInput.layoutGroups.layoutGroupFormats.property string

财产。

属性
commandInput.layoutGroups.layoutGroupFormats.properties array of

性能。

parameters
commandInput.parameters array of object

参数。

默认值
commandInput.parameters.defaultValue string

默认值。

技术 ID
commandInput.parameters.technicalIdentifier string

技术标识符。

Schema
commandInput.parameters.schema string

架构。

敏感
commandInput.parameters.sensitive boolean

灵敏。

必选
commandInput.parameters.required boolean

必填。

价值
commandInput.parameters.value string

价值。

命令集
commandInput.parameters.placeholderEnabled.commandSet boolean

命令集。

命令块
commandInput.parameters.placeholderEnabled.commandBlock boolean

命令块。

linkedCommandBlocks
commandInput.parameters.placeholderEnabled.linkedCommandBlocks array of object

链接的命令块。

technicalIdentifier
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

技术标识符。

版本
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version integer

版本。

layoutGroups
commandOutput.layoutGroups array of object

布局组。

技术 ID
commandOutput.layoutGroups.technicalIdentifier string

技术标识符。

layoutGroupFormats
commandOutput.layoutGroups.layoutGroupFormats array of object

布局组格式。

类型
commandOutput.layoutGroups.layoutGroupFormats.type string

类型。

属性
commandOutput.layoutGroups.layoutGroupFormats.property string

财产。

属性
commandOutput.layoutGroups.layoutGroupFormats.properties array of

性能。

parameters
commandOutput.parameters array of object

参数。

Example
commandOutput.parameters.example string

示例。

技术 ID
commandOutput.parameters.technicalIdentifier string

技术标识符。

Schema
commandOutput.parameters.schema string

架构。

敏感
commandOutput.parameters.sensitive boolean

灵敏。

必选
commandOutput.parameters.required boolean

必填。

价值
commandOutput.parameters.value string

价值。

命令集
commandOutput.parameters.placeholderEnabled.commandSet boolean

命令集。

命令块
commandOutput.parameters.placeholderEnabled.commandBlock boolean

命令块。

获取命令类别

获取所有可用的类别和子类别。

参数

名称 密钥 必需 类型 说明
$top项
$top string

仅返回第一个$top项。

$skip项
$skip string

要跳过的项目数。

选择筛选器
$select string

$select odata 筛选器。

订单依据
$orderby string

确定用于对记录集合进行排序的值。

过滤器
$filter string

一个函数,必须计算结果为 true 才能返回记录。

计数
$count string

确定天气或不包括集合中的项计数。

返回

名称 路径 类型 说明
OData 上下文
@odata.context string

OData 上下文。

OData 计数
@odata.count integer

OData 计数。

OData 下一个链接
@odata.nextLink string

OData 下一个链接。

value
value array of object

价值。

Id
value.id string

ID。

技术 ID
value.technicalIdentifier string

技术标识符。

父类别 ID
value.parentCategoryId string

父类别标识符。

获取所有已授权组织的命令块作业的统计信息

获取有权查看的命令块的命令块作业的统计信息。

参数

名称 密钥 必需 类型 说明
类别 ID
categoryId True string

格式 - uuid。 类别的唯一标识符。

选择筛选器
$select string

$select odata 筛选器。

返回

名称 路径 类型 说明
OData 上下文
@odata.context string

OData 上下文。

类型
type string

类型。

类别
category string

类别。

期限
period string

期间。

完成
completed integer

完成。

已排队
queued integer

排队。

已失败
failed integer

失败。

获取所有已授权组织的命令阻止作业

获取有权查看的命令块的命令块作业。

参数

名称 密钥 必需 类型 说明
$top项
$top string

仅返回第一个$top项。

$skip项
$skip string

要跳过的项目数。

选择筛选器
$select string

$select odata 筛选器。

订单依据
$orderby string

确定用于对记录集合进行排序的值。

过滤器
$filter string

一个函数,必须计算结果为 true 才能返回记录。

计数
$count string

确定项计数是否应包含在集合中。

返回

名称 路径 类型 说明
OData 上下文
@odata.context string

OData 上下文。

OData 计数
@odata.count integer

OData 计数。

OData 下一个链接
@odata.nextLink string

OData 下一个链接

value
value array of object

价值。

Id
value.id string

标识符。

命令块 ID
value.commandBlockId string

命令块标识符。

命令集名称
value.commandSetName string

命令集名称。

命令集 ID
value.commandSetId string

命令集标识符

命令集块 ID
value.commandSetBlockId string

命令集块标识符。

用户 ID
value.userId string

用户标识符。

用户主体名称
value.userUpn string

用户主体名称。

组 ID
value.groupId string

组标识符。

组名称
value.groupName string

组名称。

组织 ID
value.organizationId string

组织标识符。

组织名称
value.organizationName string

组织名称。

执行组件用户 upn
value.actorUserUpn string

执行组件用户主体名称。

执行组件组织 ID
value.actorOrganizationId string

执行组件组织标识符。

执行组件组织名称
value.actorOrganizationName string

执行组件组织名称。

状态
value.status string

状态。

执行时间
value.executedOn string

已执行。

命令块技术 ID
value.commandBlockTechnicalIdentifier string

命令块技术标识符。

命令块版本
value.commandBlockVersion integer

命令块版本。

计划内执行
value.plannedExecution string

计划内执行。

计划 ID
value.scheduleId string

计划标识符。

计划名称
value.scheduleName string

计划名称。

获取特定组织的命令块作业

获取有权查看的命令块的命令块作业。

参数

名称 密钥 必需 类型 说明
组织 ID。
organizationId True string

格式 - uuid。 组织的唯一标识符。

$top项
$top string

仅返回第一个$top项。

$skip项
$skip string

要跳过的项目数。

选择筛选器
$select string

$select odata 筛选器。

订单依据
$orderby string

确定用于对记录集合进行排序的值。

过滤器
$filter string

一个函数,必须计算结果为 true 才能返回记录。

计数
$count string

确定天气或不包括集合中的项计数。

返回

名称 路径 类型 说明
OData 上下文
@odata.context string

OData 上下文。

OData 计数
@odata.count integer

OData 计数。

OData nextlink
@odata.nextLink string

OData nextlink。

value
value array of object

价值。

Id
value.id string

ID。

命令块 ID
value.commandBlockId string

命令块标识符。

命令集名称
value.commandSetName string

命令集名称。

命令集 ID
value.commandSetId string

命令集标识符。

命令集块 ID
value.commandSetBlockId string

命令集块标识符。

用户 ID
value.userId string

用户标识符。

用户 upn
value.userUpn string

用户主体名称。

组 ID
value.groupId string

组标识符。

组名称
value.groupName string

组名称。

组织 ID
value.organizationId string

组织标识符。

组织名称
value.organizationName string

组织名称。

执行组件用户主体名称
value.actorUserUpn string

执行组件用户主体名称。

执行组件组织 ID
value.actorOrganizationId string

执行组件组织标识符。

执行组件组织名称
value.actorOrganizationName string

执行组件组织名称。

状态
value.status string

状态。

执行时间
value.executedOn string

已执行。

命令块技术 ID
value.commandBlockTechnicalIdentifier string

命令块技术标识符。

命令块版本
value.commandBlockVersion integer

命令块版本。

计划内执行
value.plannedExecution string

计划内执行。

计划 ID
value.scheduleId string

计划标识符。

计划名称
value.scheduleName string

计划名称。

获取用户许可证详细信息

检索企业用户的许可证详细信息对象列表。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft用户的对象 ID。
microsoftObjectId True string

Microsoft用户的对象标识符。

返回

名称 路径 类型 说明
value
value array of object

价值。

Id
value.id string

用户的许可证标识符。

货号
value.skuId string

Microsoft许可证的 SKU 标识符。

Sku partnumber
value.skuPartNumber string

Microsoft 许可证的 Sku 部分编号。

servicePlans
value.servicePlans array of object

服务计划。

servicePlanId
value.servicePlans.servicePlanId string

Serviceplan 标识符。

servicePlanName
value.servicePlans.servicePlanName string

Serviceplan 名称。

provisioning状态
value.servicePlans.provisioningStatus string

预配状态。

应用到
value.servicePlans.appliesTo string

适用于<

获取用户详细信息

通过Microsoft对象标识符获取用户。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft用户的对象 ID。
microsoftObjectId True string

Microsoft用户的对象标识符。

返回

名称 路径 类型 说明
已启用帐户
accountEnabled boolean

帐户已启用 true 或 false。

员工 ID
employeeId string

用户的员工标识符。

显示名称
displayName string

用户的显示名称。

givenName string

给定用户的名称。

Surname
surname string

用户的姓氏。

用户主体名称
userPrincipalName string

用户的用户主体名称。

职务
jobTitle string

用户的职务。

Department
department string

用户的部门。

公司名称
companyName string

用户的公司名称。

Usagelocation
usageLocation string

用户的使用位置。

街道地址
streetAddress string

用户的街道地址。

City
city string

用户城市。

State
state string

用户的状态。

邮政编码
postalCode string

用户的邮政编码。

国家
country string

用户的国家/地区。

获取管理器

获取用户的经理。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

Microsoft用户的对象 ID。
microsoftObjectId True string

Microsoft用户的对象标识符。

返回

名称 路径 类型 说明
计数
@odata.count integer

组织计数。

value
value array of object

value

Name
value.name string

组织的名称。

Microsoft租户 ID
value.microsoftTenantId string

唯一Microsoft用户标识符。

Microsoft CSP 类型
value.type string

Microsoft CSP 合作伙伴类型。

产品 ID
value.productIdentifier string

N 个可识别的产品标识符。

产品 ID 类型
value.productIdentifierType string

N 型产品标识符类型。

已启用混合标识
value.hybridADEnabled boolean

已启用混合标识。

创建时间
value.createdOn string

创建时间。

修改时间
value.modifiedOn string

已修改。

Id
value.id string

组织的唯一标识符。

获取组织订阅的 SKU

获取组织已获取的商业订阅的列表。

参数

名称 密钥 必需 类型 说明
云指挥官组织 ID。
organizationId True string

云指挥官组织标识符。

返回

名称 路径 类型 说明
value
value array of object

价值。

功能状态
value.capabilityStatus string

Microsoft sku 的功能状态。

已用单位
value.consumedUnits integer

此 SKU 的已用单位。

Id
value.id string

已订阅 SKU 对象的标识符。

货号
value.skuId string

Microsoft许可证的 SKU 标识符。

Sku partnumber
value.skuPartNumber string

Microsoft 许可证的 Sku 部分编号。

适用于
value.appliesTo string

适用于用户或组织。

已启用
value.prepaidUnits.enabled integer

已启用已订阅的 SKU。

已挂起
value.prepaidUnits.suspended integer

已暂停的已订阅 SKU。

警告
value.prepaidUnits.warning integer

带有警告的订阅 SKU。

servicePlans
value.servicePlans array of object

服务计划。

servicePlanId
value.servicePlans.servicePlanId string

Serviceplan 标识符。

servicePlanName
value.servicePlans.servicePlanName string

Serviceplan 名称。

provisioning状态
value.servicePlans.provisioningStatus string

预配状态。

应用到
value.servicePlans.appliesTo string

适用于<

设置 OneDrive 网站权限

设置 OneDrive 网站权限。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

目标用户 ID
targetUserId True string

格式 - uuid。 目标用户的唯一标识符。

技术标识符
technicalIdentifier True string

技术标识符。

价值
value True string

价值。

返回

名称 路径 类型 说明
价值
value string

价值。

设置邮箱转发地址

设置邮箱转发地址。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

目标用户 ID
targetUserId True string

格式 - uuid。 目标用户的唯一标识符。

技术标识符
technicalIdentifier True string

技术标识符。

价值
value True string

价值。

返回

名称 路径 类型 说明
价值
value string

价值。

转换为共享邮箱

将用户邮箱转换为共享邮箱。

参数

名称 密钥 必需 类型 说明
组织编号
organizationId True string

格式 - uuid。 组织的唯一标识符。

目标用户 ID
targetUserId True string

格式 - uuid。 目标用户的唯一标识符。

技术标识符
technicalIdentifier True string

技术标识符。

价值
value True string

价值。

返回

名称 路径 类型 说明
价值
value string

价值。