System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Revoke-SCResource コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Revoke-SCResource」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Revoke-SCResource コマンドレット
名前
Revoke-SCResource
概要
ユーザー、もしくはユーザー ロールからリソースへのアクセスを取り消します。
構文
| Revoke-SCResource [-JobGroup <Guid>] [-JobVariable <String>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-PROTipID <Guid>] -Resource <ClientObject> [-RunAsynchronously] [-UserName <String>] [-UserRoleID <Guid[]>] [-UserRoleName <String[]>] [-VMMServer <ServerConnection>] [<CommonParameters>] |
説明
Revoke-SCResource コマンドレットは、ユーザー、もしくはユーザー ロールからリソースへのアクセスを取り消します。
パラメーター
-JobGroup <Guid>
同じジョブ グループ識別子を含む最後のコマンドが実行される直前に、一連のコマンドを実行する一連のコマンドの識別子を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUser <String>
ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUserRole <UserRole>
ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Resource <ClientObject>
リソース オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-UserName <String>
ユーザー名を指定します。フォーマット “ドメイン\ユーザー” のようにユーザー名を入力します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-UserRoleID <Guid[]>
ユーザー ロール ID を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-UserRoleName <String[]>
ユーザー ロール名を指定します。名前が付けられたユーザー ロールの種類には、委任された管理者、読み取り専用の管理者、セルフサービス ユーザーなどがあります。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- Resource
- このコマンドレットは、Resource オブジェクトを返します。
メモ
例
例 1 : 特定のユーザーからリソースへのアクセスを取り消す
コマンド
$Resource = Get-SCVMTemplate | where {$_.Name -eq "Template01"}
Revoke-SCResource -Resource $Resource -Username "Contoso\Katarina"
コマンドの説明
最初のコマンドは、テンプレート オブジェクト “Template01” を取得し、そのオブジェクトを $Resource 変数に格納します。
2 番目のコマンドは、ユーザー ユーザーから $Resource (Template01) に格納されているリソースへのアクセスを取り消します。 ユーザーが複数のユーザー ロールのメンバーである場合、すべてのユーザー ロールでユーザーからのアクセスが取り消されます。
例 2 : 複数のユーザー ロールのメンバーであるユーザーからリソースへのアクセスを取り消す
コマンド
$Resource = Get-SCVMTemplate | where {$_.Name -eq "Template01"}
Revoke-SCResource -Resource $Resource -Username "Contoso\Katarina" -UserRoleName @("ContosoSelfServiceUsers", "SelfServiceUserRole02")
コマンドの説明
最初のコマンドは、テンプレート オブジェクト “Template01” を取得し、そのオブジェクトを $Resource 変数に格納します。
2 番目のコマンドは、ユーザーが “ContosoSelfServiceUsers”、もしくは “SelfServiceUserRole02” を使用している場合のみ、ユーザー “Contoso\Katarina” から $Resource (Template01) に格納されているリソースへのアクセスを取り消します。 Katarina がリソースへのアクセス権を持つ別のユーザー ロールを使用する場合、Katarina は引き続きリソースにアクセス可能です。
例 3 : ユーザー ロールのすべてのメンバーからリソースへのアクセスを取り消す
コマンド
$Resource = Get-SCVMTemplate | where {$_.Name -eq "Template01"}
Revoke-SCResource -Resource $Resource -UserRoleName "ContosoSelfServiceUsers"
コマンドの説明
最初のコマンドは、テンプレート オブジェクト “Template01″ を取得し、そのオブジェクトを $Resource 変数に格納します。
2 番目のコマンドは、”ContosoSelfServiceUsers” ユーザー ロールのすべてのメンバーから $Resource (Template01) に格納されているリソースへのアクセスを取り消します。
関連するリンク
- Get-SCVMTemplate
- Grant-SCResource
参考
- System Center 2016 – データセンターの管理 | Microsoft
https://www.microsoft.com/ja-jp/cloud-platform/system-center - VirtualMachineManager | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/?view=systemcenter-ps-2016 - Revoke-SCResource (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/revoke-scresource?view=systemcenter-ps-2016