WorkSpaces Tools for を使用した の例 PowerShell - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

WorkSpaces Tools for を使用した の例 PowerShell

次のコード例は、 AWS Tools for PowerShell で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています WorkSpaces。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、関連するシナリオやサービス間の例ではアクションのコンテキストが確認できます。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、Approve-WKSIpRule を使用する方法を説明しています。

のツール PowerShell

例 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
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスAuthorizeIpRules」の「」を参照してください。

次の例は、Copy-WKSWorkspaceImage を使用する方法を説明しています。

のツール PowerShell

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

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

出力:

wsi-456abaqfe
  • API の詳細については、「 コマンドレットリファレンスCopyWorkspaceImage」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Edit-WKSClientProperty を使用する方法を説明しています。

のツール PowerShell

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

Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369
  • API の詳細については、「 コマンドレットリファレンスModifyClientProperties」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Edit-WKSSelfServicePermission を使用する方法を説明しています。

のツール PowerShell

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

Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED
  • API の詳細については、「 コマンドレットリファレンスModifySelfservicePermissions」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Edit-WKSWorkspaceAccessProperty を使用する方法を説明しています。

のツール PowerShell

例 1: このサンプルでは、指定したディレクトリの Android および Chrome OS で Workspace アクセスを有効にします。

Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW
  • API の詳細については、「 コマンドレットリファレンスModifyWorkspaceAccessProperties」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Edit-WKSWorkspaceCreationProperty を使用する方法を説明しています。

のツール PowerShell

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

Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
  • API の詳細については、「 コマンドレットリファレンスModifyWorkspaceCreationProperties」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Edit-WKSWorkspaceProperty を使用する方法を説明しています。

のツール PowerShell

例 1: このサンプルでは、指定した Workspace の Workspace 実行モードプロパティを自動停止に変更します。

Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
  • API の詳細については、「 コマンドレットリファレンスModifyWorkspaceProperties」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Edit-WKSWorkspaceState を使用する方法を説明しています。

のツール PowerShell

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

Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
  • API の詳細については、「 コマンドレットリファレンスModifyWorkspaceState」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-WKSClientProperty を使用する方法を説明しています。

のツール PowerShell

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

Get-WKSClientProperty -ResourceId d-223562a123
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeClientProperties」の「」を参照してください。

次の例は、Get-WKSIpGroup を使用する方法を説明しています。

のツール PowerShell

例 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}
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeIpGroups」の「」を参照してください。

次の例は、Get-WKSTag を使用する方法を説明しています。

のツール PowerShell

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

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

出力:

Key Value --- ----- auto-delete no purpose Workbench
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeTags」の「」を参照してください。

次の例は、Get-WKSWorkspace を使用する方法を説明しています。

のツール PowerShell

例 1: すべての の詳細をパイプライン 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/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リージョンのワークスペースRootVolumeSizeGibWorkSpacePropertiesの の子プロパティの値を表示します。ルートボリュームサイズは、GiB 単位の 80 です。

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

出力:

80
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeWorkspaces」の「」を参照してください。

次の例は、Get-WKSWorkspaceBundle を使用する方法を説明しています。

のツール PowerShell

例 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
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeWorkspaceBundles」の「」を参照してください。

次の例は、Get-WKSWorkspaceDirectory を使用する方法を説明しています。

のツール PowerShell

例 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
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeWorkspaceDirectories」の「」を参照してください。

次の例は、Get-WKSWorkspaceImage を使用する方法を説明しています。

のツール PowerShell

例 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
  • API の詳細については、「 コマンドレットリファレンスDescribeWorkspaceImages」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-WKSWorkspaceSnapshot を使用する方法を説明しています。

のツール PowerShell

例 1: このサンプルは、指定した Workspace 用に作成された最新のスナップショットのタイムスタンプを示しています。

Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v

出力:

RebuildSnapshots RestoreSnapshots ---------------- ---------------- {Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}
  • API の詳細については、「 コマンドレットリファレンスDescribeWorkspaceSnapshots」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-WKSWorkspacesConnectionStatus を使用する方法を説明しています。

のツール PowerShell

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

Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
  • API の詳細については、「 コマンドレットリファレンスDescribeWorkspacesConnectionStatus」の「」を参照してください。 AWS Tools for PowerShell

次の例は、New-WKSIpGroup を使用する方法を説明しています。

のツール PowerShell

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

New-WKSIpGroup -GroupName "FreshNewIPGroup"

出力:

wsipg-w45rty4ty
  • API の詳細については、「 コマンドレットリファレンスCreateIpGroup」の「」を参照してください。 AWS Tools for PowerShell

次の例は、New-WKSTag を使用する方法を説明しています。

のツール PowerShell

例 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
  • API の詳細については、「 コマンドレットリファレンスCreateTags」の「」を参照してください。 AWS Tools for PowerShell

次の例は、New-WKSWorkspace を使用する方法を説明しています。

のツール PowerShell

例 1: 指定されたバンドル、ディレクトリ、およびユーザー WorkSpace 用に を作成します。

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

例 2: この例では、複数の WorkSpaces

New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスCreateWorkspaces」の「」を参照してください。

次の例は、Register-WKSIpGroup を使用する方法を説明しています。

のツール PowerShell

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

Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスAssociateIpGroups」の「」を参照してください。

次の例は、Register-WKSWorkspaceDirectory を使用する方法を説明しています。

のツール PowerShell

例 1: このサンプルでは、Workspaces Service に指定されたディレクトリを登録します。

Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
  • API の詳細については、「 コマンドレットリファレンスRegisterWorkspaceDirectory」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-WKSIpGroup を使用する方法を説明しています。

のツール PowerShell

例 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
  • API の詳細については、「 コマンドレットリファレンスDeleteIpGroup」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-WKSTag を使用する方法を説明しています。

のツール PowerShell

例 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
  • API の詳細については、「 コマンドレットリファレンスDeleteTags」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-WKSWorkspace を使用する方法を説明しています。

のツール PowerShell

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

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

例 2: すべての のコレクションを取得し、その IDs を Remove-WKSWorkspace の WorkSpaceId パラメータにパイプ WorkSpaces して、すべての を終了します 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
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスTerminateWorkspaces」の「」を参照してください。

次の例は、Reset-WKSWorkspace を使用する方法を説明しています。

のツール PowerShell

例 1: 指定した を再構築します WorkSpace。

Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

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

Get-WKSWorkspaces | Reset-WKSWorkspace
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスRebuildWorkspaces」の「」を参照してください。

次の例は、Restart-WKSWorkspace を使用する方法を説明しています。

のツール PowerShell

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

Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

例 2: 複数の を再起動します WorkSpaces。

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

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

Get-WKSWorkspaces | Restart-WKSWorkspace
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスRebootWorkspaces」の「」を参照してください。

次の例は、Stop-WKSWorkspace を使用する方法を説明しています。

のツール PowerShell

例 1: 複数の を停止します WorkSpaces。

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

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

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
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスStopWorkspaces」の「」を参照してください。

次の例は、Unregister-WKSIpGroup を使用する方法を説明しています。

のツール PowerShell

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

Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123
  • API の詳細については、「 コマンドレットリファレンスDisassociateIpGroups」の「」を参照してください。 AWS Tools for PowerShell