Azure StorSimple 関連の PowerShell コマンドレット (Remove-AzureStorSimpleStorageAccountCredential) について

StorSimple は、Microsoft 社が提供するハイブリッドのクラウドストレージサービスです。 Microsoft Azure と組み合わせることで、Azure ストレージを拡張領域として利用することが可能であり、また別拠点でのデータ復旧が可能であることから、効率的なデータ管理、災害対策が実現できます。

Azure StorSimple デバイスの管理に使用することが可能な PowerShell コマンドレットが提供されており、設定方法について MSDN サイト上で公開されていますが、PowerShell コマンドレットのヘルプについては英語のみであり、日本語による情報はほとんど公開されていません。

Azure StorSimple 関連の PowerShell コマンドレットの 1 つである「Remove-AzureStorSimpleStorageAccountCredential」について、本ブログにて日本語の情報として纏めてみました((他の PowerShell コマンドレットについては、「Azure StorSimple 関連の PowerShell コマンドレットについて」を参照) (Windows Azure PowerShell バージョン 0.9.7 で確認しているものとなります)。

■名前

Remove-AzureStorSimpleStorageAccountCredential

■概要

存在するストレージアカウント資格情報を削除します。

■構文

Remove-AzureStorSimpleStorageAccountCredential [-StorageAccountName] <String> [[-WaitForComplete]] [[-Force]] [-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]] [<CommonParameters>]

Remove-AzureStorSimpleStorageAccountCredential [-SAC] <StorageAccountCredentialResponse> [[-WaitForComplete]] [[-Force]] [-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]] [<CommonParameters>]

■説明

Remove-AzureStorSimpleStorageAccountCredential コマンドレットは、存在するストレージアカウント資格情報を削除します。名前によってアカウントを指定する、もしくは削除する StorageAccountCredential オブジェクトを取得するために Get-AzureStorSimpleStorageAccountCredential コマンドレットを用います。

■パラメーター

-Force [<SwitchParameter>]
このコマンドレットが、確認のプロンプトを表示しないことを示します。

必須	false
位置	3
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]
Azure プロファイルを指定します。

必須	false
位置	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-SAC <StorageAccountCredentialResponse>
削除する StorageAccountCredential オブジェクトとして資格情報を指定します。StorageAccountCredential オブジェクトを取得するために、Get-AzureStorSimpleStorageAccountCredential コマンドレットを用います。

必須	true
位置	1
既定値	なし
パイプライン入力を許可する	true(ByValue)
ワイルドカード文字を許可する	false

-StorageAccountName <String>
削除するストレージアカウント資格情報名を指定します。

必須	true
位置	1
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WaitForComplete [<SwitchParameter>]
Windows PowerShell コンソールに制御を返す前に、このコマンドレットが完了するための操作に対して待機するかを示します。

必須	false
位置	2
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: –Verbose、-Debug、-ErrorAction、-ErrorVariable、-WarningAction、-WarningVariable、-OutBuffer、-PipelineVariable、および -OutVariable。詳細については、about_CommonParameters を参照してください。

■入力

StorageAccountCredential
このコマンドレットは、パイプラインを用いて StorageAccountCredential オブジェクトを受け入れます。

■出力

TaskStatusInfo
このコマンドレットは、-WaitForComplete パラメーターを指定した場合、TaskStatusInfo オブジェクトを返します。

■メモ

詳細については、「Get-Help Remove-AzureStorSimpleStorageAccountCredential -detailed」と入力してください。
技術情報については、「Get-Help Remove-AzureStorSimpleStorageAccountCredential -full」と入力してください。

■エイリアス

なし

■例

例 1: ストレージアカウント資格情報の削除

 Remove-AzureStorSimpleStorageAccountCredential -StorageAccountName "ContosoStorage07"

VERBOSE: ClientRequestId: 8e10d56b-ddb1-459b-b26e-a185f5a303de_PS
VERBOSE: About to create a job to remove your Storage Access Credential!
VERBOSE: ClientRequestId: 55cb6296-0156-4266-8591-d9e9bf8cc584_PS
982f4b19-ccb0-4ad3-9b02-f8ad25bf2e72
VERBOSE: The delete task is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId
982f4b19-ccb0-4ad3-9b02-f8ad25bf2e72 for tracking the task’s status

このコマンドは、ストレージアカウント名「ContosoStorage07」に対するアカウント資格情報を削除します。このコマンドは、-Force パラメーターを指定しています。コマンドレットは確認のプロンプトを表示せずに資格情報を削除します。

例 2: パイプライン操作を用いたストレージアカウント資格情報の削除

 Get-AzureStorSimpleStorageAccountCredential -StorageAccountName "ContosoStorage07" | Remove-AzureStorSimpleStorageAccountCredential -Force -WaitForComplete

VERBOSE: ClientRequestId: f1b46216-bf4c-4c19-8e92-1dfe3894e258_PS
VERBOSE: ClientRequestId: 0d946f8f-c771-4ade-8a83-7c08dad86c52_PS
VERBOSE: ClientRequestId: 2000bab6-8311-4192-ad12-c67e35fc2697_PS
VERBOSE: Storage Access Credential with name ContosoStorage07 found!
VERBOSE: About to run a job to remove your Storage Access Credential!
VERBOSE: ClientRequestId: b803b165-bef8-4a8f-9509-4b515ea8bdec_PS
VERBOSE: Your delete operation completed successfully!

このコマンドは、Get-AzureStorSimpleStorageAccountCredential コマンドレットを用いてストレージアカウント名「ContosoStorage07」を取得し、現在のコマンドレットへオブジェクトを渡します。現在のコマンドレットは、ストレージアカウントに対する資格情報を削除します。このコマンドは、-WaitForComplete パラメーターが指定されています。コマンドは、削除操作が完了するまで、コンソールに制御は返りません。