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 コマンドレットを使用すると、セキュリティ侵害が発生した場合、または資格情報キーのロールオーバーの有効期限の一部として、サービス プリンシパルから資格情報キーを削除できます。 サービス プリンシパルは、オブジェクト ID またはサービス プリンシパル名 (SPN) を指定することによって識別されます。 個々の資格情報を削除する場合、またはサービス プリンシパルに関連付けられているすべての資格情報を削除する 'All' スイッチを使用して、削除する資格情報はキー ID によって識別されます。
例
例 1 - サービス プリンシパルから特定の資格情報を削除する
PS C:\> Remove-AzureRmADSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebbキー ID '9044423a-60a3-45ac-9ab1-09534157ebb' の資格情報を、オブジェクト ID '000011111-aaaa-2222-bbbb-3333cccc444' のサービス プリンシパルから削除します。
例 2 - サービス プリンシパルからすべての資格情報を削除する
PS C:\> Remove-AzureRmADSpCredential -ServicePrincipalName http://test123SPN "http://test123" を使用して、サービス プリンシパルからすべての資格情報を削除します。
例 3 - パイプを使用してサービス プリンシパルからすべての資格情報を削除する
PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADSpCredentialオブジェクト ID '00001111-aaaa-2222-bbbb-3333cccc4444' を持つサービス プリンシパルを取得し、そのサービス プリンシパルからすべての資格情報を削除するために Remove-AzureRmADSpCredential コマンドレットにパイプします。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisplayName
サービス プリンシパルの表示名。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Force
確認なしで資格情報を削除するように切り替えます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-KeyId
削除する資格情報キーを指定します。 サービス プリンシパルのキー ID は、Get-AzureRmADSpCredential コマンドレットを使用して取得できます。
| 型: | Guid |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ObjectId
資格情報を削除するサービス プリンシパルのオブジェクト ID。
| 型: | Guid |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PassThru
これを指定すると、コマンドが成功した場合は true が返されます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ServicePrincipalName
資格情報を削除するサービス プリンシパルの名前 (SPN)。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ServicePrincipalObject
資格情報を削除するサービス プリンシパル オブジェクト。
| 型: | PSADServicePrincipal |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
パラメーター: ServicePrincipalObject (ByValue)