Remove-EntraApplicationKey

モジュール:
Microsoft.Entra.Applications Module v1.3

アプリケーションからキーを削除します。

構文

Default (既定) 

Remove-EntraApplicationKey

    -ApplicationId <String>
    [-Proof <String>]
    [-KeyId <String>]
    [<CommonParameters>]

説明

アプリケーションからキーを削除します。

例

例 1: アプリケーションからキー資格情報を削除する

Connect-Entra -Scopes 'Application.ReadWrite.All','Directory.ReadWrite.All'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
Remove-EntraApplicationKey -ApplicationId $application.Id -KeyId 'aaaaaaaa-0b0b-1c1c-2d2d-333333333333' -Proof '{token}'

このコマンドは、指定したアプリケーションから指定したキー資格情報を削除します。

  • -ApplicationId パラメーターは、アプリケーションの一意識別子を指定します。
  • -KeyId パラメーターは、削除するキー オブジェクトに対応するキー ID を指定します。
  • -Proof パラメーターは、所有証明として提供される JWT トークンを指定します。

パラメーター

-ApplicationId

Microsoft Entra ID内のアプリケーションの一意の ID を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:オブジェクト識別子

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-KeyId

削除するキー オブジェクトに対応するキー ID。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Proof

所有証明として提供される JWT トークン。

既存のキーの所有証明として使用される自己署名 JWT トークン。 この JWT トークンは、アプリケーションに関連付けられている既存の有効な証明書のいずれかに対応する秘密キーで署名する必要があります。 トークンには、次の要求を含める必要があります。

  • aud: 対象ユーザーは 000000002-0000-0000-c000-000000000000 である必要があります。
  • iss: 発行者は、要求を開始するアプリケーションの ID である必要があります。
  • nbf: 時刻の前ではありません。
  • exp: 有効期限は nbf + 10 分の値にする必要があります。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

String