你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Remove-AzADAppCredential

删除应用程序的密钥凭据或密码凭据。

语法

Remove-AzADAppCredential
      -ObjectId <String>
      [-KeyId <Guid>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzADAppCredential
      [-KeyId <Guid>]
      -ApplicationId <Guid>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzADAppCredential
      [-KeyId <Guid>]
      -DisplayName <String>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzADAppCredential
      [-KeyId <Guid>]
      -ApplicationObject <IMicrosoftGraphApplication>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

删除应用程序的密钥凭据或密码凭据。

示例

示例 1:按密钥 ID 从应用程序中删除凭据

Remove-AzADAppCredential -DisplayName $name -KeyId $keyid

按密钥 ID 从应用程序中删除凭据

示例 2:从应用程序中删除所有凭据

Get-AzADApplication -DisplayName $name | Remove-AzADAppCredential

从应用程序中删除所有凭据

参数

-ApplicationId

应用程序 ID。

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ApplicationObject

应用程序对象可用作管道输入。 若要构造,请参阅 APPLICATIONOBJECT 属性的 NOTES 部分并创建哈希表。

Type:IMicrosoftGraphApplication
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:PSObject
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

应用程序的显示名称。

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-KeyId

要删除的凭据的密钥 ID。

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ObjectId

应用程序的对象 ID。

Type:String
Aliases:Id
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

命令成功时返回 true

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

显示在此 cmdlet 运行的情况下将会发生什么。 此 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

输入

IMicrosoftGraphApplication

输出

Boolean

备注

别名

复杂参数属性

若要创建下面所述的参数,请构造包含相应属性的哈希表。 有关哈希表的信息,请运行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 (作用域中的值,) 访问令牌中的声明。 长度不得超过 120 个字符。 允许的字符为: ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~,以及 0-9、A-Z 和 a-z 范围内的字符。 不允许任何其他字符(包括空格字符)。 可能不以 .. 开头。
    • [PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]:列出预授权的客户端应用程序,这些客户端应用程序具有访问此应用程序的 API 的指定委派权限。 对于指定) 的权限,用户无需同意任何预先授权的应用程序 (。 但是,预授权化Applications 中未列出的任何其他权限 (通过增量许可请求,例如,) 需要用户同意。
      • [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>]:目录中显示的名称
    • [Definition <String[]>]:包含一个 JSON 字符串的字符串集合,用于定义策略的规则和设置。 定义语法因每个派生策略类型而异。 必需。
    • [IsOrganizationDefault <Boolean?>]:如果设置为 true,则激活此策略。 同一策略类型可以有多个策略,但只能激活一个策略作为组织默认值。 可选,默认值为 false。
    • [Description <String>]:此策略的说明。
    • [DeletedDateTime <DateTime?>]:
    • [DisplayName <String>]:目录中显示的名称
  • [IdentifierUri <String[]>]:标识其 Azure AD 租户中的应用程序的 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) 。
    • [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>]:一个字符串,描述可以使用密钥的用途;例如,“Verify”。
  • [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 minors minors from using the app.
  • [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 授权服务将使用的 URL,以使用前端通道、后通道或 SAML 注销协议注销用户。
    • [RedirectUri <String[]>]:指定将用户令牌发送到登录的 URL,或发送 OAuth 2.0 授权代码和访问令牌的重定向 URI。