你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get-AzADServicePrincipal
按键列出服务主体中的实体或从服务主体获取实体
语法
Get-AzADServicePrincipal
[-Select <String[]>]
[-Count]
[-Filter <String>]
[-Orderby <String[]>]
[-Search <String>]
[-ConsistencyLevel <String>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[-CountVariable <String>]
[<CommonParameters>]
Get-AzADServicePrincipal
-ObjectId <String>
[-Select <String[]>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzADServicePrincipal
[-Select <String[]>]
-DisplayNameBeginsWith <String>
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzADServicePrincipal
[-Select <String[]>]
-DisplayName <String>
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzADServicePrincipal
[-Select <String[]>]
-ApplicationId <Guid>
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzADServicePrincipal
[-Select <String[]>]
-ApplicationObject <IMicrosoftGraphApplication>
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzADServicePrincipal
[-Select <String[]>]
-ServicePrincipalName <String>
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
说明
按键列出服务主体中的实体或从服务主体获取实体
示例
示例 1:按显示名称获取服务主体
Get-AzADServicePrincipal -DisplayName $name
按显示名称获取服务主体
示例 2:搜索服务主体显示名称开头
Get-AzADServicePrincipal -DisplayNameStartsWith $prefix
搜索服务主体显示名称开头
示例 3:列出服务主体
Get-AzADServicePrincipal -First 10 -Select Tags -AppendSelected
列出前 10 个服务主体,并在默认属性后追加属性“Tags”:“DisplayName”、“Id”、“DeletedDateTime”、“ServicePrincipalNames”、“AppId”
示例 4:按应用程序 ID 获取服务主体
Get-AzADServicePrincipal -ApplicationId $appId
按应用程序 ID 获取服务主体
示例 5:按管道输入获取服务主体
Get-AzADApplication -DisplayName $name | Get-AzADServicePrincipal
通过管道输入获取服务主体
示例 6:使用筛选器获取服务主体
Get-AzADServicePrincipal -Filter "startsWith(DisplayName,'some-name')"
使用筛选器获取服务主体
示例 7:将 OdataCount 分配到变量
Get-AzADServicePrincipal -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result'
$result
将 OdataCount 分配到变量
参数
-AppendSelected
当此开关处于打开状态时,使用默认属性选择的追加属性,仅适用于参数“-Select”。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ApplicationId
serviceprincipal 的应用程序 ID
类型: | Guid |
别名: | AppId |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-ApplicationObject
服务主体对象可用作管道输入。 若要构造,请参阅 APPLICATIONOBJECT 属性的 NOTES 部分并创建哈希表。
类型: | IMicrosoftGraphApplication |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-ConsistencyLevel
指示请求的一致性级别。 文档 URL: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Count
包括项计数
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-CountVariable
指定集合中项总数的计数。 默认情况下,此变量将在全局范围内设置。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
类型: | PSObject |
别名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DisplayName
serviceprincipal 显示名称
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-DisplayNameBeginsWith
serviceprincipal 显示名称以 开头
类型: | String |
别名: | DisplayNameStartsWith, SearchString |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Filter
按属性值筛选项,有关筛选查询的更多详细信息,请参阅: https://learn.microsoft.com/en-us/graph/filter-query-parameter
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-First
仅获取第一个“n”对象。
类型: | UInt64 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ObjectId
键:servicePrincipal 的 ID
类型: | String |
别名: | ServicePrincipalId, Id |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Orderby
按属性值对项进行排序
类型: | String[] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Search
按搜索短语搜索项目
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Select
选择要返回的属性
类型: | String[] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ServicePrincipalName
serviceprincipal 名称
类型: | String |
别名: | SPN |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Skip
忽略第一个“n”对象,然后获取剩余的对象。
类型: | UInt64 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
输入
输出
IMicrosoftGraphServicePrincipal
备注
别名
复杂参数属性
若要创建下面所述的参数,请构造一个包含相应属性的哈希表。 有关哈希表的信息,请运行 Get-Help about_Hash_Tables。
APPLICATIONOBJECT <IMicrosoftGraphApplication>
:服务主体对象可用作管道输入。
[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称[AddIn <IMicrosoftGraphAddIn[]>]
:定义使用服务可用于在特定上下文中调用应用的自定义行为。 例如,可以呈现文件流的应用程序可以为其“FileHandler”功能设置 addIns 属性。 这样,Office 365 等服务就可以在用户正在处理的文档上下文中调用应用程序。[Id <String>]
:[Property <IMicrosoftGraphKeyValue[]>]
:[Key <String>]
:钥匙。[Value <String>]
:价值。
[Type <String>]
:
[Api <IMicrosoftGraphApiApplication>]
:apiApplication[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[AcceptMappedClaim <Boolean?>]
:如果为 true,则允许应用程序在不指定自定义签名密钥的情况下使用声明映射。[KnownClientApplication <String[]>]
:如果你的解决方案包含两个部分:客户端应用和自定义 Web API 应用,则用于捆绑同意。 如果将客户端应用的 appID 设置为此值,则用户仅向客户端应用授予同意一次。 Azure AD 知道同意客户端意味着隐式同意 Web API,并同时自动为这两个 API 预配服务主体。 客户端和 Web API 应用都必须在同一个租户中注册。[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
:此应用程序注册所表示的 Web API 公开的委托权限的定义。 这些委派权限可由客户端应用程序请求,并且可在同意期间由用户或管理员授予。 委派权限有时称为 OAuth 2.0 范围。[AdminConsentDescription <String>]
:委派权限的说明,旨在由代表所有用户授予权限的管理员读取。 此文本显示在租户范围的管理员许可体验中。[AdminConsentDisplayName <String>]
:权限的标题,旨在由代表所有用户授予权限的管理员读取。[Id <String>]
:资源应用程序定义的委派权限集合中的唯一委派权限标识符。[IsEnabled <Boolean?>]
:创建或更新权限时,此属性必须设置为 true(默认值)。 若要删除权限,必须先将此属性设置为 false。 此时,在后续调用中,可能会删除权限。[Origin <String>]
:[Type <String>]
:指定是否应将此委派权限视为安全权限,以便非管理员用户代表自己同意,还是需要管理员才能同意权限。 这是默认行为,但每位客户都可以选择自定义其组织中的行为(通过允许、限制或限制用户对此委派权限的同意)。[UserConsentDescription <String>]
:委托权限的说明,旨在由代表自己授予权限的用户读取。 此文本显示在用户仅代表自己同意的同意体验中。[UserConsentDisplayName <String>]
:权限的标题,旨在由代表自己授予权限的用户读取。 此文本显示在用户仅代表自己同意的同意体验中。[Value <String>]
:指定要包含在访问令牌中的 scp(scope) 声明中的值。 长度不得超过 120 个字符。 允许的字符为 : ! # $ % & ' ( ) * + , - . / : ;= ? @ [ ] ^ + _ { } ~,以及范围 0-9、A-Z 和 a-z 中的字符。 不允许任何其他字符(包括空格字符)。 可能不是以 .开头。
[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]
:列出使用指定委派权限预先授权的客户端应用程序,以访问此应用程序的 API。 用户无需同意任何预先授权的应用程序(针对指定的权限)。 但是,preAuthorizedApplications 中未列出的任何其他权限(例如,通过增量许可请求)都需要用户同意。[AppId <String>]
:应用程序的唯一标识符。[DelegatedPermissionId <String[]>]
:应用程序所需的 oauth2PermissionScopes 的唯一标识符。
[RequestedAccessTokenVersion <Int32?>]
:指定此资源预期的访问令牌版本。 这会更改独立于用于请求访问令牌的终结点或客户端生成的 JWT 的版本和格式。 使用的端点 v1.0 或 v2.0 由客户端选择,仅影响 id_tokens 的版本。 资源需要显式配置 requestedAccessTokenVersion 以指示支持的访问令牌格式。 requestedAccessTokenVersion 可能的值为 1、2 或 null。 如果值为 null,则默认为 1,这对应于 v1.0 终结点。 如果应用程序的 signInAudience 配置为 AzureADandPersonalMicrosoftAccount,则此属性的值必须为 2
[AppRole <IMicrosoftGraphAppRole[]>]
:分配给应用程序的角色的集合。 通过应用角色分配,可以将这些角色分配给与其他应用程序关联的用户、组或服务主体。 不可为 Null。[AllowedMemberType <String[]>]
:指定此应用角色是否可以分配给用户和组(通过设置为 ['User'])、其他应用程序的 (通过设置为 ['Application'] 或两者(通过设置为 ['User', 'Application']) 。 支持分配给其他应用程序服务主体的应用角色也称为应用程序权限。 仅应用程序实体上定义的应用角色支持“应用程序”值。[Description <String>]
:应用角色的说明。 在分配应用角色时,如果应用角色在许可体验期间充当应用程序权限,则会显示这一点。[DisplayName <String>]
:应用角色分配和许可体验中显示的权限的显示名称。[Id <String>]
:appRoles 集合中的唯一角色标识符。 创建新应用角色时,必须提供新的 Guid 标识符。[IsEnabled <Boolean?>]
:创建或更新应用角色时,必须将其设置为 true(默认值)。 若要删除角色,必须先将其设置为 false。 此时,在后续调用中,可能会删除此角色。[Value <String>]
:指定要包含在 ID 令牌中的角色声明中的值,以及对分配的用户或服务主体进行身份验证的访问令牌。 长度不得超过 120 个字符。 允许的字符为 : ! # $ % & ' ( ) * + , - . / : ;= ? @ [ ] ^ + _ { } ~,以及范围 0-9、A-Z 和 a-z 中的字符。 不允许任何其他字符(包括空格字符)。 可能不是以 .开头。
[ApplicationTemplateId <String>]
:applicationTemplate 的唯一标识符。[CreatedOnBehalfOfDeletedDateTime <DateTime?>]
:[CreatedOnBehalfOfDisplayName <String>]
:目录中显示的名称[Description <String>]
:应用程序的可选说明。 默认返回。 支持$filter(eq、ne、NOT、ge、le、startsWith)和$search。[DisabledByMicrosoftStatus <String>]
:指定Microsoft是否已禁用已注册的应用程序。 可能的值包括:null(默认值)、NotDisabled 和 DisabledDueToViolationOfServicesAgreement(原因可能包括可疑、滥用或恶意活动,或违反Microsoft服务协议)。 支持$filter(eq、ne、NOT)。[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]
:应用程序的联合标识。 支持$expand和$filter(计算空集合时的 eq)。[Audience <String[]>]
:列出可在外部令牌中显示的访问群体。 此字段是必需的,默认为“api://AzureADTokenExchange”。 它说,Microsoft 标识平台应该接受在传入令牌的 aud 声明中。 此值表示外部标识提供者中的 Azure AD,在标识提供者中没有固定值 - 可能需要在标识提供者中创建新的应用程序注册,以充当此令牌的受众。 必需。[Description <String>]
:未验证的联合标识凭据的用户提供的说明。 可选。[Issuer <String>]
:外部标识提供者的 URL,必须与交换的外部令牌的颁发者声明匹配。 颁发者和使用者的值的组合在应用上必须是唯一的。 必需。[Name <String>]
:是联合标识凭据的唯一标识符,该凭据的字符限制为 120 个字符,并且必须对 URL 友好。 它在创建后就不可变。 必需。 不可为 Null。 支持$filter(eq)。[Subject <String>]
:必需。 外部标识提供者中外部软件工作负荷的标识符。 与受众值一样,它没有固定格式,因为每个标识提供者都使用自己的格式-有时是 GUID,有时是冒号分隔标识符,有时是任意字符串。 此处的值必须与提供给 Azure AD 的令牌中的子声明匹配。 颁发者和使用者的组合在应用上必须是唯一的。 支持$filter(eq)。
[GroupMembershipClaim <String>]
:配置应用程序所需的用户或 OAuth 2.0 访问令牌中颁发的组声明。 若要设置此属性,请使用以下字符串值之一:None、SecurityGroup(对于安全组和 Azure AD 角色)、“所有”(这将获取登录用户所属的所有安全组、通讯组和 Azure AD 目录角色)。[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
:[AppliesTo <IMicrosoftGraphDirectoryObject[]>]
:[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]
:与租户关联的服务计划集合。 不可为 Null。[AssignedDateTime <DateTime?>]
:分配计划的日期和时间。 时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。[CapabilityStatus <String>]
:功能分配的条件。 可能的值为 Enabled、Warning、Suspended、Deleted、LockedOut。 请参阅每个值的详细说明。[Service <String>]
:服务的名称;例如,exchange。[ServicePlanId <String>]
:标识服务计划的 GUID。 有关 GUID 及其等效友好服务名称的完整列表,请参阅许可的产品名称和服务计划标识符。
[Branding <IMicrosoftGraphOrganizationalBranding>]
:organizationalBranding[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[BackgroundColor <String>]
:将在低带宽连接中代替背景图像的颜色。 建议使用横幅徽标或组织颜色的主要颜色。 以十六进制格式指定此值,例如,白色 #FFFFFF。[BackgroundImage <Byte[]>]
:显示为登录页面背景的图像。 允许的类型为 PNG 或 JPEG 不小于 300 KB,且不超过 1920 × 1080 像素。 较小的映像将降低带宽要求,并加快页面加载速度。[BackgroundImageRelativeUrl <String>]
:backgroundImage 属性的相对 URL,它与 cdnList 中的 CDN 基 URL 相结合,以提供 CDN 提供的版本。 只读。[BannerLogo <Byte[]>]
:登录页上显示的公司徽标的横幅版本。 允许的类型为 PNG 或 JPEG,不超过 36 × 245 像素。 建议使用没有在徽标周围填充的透明图像。[BannerLogoRelativeUrl <String>]
:bannerLogo 属性的相对 URL,它与 cdnList 中的 CDN 基 URL 结合使用,以提供 CDN 提供的只读版本。 只读。[CdnList <String[]>]
:提供当前资源资产的所有可用 CDN 提供程序的基本 URL 列表。 多个 CDN 提供程序同时用于实现读取请求的高可用性。 只读。[SignInPageText <String>]
:登录框底部显示的文本。 可以使用此功能来传达其他信息,例如技术支持的电话号码或法律声明。 此文本必须为 Unicode,并且不能超过 1024 个字符。[SquareLogo <Byte[]>]
:在 Windows 10 现装体验(OOBE)中以及启用 Windows Autopilot 进行部署时,公司徽标的正方形版本。 允许的类型为 PNG 或 JPEG,大小不超过 240 x 240 像素,大小不超过 10 KB。 建议使用没有在徽标周围填充的透明图像。[SquareLogoRelativeUrl <String>]
:squareLogo 属性的相对 URL,它与 cdnList 中的 CDN 基 URL 相结合,以提供 CDN 提供的版本。 只读。[UsernameHintText <String>]
:在登录屏幕上的用户名文本框中显示为提示的字符串。 此文本必须是 Unicode,没有链接或代码,并且不能超过 64 个字符。[Id <String>]
:实体的唯一 idenfier。 只读。[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]
:基于区域设置添加不同的品牌。[BackgroundColor <String>]
:将在低带宽连接中代替背景图像的颜色。 建议使用横幅徽标或组织颜色的主要颜色。 以十六进制格式指定此值,例如,白色 #FFFFFF。[BackgroundImage <Byte[]>]
:显示为登录页面背景的图像。 允许的类型为 PNG 或 JPEG 不小于 300 KB,且不超过 1920 × 1080 像素。 较小的映像将降低带宽要求,并加快页面加载速度。[BackgroundImageRelativeUrl <String>]
:backgroundImage 属性的相对 URL,它与 cdnList 中的 CDN 基 URL 相结合,以提供 CDN 提供的版本。 只读。[BannerLogo <Byte[]>]
:登录页上显示的公司徽标的横幅版本。 允许的类型为 PNG 或 JPEG,不超过 36 × 245 像素。 建议使用没有在徽标周围填充的透明图像。[BannerLogoRelativeUrl <String>]
:bannerLogo 属性的相对 URL,它与 cdnList 中的 CDN 基 URL 结合使用,以提供 CDN 提供的只读版本。 只读。[CdnList <String[]>]
:提供当前资源资产的所有可用 CDN 提供程序的基本 URL 列表。 多个 CDN 提供程序同时用于实现读取请求的高可用性。 只读。[SignInPageText <String>]
:登录框底部显示的文本。 可以使用此功能来传达其他信息,例如技术支持的电话号码或法律声明。 此文本必须为 Unicode,并且不能超过 1024 个字符。[SquareLogo <Byte[]>]
:在 Windows 10 现装体验(OOBE)中以及启用 Windows Autopilot 进行部署时,公司徽标的正方形版本。 允许的类型为 PNG 或 JPEG,大小不超过 240 x 240 像素,大小不超过 10 KB。 建议使用没有在徽标周围填充的透明图像。[SquareLogoRelativeUrl <String>]
:squareLogo 属性的相对 URL,它与 cdnList 中的 CDN 基 URL 相结合,以提供 CDN 提供的版本。 只读。[UsernameHintText <String>]
:在登录屏幕上的用户名文本框中显示为提示的字符串。 此文本必须是 Unicode,没有链接或代码,并且不能超过 64 个字符。[Id <String>]
:实体的唯一 idenfier。 只读。
[BusinessPhone <String[]>]
:组织的电话号码。 虽然这是字符串集合,但只能为此属性设置一个数字。[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]
:用于管理基于证书的身份验证配置的导航属性。 只能在集合中创建 certificateBasedAuthConfiguration 的单个实例。[Id <String>]
:实体的唯一 idenfier。 只读。[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]
:创建受信任证书链的证书颁发机构的集合。[Certificate <Byte[]>]
:必需。 表示公共证书的 base64 编码字符串。[CertificateRevocationListUrl <String>]
:证书吊销列表的 URL。[DeltaCertificateRevocationListUrl <String>]
:URL 包含自上次创建完整证书吊销列表以来所有已吊销证书的列表。[IsRootAuthority <Boolean?>]
:必需。 如果受信任的证书是根颁发机构,则为 true;如果受信任的证书是中间颁发机构,则为 false。[Issuer <String>]
:证书的颁发者,根据证书值计算。 只读。[IssuerSki <String>]
:从证书值计算的证书的使用者密钥标识符。 只读。
[City <String>]
:组织地址的城市名称。[Country <String>]
:组织地址的国家/地区名称。[CountryLetterCode <String>]
:组织采用 ISO 3166-2 格式的国家或地区缩写。[CreatedDateTime <DateTime?>]
:创建组织的时间戳。 无法修改该值,并在创建组织时自动填充该值。 时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 只读。[Extension <IMicrosoftGraphExtension[]>]
:为组织定义的开放扩展集合。 只读。 Nullable。[Id <String>]
:实体的唯一 idenfier。 只读。
[MarketingNotificationEmail <String[]>]
:不可为 null。[MobileDeviceManagementAuthority <MdmAuthority?>]
:移动设备管理机构。[OnPremisesLastSyncDateTime <DateTime?>]
:租户上次与本地目录同步的时间和日期。 时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 只读。[OnPremisesSyncEnabled <Boolean?>]
:如果此对象从本地目录同步,则为 true;如果此对象最初已从本地目录同步,但不再同步,则为 false。 Nullable。 如果从未从本地目录同步此对象(默认值),则为 null。[PostalCode <String>]
:组织的地址的邮政编码。[PreferredLanguage <String>]
:组织的首选语言。 应遵循 ISO 639-1 代码;例如 en.[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]
:privacyProfile[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[ContactEmail <String>]
:隐私声明联系人的有效 smtp 电子邮件地址。 不需要。[StatementUrl <String>]
:以 http:// 或 https:// 开头的有效 URL 格式。 最大长度为 255 个字符。 指向公司的隐私声明的 URL。 不需要。
[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]
:不可为 null。[CapabilityStatus <String>]
:例如,“Enabled”。[ProvisioningStatus <String>]
:例如,“Success”。[Service <String>]
:服务的名称;例如,“AccessControlS2S”
[SecurityComplianceNotificationMail <String[]>]
:[SecurityComplianceNotificationPhone <String[]>]
:[State <String>]
:组织的地址的状态名称。[Street <String>]
:组织的地址的街道名称。[TechnicalNotificationMail <String[]>]
:不可为 null。[TenantType <String>]
:[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]
:与此租户关联的域的集合。 不可为 Null。[Capability <String>]
:例如电子邮件、OfficeCommunicationsOnline。[IsDefault <Boolean?>]
:如果这是与租户关联的默认域,则为 true;否则为 false。[IsInitial <Boolean?>]
:如果这是与租户关联的初始域,则为 true;否则为 false。[Name <String>]
:域名;例如,contoso.onmicrosoft.com。[Type <String>]
:例如托管。
[AddIn <IMicrosoftGraphAddIn[]>]
:定义使用服务可用于在特定上下文中调用应用的自定义行为。 例如,可以呈现文件流的应用程序可以为其“FileHandler”功能设置 addIns 属性。 这样,Office 365 等服务就可以在用户正在处理的文档上下文中调用应用程序。[Api <IMicrosoftGraphApiApplication>]
:apiApplication[AppRole <IMicrosoftGraphAppRole[]>]
:分配给应用程序的角色的集合。 通过应用角色分配,可以将这些角色分配给与其他应用程序关联的用户、组或服务主体。 不可为 Null。[ApplicationTemplateId <String>]
:applicationTemplate 的唯一标识符。[CreatedOnBehalfOfDeletedDateTime <DateTime?>]
:[CreatedOnBehalfOfDisplayName <String>]
:目录中显示的名称[Description <String>]
:应用程序的可选说明。 默认返回。 支持$filter(eq、ne、NOT、ge、le、startsWith)和$search。[DisabledByMicrosoftStatus <String>]
:指定Microsoft是否已禁用已注册的应用程序。 可能的值包括:null(默认值)、NotDisabled 和 DisabledDueToViolationOfServicesAgreement(原因可能包括可疑、滥用或恶意活动,或违反Microsoft服务协议)。 支持$filter(eq、ne、NOT)。[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]
:应用程序的联合标识。 支持$expand和$filter(计算空集合时的 eq)。[GroupMembershipClaim <String>]
:配置应用程序所需的用户或 OAuth 2.0 访问令牌中颁发的组声明。 若要设置此属性,请使用以下字符串值之一:None、SecurityGroup(对于安全组和 Azure AD 角色)、“所有”(这将获取登录用户所属的所有安全组、通讯组和 Azure AD 目录角色)。[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
:[IdentifierUri <String[]>]
:标识其 Azure AD 租户中的应用程序的 URI,或者在应用程序是多租户的情况下在已验证的自定义域中标识应用程序的 URI。 有关详细信息,请参阅应用程序对象和服务主体对象。 筛选多值属性上的表达式需要任何运算符。 不可为 Null。 支持$filter(eq、ne、ge、le、startsWith)。[Info <IMicrosoftGraphInformationalUrl>]
:informationalUrl[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[MarketingUrl <String>]
:链接到应用程序的营销页面。 例如: https://www.contoso.com/app/marketing[PrivacyStatementUrl <String>]
:指向应用程序的隐私声明的链接。 例如: https://www.contoso.com/app/privacy[SupportUrl <String>]
:链接到应用程序的支持页。 例如: https://www.contoso.com/app/support[TermsOfServiceUrl <String>]
:链接到应用程序的服务条款声明。 例如: https://www.contoso.com/app/termsofservice
[IsDeviceOnlyAuthSupported <Boolean?>]
:指定此应用程序是否支持没有用户的设备身份验证。 默认值为 false。[IsFallbackPublicClient <Boolean?>]
:将回退应用程序类型指定为公共客户端,例如在移动设备上运行的已安装应用程序。 默认值为 false,这意味着回退应用程序类型是机密客户端,例如 Web 应用。 在某些情况下,Azure AD 无法确定客户端应用程序类型。 例如,在未指定重定向 URI 的情况下配置应用程序的 ROPC 流。 在这些情况下,Azure AD 会根据此属性的值解释应用程序类型。[KeyCredentials <IMicrosoftGraphKeyCredential[]>]
:与应用程序关联的密钥凭据的集合。 不可为 Null。 支持$filter(eq、NOT、ge、le)。[CustomKeyIdentifier <Byte[]>]
:自定义密钥标识符[DisplayName <String>]
:密钥的友好名称。 可选。[EndDateTime <DateTime?>]
:凭据过期的日期和时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z[Key <Byte[]>]
:密钥凭据的值。 应为 base 64 编码值。[KeyId <String>]
:密钥的唯一标识符(GUID)。[StartDateTime <DateTime?>]
:凭据生效的日期和时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z[Type <String>]
:密钥凭据的类型;例如,“Symmetric”。[Usage <String>]
:一个字符串,描述密钥的用途;例如,“验证”。
[Logo <Byte[]>]
:应用程序的主徽标。 不可为 Null。[Note <String>]
:与应用程序管理相关的说明。[Oauth2RequirePostResponse <Boolean?>]
:[OptionalClaim <IMicrosoftGraphOptionalClaims>]
:optionalClaims[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[AccessToken <IMicrosoftGraphOptionalClaim[]>]
:JWT 访问令牌中返回的可选声明。[AdditionalProperty <String[]>]
:声明的其他属性。 如果此集合中存在某个属性,该属性将修改 name 属性中指定的可选声明的行为。[Essential <Boolean?>]
:如果值为 true,则客户端指定的声明是必需的,以确保最终用户请求的特定任务的顺利授权体验。 默认值为 false。[Name <String>]
:可选声明的名称。[Source <String>]
:声明的源(目录对象)。 扩展属性提供预定义声明和用户定义的声明。 如果源值为 null,则声明是预定义的可选声明。 如果源值为 user,则 name 属性中的值是来自用户对象的扩展属性。
[IdToken <IMicrosoftGraphOptionalClaim[]>]
:JWT ID 令牌中返回的可选声明。[Saml2Token <IMicrosoftGraphOptionalClaim[]>]
:SAML 令牌中返回的可选声明。
[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]
:parentalControlSettings[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[CountriesBlockedForMinor <String[]>]
:指定双字母 ISO 国家/地区代码。 对于此列表中指定国家/地区的未成年人,将阻止访问该应用程序。[LegalAgeGroupRule <String>]
:指定适用于应用用户的法律年龄组规则。 可设置为以下值之一:ValueDescriptionAllowDefault。 强制实施法律最低要求。 这意味着,欧盟和韩国的未成年人需要家长同意。RequireConsentForPrivacyServicesEnforces 用户必须指定出生日期,以遵守 COPPA 规则。 RequireConsentForMinorsRequires 家长同意年龄低于 18 岁,而不考虑国家/地区未成年人规则。RequireConsentForKidsRequires 家长同意年龄低于 14 岁,而不考虑国家/地区未成年人规则。BlockMinorsBlocks 未成年人使用应用。
[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]
:与应用程序关联的密码凭据的集合。 不可为 Null。[CustomKeyIdentifier <Byte[]>]
:请勿使用。[DisplayName <String>]
:密码的友好名称。 可选。[EndDateTime <DateTime?>]
:密码过期的日期和时间使用 ISO 8601 格式表示,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 可选。[KeyId <String>]
:密码的唯一标识符。[StartDateTime <DateTime?>]
:密码生效的日期和时间。 时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 可选。
[PublicClient <IMicrosoftGraphPublicClientApplication>]
:publicClientApplication[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[RedirectUri <String[]>]
:指定发送用于登录的用户令牌的 URL,或发送 OAuth 2.0 授权代码和访问令牌的重定向 URI。
[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]
:指定应用程序需要访问的资源。 此属性还指定每个资源所需的 OAuth 权限范围和应用程序角色集。 此对所需资源的访问配置会驱动许可体验。 不可为 Null。 支持$filter(eq、NOT、ge、le)。[ResourceAccess <IMicrosoftGraphResourceAccess[]>]
:应用程序需要从指定资源获取的 OAuth2.0 权限范围和应用角色的列表。[Id <String>]
:资源应用程序公开的 oauth2PermissionScopes 或 appRole 实例之一的唯一标识符。[Type <String>]
:指定 ID 属性引用 oauth2PermissionScopes 还是 appRole。 可能的值是范围或角色。
[ResourceAppId <String>]
:应用程序需要访问的资源的唯一标识符。 这应等于在目标资源应用程序上声明的 appId。
[SignInAudience <String>]
:指定当前应用程序支持的Microsoft帐户。 支持的值为:AzureADMyOrg、AzureADMultipleOrgs、AzureADandPersonalMicrosoftAccount、PersonalMicrosoftAccount。 有关详细信息,请参阅下表。 支持$filter(eq、ne、NOT)。[Spa <IMicrosoftGraphSpaApplication>]
:spaApplication[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[RedirectUri <String[]>]
:指定发送用于登录的用户令牌的 URL,或发送 OAuth 2.0 授权代码和访问令牌的重定向 URI。
[Tag <String[]>]
:可用于对应用程序进行分类和标识的自定义字符串。 不可为 null。支持$filter(eq、NOT、ge、le、startsWith)。[TokenEncryptionKeyId <String>]
:指定 keyCredentials 集合中公钥的 keyId。 配置后,Azure AD 将使用此属性指向的密钥加密它发出的所有令牌。 接收加密令牌的应用程序代码必须使用匹配的私钥对令牌进行解密,然后才能将其用于登录用户。[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
:[AppliesTo <IMicrosoftGraphDirectoryObject[]>]
:[Definition <String[]>]
:一个字符串集合,其中包含定义策略的规则和设置的 JSON 字符串。 定义语法因每个派生策略类型而异。 必需。[IsOrganizationDefault <Boolean?>]
:如果设置为 true,则激活此策略。 同一策略类型可以有多个策略,但只有一个策略可以激活为组织默认值。 可选,默认值为 false。[Description <String>]
:此策略的说明。[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称
[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
:分配给此应用程序的 tokenLifetimePolicies。 支持$expand。[AppliesTo <IMicrosoftGraphDirectoryObject[]>]
:[Definition <String[]>]
:一个字符串集合,其中包含定义策略的规则和设置的 JSON 字符串。 定义语法因每个派生策略类型而异。 必需。[IsOrganizationDefault <Boolean?>]
:如果设置为 true,则激活此策略。 同一策略类型可以有多个策略,但只有一个策略可以激活为组织默认值。 可选,默认值为 false。[Description <String>]
:此策略的说明。[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称
[Web <IMicrosoftGraphWebApplication>]
:webApplication[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[HomePageUrl <String>]
:应用程序的主页或登陆页。[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]
:implicitGrantSettings[(Any) <Object>]
:这表示可以将任何属性添加到此对象。[EnableAccessTokenIssuance <Boolean?>]
:指定此 Web 应用程序是否可以使用 OAuth 2.0 隐式流请求访问令牌。[EnableIdTokenIssuance <Boolean?>]
:指定此 Web 应用程序是否可以使用 OAuth 2.0 隐式流请求 ID 令牌。
[LogoutUrl <String>]
:指定由Microsoft授权服务用来使用前端通道、后通道或 SAML 注销协议注销用户的 URL。[RedirectUri <String[]>]
:指定发送用于登录的用户令牌的 URL,或发送 OAuth 2.0 授权代码和访问令牌的重定向 URI。
[DataType <String>]
:指定扩展属性可以保存的值的数据类型。 支持以下值。 不可为 Null。 Binary - 256 bytes maximumBooleanDateTime - 必须以 ISO 8601 格式指定。 将以 UTC 格式存储。整数 - 32 位值。LargeInteger - 64 位值。字符串 - 最大 256 个字符[Name <String>]
:扩展属性的名称。 不可为 Null。[TargetObject <String[]>]
:支持以下值。 不可为 Null。 UserGroupOrganizationDeviceApplication[Description <String>]
:此策略的说明。[AppliesTo <IMicrosoftGraphDirectoryObject[]>]
:[Definition <String[]>]
:一个字符串集合,其中包含定义策略的规则和设置的 JSON 字符串。 定义语法因每个派生策略类型而异。 必需。[IsOrganizationDefault <Boolean?>]
:如果设置为 true,则激活此策略。 同一策略类型可以有多个策略,但只有一个策略可以激活为组织默认值。 可选,默认值为 false。
[Definition <String[]>]
:一个字符串集合,其中包含定义策略的规则和设置的 JSON 字符串。 定义语法因每个派生策略类型而异。 必需。[IsOrganizationDefault <Boolean?>]
:如果设置为 true,则激活此策略。 同一策略类型可以有多个策略,但只有一个策略可以激活为组织默认值。 可选,默认值为 false。[Description <String>]
:此策略的说明。[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称
[IdentifierUri <String[]>]
:标识其 Azure AD 租户中的应用程序的 URI,或者在应用程序是多租户的情况下在已验证的自定义域中标识应用程序的 URI。 有关详细信息,请参阅应用程序对象和服务主体对象。 筛选多值属性上的表达式需要任何运算符。 不可为 Null。 支持$filter(eq、ne、ge、le、startsWith)。[Info <IMicrosoftGraphInformationalUrl>]
:informationalUrl[IsDeviceOnlyAuthSupported <Boolean?>]
:指定此应用程序是否支持没有用户的设备身份验证。 默认值为 false。[IsFallbackPublicClient <Boolean?>]
:将回退应用程序类型指定为公共客户端,例如在移动设备上运行的已安装应用程序。 默认值为 false,这意味着回退应用程序类型是机密客户端,例如 Web 应用。 在某些情况下,Azure AD 无法确定客户端应用程序类型。 例如,在未指定重定向 URI 的情况下配置应用程序的 ROPC 流。 在这些情况下,Azure AD 会根据此属性的值解释应用程序类型。[KeyCredentials <IMicrosoftGraphKeyCredential[]>]
:与应用程序关联的密钥凭据的集合。 不可为 Null。 支持$filter(eq、NOT、ge、le)。[Logo <Byte[]>]
:应用程序的主徽标。 不可为 Null。[Note <String>]
:与应用程序管理相关的说明。[Oauth2RequirePostResponse <Boolean?>]
:[OptionalClaim <IMicrosoftGraphOptionalClaims>]
:optionalClaims[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]
:parentalControlSettings[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]
:与应用程序关联的密码凭据的集合。 不可为 Null。[PublicClient <IMicrosoftGraphPublicClientApplication>]
:publicClientApplication[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]
:指定应用程序需要访问的资源。 此属性还指定每个资源所需的 OAuth 权限范围和应用程序角色集。 此对所需资源的访问配置会驱动许可体验。 不可为 Null。 支持$filter(eq、NOT、ge、le)。[SignInAudience <String>]
:指定当前应用程序支持的Microsoft帐户。 支持的值为:AzureADMyOrg、AzureADMultipleOrgs、AzureADandPersonalMicrosoftAccount、PersonalMicrosoftAccount。 有关详细信息,请参阅下表。 支持$filter(eq、ne、NOT)。[Spa <IMicrosoftGraphSpaApplication>]
:spaApplication[Tag <String[]>]
:可用于对应用程序进行分类和标识的自定义字符串。 不可为 null。支持$filter(eq、NOT、ge、le、startsWith)。[TokenEncryptionKeyId <String>]
:指定 keyCredentials 集合中公钥的 keyId。 配置后,Azure AD 将使用此属性指向的密钥加密它发出的所有令牌。 接收加密令牌的应用程序代码必须使用匹配的私钥对令牌进行解密,然后才能将其用于登录用户。[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
:[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
:分配给此应用程序的 tokenLifetimePolicies。 支持$expand。[Web <IMicrosoftGraphWebApplication>]
:webApplication