Tools for PowerShell を使用した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: このサンプルは、us-west-2 から指定された ID を持つワークスペースイメージを、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: このサンプルは、指定されたワークスペースの Workspace Running Mode プロパティを Auto Stop に変更します。

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

例 1: このサンプルは、指定された Workspace の状態を Available に変更します。

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

例 1: このサンプルは、指定されたディレクトリの Workspace クライアントのクライアントプロパティを取得します。

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: このサンプルは、指定された Workspace のタグを取得します

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

出力:

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

例 1: パイプラインにすべての your WorkSpaces の詳細を取得します。

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/APIWorkspaceProperties.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リージョン内のワークスペースRootVolumeSizeGibWorkSpacePropertiesの の子プロパティの値を表示します。GiB のルートボリュームサイズは 80 です。

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

出力:

        80

例 1: このサンプルは、現在のリージョンのすべての Workspace バンドルの詳細を取得します。

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: このサンプルは、指定された Workspace 用に作成された最新のスナップショットのタイムスタンプを示しています。

Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v

出力:

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

例 1: このサンプルは、指定された Workspace の接続ステータスを取得します。

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: 指定されたバンドル、ディレクトリ、ユーザーの a WorkSpace を作成します。

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

例 2: この例では multiple WorkSpaces を作成します

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 Service の指定されたディレクトリを登録します。

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: このサンプルは Workspace に関連付けられたタグを削除します。

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: multiple WorkSpaces を終了します。 -Force スイッチを使用すると、コマンドレットの確認プロンプトが停止します。

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

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

Get-WKSWorkspaces | Remove-WKSWorkspace

例 3: この例では、終了する TerminateRequest を定義する WorkSpaces オブジェクトを渡す方法を示しています。-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: 指定された WorkSpace を再構築します。

Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

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

Get-WKSWorkspaces | Reset-WKSWorkspace

例 1: 指定された WorkSpace を再起動します。

Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

例 2: multiple WorkSpaces を再起動します。

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

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

Get-WKSWorkspaces | Restart-WKSWorkspace

例 1: multiple WorkSpaces を停止します。

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

例 2: すべての your WorkSpaces のコレクションを取得し、IDs を停止させる Stop-WKSWorkspace の -WorkSpaceId パラメータに WorkSpaces をパイプします。

Get-WKSWorkspaces | Stop-WKSWorkspace

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

$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