Clear-AzureRemoteAppVmStaleAdObject

  • リファレンス
モジュール:
Azure

存在しなくなった Azure RemoteApp 仮想マシンに関連付けられている Microsoft Entra ID のオブジェクトを削除します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

Clear-AzureRemoteAppVmStaleAdObject
     -CollectionName <String>
     [-Credential <PSCredential>]
     [-Profile <AzureSMProfile>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

説明

Clear-AzureRemoteAppVmStaleAdObject コマンドレットは、存在しなくなった Azure RemoteApp 仮想マシンに関連付けられている Microsoft Entra ID のオブジェクトを削除します。 Microsoft Entra オブジェクトを削除する権限を持つ資格情報を使用する必要があります。 Verbose 共通パラメーターを指定すると、このコマンドレットは削除する各オブジェクトの名前を表示します。

例

例 1: コレクションの古いオブジェクトをクリアする

PS C:\> $AdminCredentials = Get-Credential
PS C:\> Clear-AzureRemoteAppVmStaleAdObject -CollectionName "Contoso" -Credential $AdminCredentials

最初のコマンドでは、Get-Credential を使用してユーザー名とパスワードの入力を求められます。 このコマンドは、結果を $AdminCredentials 変数に格納します。

2 番目のコマンドは、Contoso という名前のコレクションの古いオブジェクトをクリアします。 このコマンドは、変数に格納されている資格情報$AdminCredentials使用します。 コマンドを成功させるには、これらの資格情報に適切な権限が必要です。

パラメーター

-CollectionName

Azure RemoteApp コレクションの名前を指定します。

型:String
Aliases:Name
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Credential

このアクションを実行する権限を持つ資格情報を指定します。 PSCredential オブジェクトを取得するには、Get-Credential コマンドレットを使用します。 このパラメーターを指定しない場合、このコマンドレットは現在のユーザー資格情報を使用します。

型:PSCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

型:AzureSMProfile
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False