Tools for PowerShell V4 を使用した WorkSpaces の例

例 1: この例では、既存の IP グループにルールを追加します

$Rule = @(
@{IPRule = "10.1.0.0/0"; RuleDesc = "First Rule Added"},
@{IPRule = "10.2.0.0/0"; RuleDesc = "Second Rule Added"}
)

Approve-WKSIpRule -GroupId wsipg-abcnx2fcw -UserRule $Rule

例 1: この例では、指定 ID を持つワークスペースイメージを、us-west-2 から「CopiedImageTest」という名前の現在のリージョンにコピーします。

Copy-WKSWorkspaceImage -Name CopiedImageTest -SourceRegion us-west-2 -SourceImageId wsi-djfoedhw6

出力:

wsi-456abaqfe

例 1: この例では、WorkSpaces クライアントの再接続を有効にします

Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369

例 1: この例では、セルフサービスのアクセス許可を有効にして、指定ディレクトリのコンピューティングタイプを変更し、ボリュームサイズを増やせるようにします

Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED

例 1: この例では、指定ディレクトリの Android と Chrome OS で Workspace アクセスを有効にします

Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW

例 1: この例では、Workspace の作成中にインターネットアクセスとメンテナンスモードをデフォルト値として true に設定します

Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true

例 1: この例では、指定ワークスペースのワークスペース実行モードプロパティを Auto Stop に変更します

Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP

例 1: この例では、指定ワークスペースの状態を使用可能に変更します

Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE

例 1: この例では、指定ディレクトリのワークスペースクライアントのクライアントプロパティを取得します

Get-WKSClientProperty -ResourceId d-223562a123

例 1: この例では、指定リージョン内の指定 IP グループの詳細を取得します

Get-WKSIpGroup -Region us-east-1 -GroupId wsipg-8m1234v45

出力:

GroupDesc GroupId         GroupName UserRules
--------- -------         --------- ---------
          wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}

例 1: この例では、指定ワークスペースのタグを取得します

Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2

出力:

Key         Value
---         -----
auto-delete no
purpose     Workbench

例 1: パイプラインに対するすべてのワークスペースの詳細を取得します。

Get-WKSWorkspace

出力:

BundleId                    : wsb-1a2b3c4d
ComputerName                :
DirectoryId                 : d-1a2b3c4d
ErrorCode                   :
ErrorMessage                :
IpAddress                   :
RootVolumeEncryptionEnabled : False
State                       : PENDING
SubnetId                    :
UserName                    : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey         :
WorkspaceId                 : ws-1a2b3c4d
WorkspaceProperties         : Amazon.WorkSpaces.Model.WorkspaceProperties

例 2: このコマンドは、us-west-2 リージョンのワークスペース WorkSpaceProperties の子プロパティの値を表示します。WorkSpaceProperties の子プロパティの詳細については、https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html を参照してください。

