organizationalBranding 资源类型
命名空间:microsoft.graph
包含有关组织的默认品牌的详细信息。 继承自 organizationalBrandingProperties。
组织可以自定义Azure Active Directory (Azure AD) 登录页面,当用户登录到其组织的租户特定应用时,或当用户Azure AD用户名标识用户的租户时,会显示这些页面。 开发人员还可以阅读公司的品牌信息并自定义其应用体验,以使用其公司的品牌专门为登录用户定制它。
你无法更改原始配置的语言。 但是,公司可以基于区域设置添加不同的品牌。 有关特定语言的品牌,请参阅 organizationalBrandingLocalization 对象。
备注
添加自定义品牌打造需要你拥有 Azure Active Directory (Azure AD) 高级版 1、高级版 2 或 Office 365 (Office 365许可证) 应用。 有关许可和版本详细信息,请参阅注册Azure AD Premium。
Azure AD Premium全球实例为中国客户提供 Azure Active Directory。 Azure AD Premium由世纪银行在中国运营的 Azure 服务中目前不支持任何版本。 有关详细信息,请通过 Azure Active Directory论坛与我们联系。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| Get organizationalBranding | organizationalBranding | 读取 organizationalBranding 对象的属性和 关系。 |
| Update organizationalBranding | 无 | 更新 organizationalBranding 对象 的属性。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| backgroundColor | String | 将出现在低带宽连接中的背景图像上的颜色。 我们建议你使用横幅徽标的主要颜色或你的组织颜色。 以十六进制格式指定此参数,例如,white 为 #FFFFFF 。 继承自 organizationalBrandingProperties。 |
| backgroundImage | Stream | 显示为登录页背景的图像。 允许的类型是 PNG 或 JPEG,不小于 300 KB 且不超过 1920 × 1080 像素。 较小的图像将降低带宽要求,并加快页面加载速度。 继承自 organizationalBrandingProperties。 仅在 $select 上返回。 |
| backgroundImageRelativeUrl | String | backgroundImage 属性的相对 URL,与 cdnList CDN基 URL 结合使用以提供由 CDN。 只读。 继承自 organizationalBrandingProperties。 |
| bannerLogo | Stream | 显示在登录页上的公司徽标的横幅版本。 允许的类型为 PNG 或 JPEG,不超过 36 × 245 像素。 我们建议使用透明图像,徽标周围没有填充。 继承自 organizationalBrandingProperties。 仅在 $select 上返回。 |
| bannerLogoRelativeUrl | String | bannerLogo 属性的相对 URL,与 cdnList CDN基 URL 结合使用以提供由 CDN 提供的只读版本。 只读。 继承自 organizationalBrandingProperties。 |
| cdnList | 字符串集合 | 提供当前资源资产的所有可用CDN提供程序的基本 URL 列表。 多个CDN提供程序同时用于读取请求的高可用性。 只读。 继承自 organizationalBrandingProperties。 |
| id | String | 表示使用区域性名称指定的区域设置的标识符。 区域性名称遵循 RFC 1766 标准,格式为"languagecode2-country/regioncode2",其中"languagecode2"是派生自 ISO 639-1 的大写两字母代码,而"country/regioncode2"是派生自 ISO 3166 的大写两字母代码。 例如,美国英语为 en-US 。 默认 /branding 的 ID 始终为 String 0 类型或 default 。 只读。 注意: 目前不支持单个区域设置的多个品牌。 继承自 organizationalBrandingProperties。 |
| signInPageText | String | 显示在登录框底部的文本。 您可以使用此信息来传达其他信息,例如电话号码到技术支持或法律声明。 此文本必须是 Unicode 且不超过 1024 个字符。 继承自 organizationalBrandingProperties。 |
| squareLogo | Stream | 现现Windows 10 OOBE (和启用 Windows Autopilot 进行部署时) 显示公司徽标的正方形版本。 允许的类型为 PNG 或 JPEG,不超过 240 x 240 像素,大小不超过 10 KB。 我们建议使用透明图像,徽标周围没有填充。 继承自 organizationalBrandingProperties。 仅在 $select 上返回。 |
| squareLogoRelativeUrl | String | squareLogo 属性的相对 URL,与 cdnList CDN基 URL 结合使用以提供由 CDN。 只读。 继承自 organizationalBrandingProperties。 |
| usernameHintText | String | 在登录屏幕的用户名文本框中显示为提示的字符串。 此文本必须是不带链接或代码的 Unicode,并且不能超过 64 个字符。 继承自 organizationalBrandingProperties。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| 本地化 | organizationalBrandingLocalization 集合 | 根据区域设置添加不同的品牌。 |
JSON 表示形式
下面是资源的 JSON 表示形式。
{
"@odata.type": "#microsoft.graph.organizationalBranding",
"id": "String (identifier)",
"backgroundColor": "String",
"backgroundImage": "Stream",
"backgroundImageRelativeUrl": "String",
"bannerLogo": "Stream",
"bannerLogoRelativeUrl": "String",
"cdnList": [
"String"
],
"signInPageText": "String",
"squareLogo": "Stream",
"squareLogoRelativeUrl": "String",
"usernameHintText": "String"
}
反馈
提交和查看相关反馈