次の方法で共有

Remove-AzureRmADSpCredential

  • リファレンス
モジュール:
AzureRM.Resources

サービス プリンシパルから資格情報を削除します。

警告

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 コマンドレットを使用すると、セキュリティ侵害が発生した場合、または資格情報キーのロールオーバーの有効期限の一部として、サービス プリンシパルから資格情報キーを削除できます。 サービス プリンシパルは、オブジェクト ID またはサービス プリンシパル名 (SPN) を指定することによって識別されます。 個々の資格情報を削除する場合、またはサービス プリンシパルに関連付けられているすべての資格情報を削除する 'All' スイッチを使用して、削除する資格情報はキー ID によって識別されます。

例

例 1 - サービス プリンシパルから特定の資格情報を削除する

PS C:\> Remove-AzureRmADSpCredential -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb

キー ID '9044423a-60a3-45ac-9ab1-09534157ebb' の資格情報を、オブジェクト ID '7663d3fb-6f86-4352-9e6d-cf9d50d5ee82' のサービス プリンシパルから削除します。

例 2 - サービス プリンシパルからすべての資格情報を削除する

PS C:\> Remove-AzureRmADSpCredential -ServicePrincipalName http://test123

SPN "http://test123"を使用して、サービス プリンシパルからすべての資格情報を削除します。

例 3 - パイプを使用してサービス プリンシパルからすべての資格情報を削除する

PS C:\> Get-AzureRmADServicePrincipal -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 | Remove-AzureRmADSpCredential

オブジェクト ID '7663d3fb-6f86-4352-9e6d-cf9d50d5ee82' を持つサービス プリンシパルを取得し、そのサービス プリンシパルからすべての資格情報を削除するために Remove-AzureRmADSpCredential コマンドレットにパイプします。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

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

-DisplayName

サービス プリンシパルの表示名。

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

-Force

確認なしで資格情報を削除するように切り替えます。

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

-KeyId

削除する資格情報キーを指定します。 サービス プリンシパルのキー ID は、Get-AzureRmADSpCredential コマンドレットを使用して取得できます。

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

-ObjectId

資格情報を削除するサービス プリンシパルのオブジェクト ID。

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

-PassThru

これを指定すると、コマンドが成功した場合は true が返されます。

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

-ServicePrincipalName

資格情報を削除するサービス プリンシパルの名前 (SPN)。

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

-ServicePrincipalObject

資格情報を削除するサービス プリンシパル オブジェクト。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

Guid

String

PSADServicePrincipal

パラメーター: ServicePrincipalObject (ByValue)

出力

Boolean