(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties

出力:

        ComputeTypeName                     : STANDARD
        RootVolumeSizeGib                   : 80
        RunningMode                         : AUTO_STOP
        RunningModeAutoStopTimeoutInMinutes : 60
        UserVolumeSizeGib                   : 50

例 3: このコマンドは、us-west-2 リージョン内のワークスペース WorkSpaceProperties の子プロパティ RootVolumeSizeGib の値を表示します。GiB 単位のルートボリュームサイズは 80 です。

(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib

出力:

        80

例 1: この例では、現在のリージョンのすべてのワークスペースバンドルの詳細を取得します

Get-WKSWorkspaceBundle

出力:

BundleId        : wsb-sfhdgv342
ComputeType     : Amazon.WorkSpaces.Model.ComputeType
Description     : This bundle is custom
ImageId         : wsi-235aeqges
LastUpdatedTime : 12/26/2019 06:44:07
Name            : CustomBundleTest
Owner           : 233816212345
RootStorage     : Amazon.WorkSpaces.Model.RootStorage
UserStorage     : Amazon.WorkSpaces.Model.UserStorage

例 1: この例では、登録されているディレクトリのディレクトリ情報を一覧表示します

Get-WKSWorkspaceDirectory

出力:

Alias                       : TestWorkspace
CustomerUserName            : Administrator
DirectoryId                 : d-123414a369
DirectoryName               : TestDirectory.com
DirectoryType               : MicrosoftAD
DnsIpAddresses              : {172.31.43.45, 172.31.2.97}
IamRoleId                   : arn:aws:iam::761234567801:role/workspaces_RoleDefault
IpGroupIds                  : {}
RegistrationCode            : WSpdx+4RRT43
SelfservicePermissions      : Amazon.WorkSpaces.Model.SelfservicePermissions
State                       : REGISTERED
SubnetIds                   : {subnet-1m3m7b43, subnet-ard11aba}
Tenancy                     : SHARED
WorkspaceAccessProperties   : Amazon.WorkSpaces.Model.WorkspaceAccessProperties
WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties
WorkspaceSecurityGroupId    : sg-0ed2441234a123c43

例 1: この例では、リージョン内のすべてのイメージの詳細をすべて取得します

Get-WKSWorkspaceImage

出力:

Description     :This image is copied from another image
ErrorCode       :
ErrorMessage    :
ImageId         : wsi-345ahdjgo
Name            : CopiedImageTest
OperatingSystem : Amazon.WorkSpaces.Model.OperatingSystem
RequiredTenancy : DEFAULT
State           : AVAILABLE

例 1: この例では、指定ワークスペース用に作成された最新のスナップショットのタイムスタンプを示します

Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v

出力:

RebuildSnapshots                   RestoreSnapshots
----------------                   ----------------
{Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}

例 1: この例では、指定ワークスペースの接続ステータスを取得します

Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r

例 1: この例では、FreshEmptyIpGroup という名前の空の IP グループを作成します

New-WKSIpGroup -GroupName "FreshNewIPGroup"

出力:

wsipg-w45rty4ty

例 1: この例では、ws-wsname という名前のワークスペースに新しいタグを追加します。タグのキーは「Name」で、キー値は AWS_Workspace です。

$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag

例 2: この例では、ws-wsname という名前のワークスペースに複数のタグを追加します。1 つのタグには「Name」のキーと AWS_Workspace のキー値があり、もう 1 つのタグには「Stage」のタグキーと「Test」のキー値があります。

$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"

$tag2 = New-Object Amazon.WorkSpaces.Model.Tag
$tag2.Key = "Stage"
$tag2.Value = "Test"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2

例 1: 指定のバンドル、ディレクトリ、ユーザーのワークスペースを作成します。

New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}

例 2: この例では、複数の WorkSpace を作成します

New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}

例 1: このサンプルは、指定 IP グループを指定ディレクトリに登録します

Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123

例 1: この例では、指定ディレクトリを WorkSpaces サービスに登録します

Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false

例 1: この例では、指定 IP グループを削除します

Remove-WKSIpGroup -GroupId wsipg-32fhgtred

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSIpGroup (DeleteIpGroup)" on target "wsipg-32fhgtred".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): Y

例 1: この例では、ワークスペースに関連付けられたタグを削除します

Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): Y

例 1: 複数のワークスペースを終了します。-Force スイッチを使用すると、コマンドレットによる確認を求めるプロンプトが表示されなくなります。

Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force

例 2: すべてのワークスペースのコレクションを取得し、Remove-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、すべての ワークスペースを終了します。コマンドレットは、各ワークスペースが終了する前にプロンプトを表示します。確認を非表示にするには、-Force スイッチを追加します。

Get-WKSWorkspaces | Remove-WKSWorkspace

例 3: この例では、終了するワークスペースを定義する TerminateRequest オブジェクトを渡す方法を示します。-Force スイッチが指定されていない限り、コマンドレットは続行する前に確認を求めます。

$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Remove-WKSWorkspace -Request $arrRequest

例 1: 指定ワークスペースを再構築します。

Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

例 2: すべてのワークスペースのコレクションを取得し、Reset-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、ワークスペースを再構築します。

Get-WKSWorkspaces | Reset-WKSWorkspace

例 1: 指定ワークスペースを再起動します。

Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

例 2: 複数のワークスペースを再起動します。

Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"

例 3: すべてのワークスペースのコレクションを取得し、Restart-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、ワークスペースを再起動します。

Get-WKSWorkspaces | Restart-WKSWorkspace

例 1: 複数のワークスペースを停止します。

Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"

例 2: すべてのワークスペースのコレクションを取得し、ワークスペースを停止させる Stop-WKSWorkspace の -WorkSpaceId WorkSpacesに ID をパイプします。

Get-WKSWorkspaces | Stop-WKSWorkspace

例 3: この例では、停止するワークスペースを定義する StopRequest オブジェクトを渡す方法を示します。

$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Stop-WKSWorkspace -Request $arrRequest

例 1: このサンプルは、指定ディレクトリから指定 IP グループを登録解除します

Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123