Remove-AzureRmADSpCredential

從服務主體移除認證。

警告

自 2024 年 2 月 29 日起,AzureRM PowerShell 模組已正式淘汰。 建議使用者從 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>]

Description

Remove-AzureRmADSpCredential Cmdlet 可用來從服務主體移除認證密鑰,以防遭到入侵,或作為認證密鑰變換到期的一部分。 服務主體是藉由提供物件標識碼或服務主體名稱 (SPN) 來識別。 如果要移除個別認證,或是使用 『All』 參數來刪除與服務主體相關聯的所有認證,則會透過其密鑰標識碼來識別要移除的認證。

範例

範例 1 - 從服務主體移除特定認證

PS C:\> Remove-AzureRmADSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb

從具有對象標識碼 '00001111-aaaa-2222-bbbb-3333cccc44444' 的服務主體中移除密鑰標識符為 '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

取得對象標識碼為 '00001111-aaaa-2222-bbbb-3333cccc4444' 的服務主體,並將該管道傳送至 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 取得服務主體的密鑰標識碼。

類型:Guid
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ObjectId

要從中移除認證的服務主體對象標識碼。

類型: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

輸入

Guid

String

PSADServicePrincipal

參數:ServicePrincipalObject (ByValue)

輸出

Boolean