你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Remove-AzureRmADSpCredential
从服务主体中删除凭据。
警告
AzureRM PowerShell 模块已自 2024 年 2 月 29 日起正式弃用。 为了确保持续获得支持和更新,建议用户从 AzureRM 迁移到 Az PowerShell 模块。
尽管 AzureRM 模块仍可运行,但不再受到维护或支持,任何继续使用的行为都由用户自行决定并自行承担风险。 有关过渡到 Az 模块的指导,请参阅我们的迁移资源。
语法
Remove-AzureRmADSpCredential
-ObjectId <Guid>
[-KeyId <Guid>]
[-PassThru]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzureRmADSpCredential
-ServicePrincipalName <String>
[-KeyId <Guid>]
[-PassThru]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzureRmADSpCredential
-DisplayName <String>
[-PassThru]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzureRmADSpCredential
-ServicePrincipalObject <PSADServicePrincipal>
[-KeyId <Guid>]
[-PassThru]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Remove-AzureRmADSpCredential cmdlet 可用于在泄露时或作为凭据密钥滚动更新过期的一部分,从服务主体中删除凭据密钥。 通过提供对象 ID 或服务主体名称(SPN)来标识服务主体。 如果要删除单个凭据或使用“全部”开关删除与服务主体关联的所有凭据,则要删除的凭据由其密钥 ID 标识。
示例
示例 1 - 从服务主体中删除特定凭据
PS C:\> Remove-AzureRmADSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb
从对象 ID 为“000011111-aaaa-2222-bbbb-3333cccc44444”的服务主体中删除密钥 ID 为“9044423a-60a3-45ac-9ab1-09534157ebb”的凭据。
示例 2 - 从服务主体中删除所有凭据
PS C:\> Remove-AzureRmADSpCredential -ServicePrincipalName http://test123
使用 SPN“http://test123"从服务主体中删除所有凭据。
示例 3 - 使用管道从服务主体中删除所有凭据
PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADSpCredential
获取对象 ID 为“00001111-aaaa-2222-bbbb-3333cccc4444”的服务主体,并通过管道将对象 ID 为 Remove-AzureRmADSpCredential cmdlet 从该服务主体中删除所有凭据。
参数
-Confirm
提示你在运行 cmdlet 之前进行确认。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DefaultProfile
用于与 azure 通信的凭据、帐户、租户和订阅
类型: | IAzureContextContainer |
别名: | AzureRmContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DisplayName
服务主体的显示名称。
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Force
在不确认的情况下切换到删除凭据。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-KeyId
指定要删除的凭据密钥。 可以使用 Get-AzureRmADSpCredential cmdlet 获取服务主体的密钥 ID。
类型: | Guid |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ObjectId
要从中删除凭据的服务主体的对象 ID。
类型: | Guid |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-PassThru
如果命令成功,则指定此项将返回 true。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ServicePrincipalName
要从中删除凭据的服务主体的名称(SPN)。
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-ServicePrincipalObject
要从中删除凭据的服务主体对象。
类型: | PSADServicePrincipal |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
类型: | SwitchParameter |
别名: | wi |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
输入
参数:ServicePrincipalObject (ByValue)