organizationalBrandingProperties 资源类型organizationalBrandingProperties resource type

重要

Microsoft Graph /beta 中版本下的 API 可能会更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported. 若要确定 API 在 v1.0 中是否可用,请使用 版本选择 器。To determine whether an API is available in v1.0, use the Version selector.

备注

添加自定义品牌打造需要你使用 Azure Active Directory Premium 1、Premium 2 或 Basic 版本,或拥有 Microsoft 365 许可证。Adding custom branding requires you to use Azure Active Directory Premium 1, Premium 2, or Basic editions, or to have a Microsoft 365 license. 有关许可和版本详细信息,请参阅注册 Azure AD Premium。For more information about licensing and editions, see Sign up for Azure AD Premium.

Azure AD Premium 和 Basic 版本适用于使用 Azure Active Directory 全球实例的中国客户。Azure AD Premium and Basic editions are available for customers in China using the worldwide instance of Azure Active Directory. Azure AD Premium 和 Basic 版本目前在中国由世纪银行运营的 Azure 服务中不受支持。Azure AD Premium and Basic editions aren't currently supported in the Azure service operated by 21Vianet in China. 有关详细信息,请通过 Azure Active Directory论坛与我们联系。For more information, talk to us using the Azure Active Directory Forum.

包含有关组织品牌的详细信息。Contains details about the organization's branding.

组织可以自定义其 Azure AD 登录页,这些页面在用户登录到其组织的租户特定应用时显示,或者当 Azure AD 通过用户名标识用户的租户时显示。Organizations can customize their Azure AD sign-in pages which appear when users sign in to their organization's tenant-specific apps, or when Azure AD identifies the user's tenant from their username. 开发人员还可以阅读公司的品牌信息并自定义其应用体验,以使用其公司品牌专门为登录用户定制它。A developer can also read the company's branding information and customize their app experience to tailor it specifically for the signed-in user using their company's branding.

公司可以基于区域设置添加不同的品牌。Companies can add different branding based on locale. 区域设置在所有请求中都用作键。Locale serves as a key in all requests.

注意: 品牌打造作为组织下具有特定于区域设置本地化的集合的属性公开。Note: Branding is exposed as a property under organization with a collection of locale-specific localizations. organizationalBrandingProperties 是一个抽象类,用于定义 organizationalBranding 的属性organizationalBrandingProperties is an abstract class which defines properties for organizationalBranding.

方法Methods

方法Method 返回类型Return Type 说明Description
创建Create organizationalBrandingPropertiesorganizationalBrandingProperties 使用 organizationalBrandingProperties 对象创建组织品牌。Create organizational branding with organizationalBrandingProperties object.
GetGet organizationalBrandingPropertiesorganizationalBrandingProperties 读取 organizationalBrandingProperties 对象的属性和关系。Read properties and relationships of organizationalBrandingProperties object.
更新Update organizationalBrandingPropertiesorganizationalBrandingProperties 更新 organizationalBrandingProperties 对象。Update organizationalBrandingProperties object.
删除Delete None 删除 organizationalBrandingProperties 对象。Delete organizationalBrandingProperties object.

属性Properties

属性Property 类型Type 说明Description
backgroundColorbackgroundColor StringString 在低带宽连接中将出现在背景图像的位置的颜色。Color that will appear in place of the background image in low-bandwidth connections. 建议在此处使用横幅徽标或组织颜色的主要颜色。The primary color of your banner logo or your organization color is recommended to be used here. 以十六进制表示 (,例如,白色#FFFFFF) 。Specify this in hexadecimal (for example, white is #FFFFFF).
backgroundImagebackgroundImage StreamStream 显示为登录页背景的图像。Image that appears as the background of the sign in page. .png 或 .jpg 不大于 1920x1080 且小于 300kb。.png or .jpg not larger than 1920x1080 and smaller than 300kb. 较小的图像将降低带宽要求,使页面加载性能提高。A smaller image will reduce bandwidth requirements and make page loads more performant.
bannerLogobannerLogo StreamStream 显示在登录页上的公司徽标的横幅版本。A banner version of your company logo which appears appears on the sign-in page. .png 或 .jpg 不超过 36x245px。.png or .jpg no larger than 36x245px. 我们建议使用透明图像,徽标周围没有填充。We recommend using a transparent image with no padding around the logo.
idid StringString 这是一个继承自 microsoft.graph.entity 的 ID,是指定语言 ISO 639 标准(例如英语为"en-us"或"en")区域设置。This is an id, inherited from microsoft.graph.entity, is the locale specifying the ISO 639 standard for language, for example English is "en-us" or "en". 今后,如果我们公开功能以针对一个区域设置具有多个品牌,这一点可能会更改。Going forward if we expose functionality to have multiple brandings for one locale, this can be changed. 请注意,默认 /branding 的 ID 始终为"und",直到有无键单一标识。Note that id for Default /branding is always 'und' until we have keyless singletons. 只读。Read-only.
signInPageTextsignInPageText StringString 显示在登录框底部的文本。Text that appears at the bottom of the sign-in box. 您可以使用此信息来传达其他信息,例如电话号码到技术支持或法律声明。You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. 此文本必须是 Unicode 且不超过 1024 个字符。This text must be Unicode and not exceed 1024 characters.
squareLogosquareLogo StreamStream 公司徽标的方形版本。Square version of your company logo. 这将显示在 Windows 10 现成 (OOBE) 以及启用 Windows Autopilot 进行部署时。This appears in Windows 10 out-of-box (OOBE) experiences and when Windows Autopilot is enabled for deployment. .png 或 .jpg 大小不超过 240x240px,不超过 10kb。.png or .jpg no larger than 240x240px and no more than 10kb in size. 我们建议使用透明图像,徽标周围没有填充。We recommend using a transparent image with no padding around the logo.
usernameHintTextusernameHintText StringString 在登录屏幕上的用户名文本框中作为提示显示的字符串。String that shows as the hint in the username textbox on the sign in screen. 此文本必须是 Unicode,没有链接或代码,并且不能超过 64 个字符。This text must be Unicode, without links or code, and can't exceed 64 characters.

关系Relationships

None

JSON 表示形式JSON representation

下面是资源的 JSON 表示形式。The following is a JSON representation of the resource.

{
  "backgroundColor": "String",
  "backgroundImage": "Stream",
  "bannerLogo": "Stream",
  "id": "String (identifier)",
  "signInPageText": "String",
  "squareLogo": "Stream",
  "usernameHintText": "String"
}