

文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 Tools for PowerShell V5 的 WorkSpaces 應用程式範例
<a name="powershell_5_appstream_code_examples"></a>

下列程式碼範例示範如何使用 AWS Tools for PowerShell V5 搭配 WorkSpaces 應用程式來執行動作和實作常見案例。

*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。

**Topics**
+ [動作](#actions)

## 動作
<a name="actions"></a>

### `Add-APSResourceTag`
<a name="appstream_TagResource_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Add-APSResourceTag`。

**Tools for PowerShell V5**  
**範例 1：此範例會將資源標籤新增至 AppStream 資源**  

```
Add-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -Tag @{StackState='Test'} -Select ^Tag
```
**輸出：**  

```
Name                           Value
----                           -----
StackState                     Test
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Copy-APSImage`
<a name="appstream_CopyImage_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Copy-APSImage`。

**Tools for PowerShell V5**  
**範例 1：此範例會將映像複製到其他區域**  

```
Copy-APSImage -DestinationImageName TestImageCopy -DestinationRegion us-west-2 -SourceImageName Powershell
```
**輸出：**  

```
TestImageCopy
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Disable-APSUSer`
<a name="appstream_DisableUser_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Disable-APSUSer`。

**Tools for PowerShell V5**  
**範例 1：此範例會停用 USERPOOL 中的使用者**  

```
Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DisableUser](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Enable-APSUser`
<a name="appstream_EnableUser_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Enable-APSUser`。

**Tools for PowerShell V5**  
**範例 1：此範例會在 USERPOOL 中啟用已停用的使用者**  

```
Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [EnableUser](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSAssociatedFleetList`
<a name="appstream_ListAssociatedFleets_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSAssociatedFleetList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示與堆疊相關聯的機群**  

```
Get-APSAssociatedFleetList -StackName PowershellStack
```
**輸出：**  

```
PowershellFleet
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListAssociatedFleets](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSAssociatedStackList`
<a name="appstream_ListAssociatedStacks_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSAssociatedStackList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示與機群相關聯的堆疊**  

```
Get-APSAssociatedStackList -FleetName PowershellFleet
```
**輸出：**  

```
PowershellStack
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListAssociatedStacks](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSDirectoryConfigList`
<a name="appstream_DescribeDirectoryConfigs_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSDirectoryConfigList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示 AppStream 中建立的目錄組態**  

```
Get-APSDirectoryConfigList | Select DirectoryName, OrganizationalUnitDistinguishedNames, CreatedTime
```
**輸出：**  

```
DirectoryName OrganizationalUnitDistinguishedNames CreatedTime
------------- ------------------------------------ -----------
Test.com      {OU=AppStream,DC=Test,DC=com}    9/6/2019 10:56:40 AM
contoso.com   {OU=AppStream,OU=contoso,DC=contoso,DC=com}  8/9/2019 9:08:50 AM
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeDirectoryConfigs](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSFleetList`
<a name="appstream_DescribeFleets_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSFleetList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示機群的詳細資訊**  

```
Get-APSFleetList -Name Test
```
**輸出：**  

```
Arn                            : arn:aws:appstream:us-east-1:1234567890:fleet/Test
ComputeCapacityStatus          : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime                    : 9/12/2019 5:00:45 PM
Description                    : Test
DisconnectTimeoutInSeconds     : 900
DisplayName                    : Test
DomainJoinInfo                 :
EnableDefaultInternetAccess    : False
FleetErrors                    : {}
FleetType                      : ON_DEMAND
IamRoleArn                     :
IdleDisconnectTimeoutInSeconds : 900
ImageArn                       : arn:aws:appstream:us-east-1:1234567890:image/Test
ImageName                      : Test
InstanceType                   : stream.standard.medium
MaxUserDurationInSeconds       : 57600
Name                           : Test
State                          : STOPPED
VpcConfig                      : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeFleets](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSImageBuilderList`
<a name="appstream_DescribeImageBuilders_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSImageBuilderList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示 ImageBuilder 的詳細資訊**  

```
Get-APSImageBuilderList -Name TestImage
```
**輸出：**  

```
AccessEndpoints             : {}
AppstreamAgentVersion       : 06-19-2019
Arn                         : arn:aws:appstream:us-east-1:1234567890:image-builder/TestImage
CreatedTime                 : 1/14/2019 4:33:05 AM
Description                 :
DisplayName                 : TestImage
DomainJoinInfo              :
EnableDefaultInternetAccess : False
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors          : {}
InstanceType                : stream.standard.large
Name                        : TestImage
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : STOPPED
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeImageBuilders](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSImageList`
<a name="appstream_DescribeImages_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSImageList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示私有 AppStream 映像**  

```
Get-APSImageList -Type PRIVATE | select DisplayName, ImageBuilderName, Visibility, arn
```
**輸出：**  

```
DisplayName          ImageBuilderName      Visibility Arn
-----------          ----------------      ---------- ---
OfficeApps           OfficeApps            PRIVATE    arn:aws:appstream:us-east-1:123456789012:image/OfficeApps
SessionScriptV2      SessionScriptTest     PRIVATE    arn:aws:appstream:us-east-1:123456789012:image/SessionScriptV2
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeImages](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSImagePermission`
<a name="appstream_DescribeImagePermissions_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSImagePermission`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示共享 AppStream 映像上的映像許可**  

```
Get-APSImagePermission -Name Powershell  | select SharedAccountId, @{n="AllowFleet";e={$_.ImagePermissions.AllowFleet}}, @{n="AllowImageBuilder";e={$_.ImagePermissions.AllowImageBuilder}}
```
**輸出：**  

```
SharedAccountId AllowFleet AllowImageBuilder
--------------- ---------- -----------------
123456789012          True              True
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSSessionList`
<a name="appstream_DescribeSessions_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSSessionList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示機群的工作階段清單**  

```
Get-APSSessionList -FleetName PowershellFleet -StackName PowershellStack
```
**輸出：**  

```
AuthenticationType         : API
ConnectionState            : CONNECTED
FleetName                  : PowershellFleet
Id                         : d8987c70-4394-4324-a396-2d485c26f2a2
MaxExpirationTime          : 12/27/2019 4:54:07 AM
NetworkAccessConfiguration : Amazon.AppStream.Model.NetworkAccessConfiguration
StackName                  : PowershellStack
StartTime                  : 12/26/2019 12:54:12 PM
State                      : ACTIVE
UserId                     : Test
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeSessions](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSStackList`
<a name="appstream_DescribeStacks_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSStackList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示 AppStream Stack 的清單**  

```
Get-APSStackList | Select DisplayName, Arn, CreatedTime
```
**輸出：**  

```
DisplayName                   Arn                                                                          CreatedTime
-----------                   ---                                                                          -----------
PowershellStack               arn:aws:appstream:us-east-1:123456789012:stack/PowershellStack               4/24/2019 8:49:29 AM
SessionScriptTest             arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest             9/12/2019 3:23:12 PM
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSTagsForResourceList`
<a name="appstream_ListTagsForResource_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSTagsForResourceList`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示 AppStream 資源上的標籤**  

```
Get-APSTagsForResourceList -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest
```
**輸出：**  

```
Key        Value
---        -----
StackState Test
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSUsageReportSubscription`
<a name="appstream_DescribeUsageReportSubscriptions_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSUsageReportSubscription`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示 AppStreamUsageReport 組態詳細資訊**  

```
Get-APSUsageReportSubscription
```
**輸出：**  

```
LastGeneratedReportDate S3BucketName                                   Schedule SubscriptionErrors
----------------------- ------------                                   -------- ------------------
1/1/0001 12:00:00 AM    appstream-logs-us-east-1-123456789012-sik1hnxe DAILY    {}
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeUsageReportSubscriptions](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSUser`
<a name="appstream_DescribeUsers_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSUser`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示具已啟用狀態的使用者清單**  

```
Get-APSUser -AuthenticationType USERPOOL | Select-Object UserName, AuthenticationType, Enabled
```
**輸出：**  

```
UserName                   AuthenticationType Enabled
--------                   ------------------ -------
foo1@contoso.com USERPOOL              True
foo2@contoso.com        USERPOOL              True
foo3@contoso.com    USERPOOL              True
foo4@contoso.com   USERPOOL              True
foo5@contoso.com         USERPOOL              True
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeUsers](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Get-APSUserStackAssociation`
<a name="appstream_DescribeUserStackAssociations_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Get-APSUserStackAssociation`。

**Tools for PowerShell V5**  
**範例 1：此範例顯示指派給堆疊的使用者清單**  

```
Get-APSUserStackAssociation -StackName PowershellStack
```
**輸出：**  

```
AuthenticationType SendEmailNotification StackName       UserName
------------------ --------------------- ---------       --------
USERPOOL           False                 PowershellStack TestUser1@lab.com
USERPOOL           False                 PowershellStack TestUser2@lab.com
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeUserStackAssociations](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSDirectoryConfig`
<a name="appstream_CreateDirectoryConfig_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSDirectoryConfig`。

**Tools for PowerShell V5**  
**範例 1：此範例會在 AppStream 中建立目錄組態**  

```
New-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStream,OU=Contoso,DC=Contoso,DC=com"
```
**輸出：**  

```
CreatedTime            DirectoryName OrganizationalUnitDistinguishedNames        ServiceAccountCredentials
-----------            ------------- ------------------------------------        -------------------------
12/27/2019 11:00:30 AM contoso.com   {OU=AppStream,OU=Contoso,DC=Contoso,DC=com} Amazon.AppStream.Model.ServiceAccountCredentials
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSFleet`
<a name="appstream_CreateFleet_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSFleet`。

**Tools for PowerShell V5**  
**範例 1：此範例會建立新的 AppStream 機群**  

```
New-APSFleet -ComputeCapacity_DesiredInstance 1 -InstanceType stream.standard.medium -Name TestFleet -DisplayName TestFleet -FleetType ON_DEMAND -EnableDefaultInternetAccess $True -VpcConfig_SubnetIds "subnet-123ce32","subnet-a1234cfd" -VpcConfig_SecurityGroupIds sg-4d012a34 -ImageName SessionScriptTest -Region us-west-2
```
**輸出：**  

```
Arn                            : arn:aws:appstream:us-west-2:123456789012:fleet/TestFleet
ComputeCapacityStatus          : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime                    : 12/27/2019 11:24:42 AM
Description                    :
DisconnectTimeoutInSeconds     : 900
DisplayName                    : TestFleet
DomainJoinInfo                 :
EnableDefaultInternetAccess    : True
FleetErrors                    : {}
FleetType                      : ON_DEMAND
IamRoleArn                     :
IdleDisconnectTimeoutInSeconds : 0
ImageArn                       : arn:aws:appstream:us-west-2:123456789012:image/SessionScriptTest
ImageName                      : SessionScriptTest
InstanceType                   : stream.standard.medium
MaxUserDurationInSeconds       : 57600
Name                           : TestFleet
State                          : STOPPED
VpcConfig                      : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateFleet](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSImageBuilder`
<a name="appstream_CreateImageBuilder_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSImageBuilder`。

**Tools for PowerShell V5**  
**範例 1：此範例會在 AppStream 中建立映像建置器**  

```
New-APSImageBuilder -InstanceType stream.standard.medium -Name TestIB -DisplayName TestIB -ImageName AppStream-WinServer2012R2-12-12-2019 -EnableDefaultInternetAccess $True -VpcConfig_SubnetId subnet-a1234cfd -VpcConfig_SecurityGroupIds sg-2d012a34 -Region us-west-2
```
**輸出：**  

```
AccessEndpoints             : {}
AppstreamAgentVersion       : 12-16-2019
Arn                         : arn:aws:appstream:us-west-2:123456789012:image-builder/TestIB
CreatedTime                 : 12/27/2019 11:39:24 AM
Description                 :
DisplayName                 : TestIB
DomainJoinInfo              :
EnableDefaultInternetAccess : True
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-west-2::image/AppStream-WinServer2012R2-12-12-2019
ImageBuilderErrors          : {}
InstanceType                : stream.standard.medium
Name                        : TestIB
NetworkAccessConfiguration  :
Platform                    : WINDOWS
State                       : PENDING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSImageBuilderStreamingURL`
<a name="appstream_CreateImageBuilderStreamingURL_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSImageBuilderStreamingURL`。

**Tools for PowerShell V5**  
**範例 1：此範例會建立 2 小時有效時間的 ImageBuilder 串流 URL**  

```
New-APSImageBuilderStreamingURL -Name TestIB -Validity 7200 -Region us-west-2
```
**輸出：**  

```
Expires               StreamingURL
-------               ------------
12/27/2019 1:49:13 PM https://appstream2.us-west-2.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiQURNSU4iLCJleHBpcmVzIjoiMTU3NzQ1NDU1MyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6ImFkbWluIiwiY2F
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateImageBuilderStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSStack`
<a name="appstream_CreateStack_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSStack`。

**Tools for PowerShell V5**  
**範例 1：此範例建立新的 AppStream 堆疊**  

```
New-APSStack -Name TestStack -DisplayName TestStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup TestStack -Region us-west-2
```
**輸出：**  

```
AccessEndpoints     : {}
ApplicationSettings : Amazon.AppStream.Model.ApplicationSettingsResponse
Arn                 : arn:aws:appstream:us-west-2:123456789012:stack/TestStack
CreatedTime         : 12/27/2019 12:34:19 PM
Description         :
DisplayName         : TestStack
EmbedHostDomains    : {}
FeedbackURL         :
Name                : TestStack
RedirectURL         :
StackErrors         : {}
StorageConnectors   : {}
UserSettings        : {Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting}
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateStack](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSStreamingURL`
<a name="appstream_CreateStreamingURL_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSStreamingURL`。

**Tools for PowerShell V5**  
**範例 1：此範例會建立堆疊的串流 URL**  

```
New-APSStreamingURL -StackName SessionScriptTest -FleetName SessionScriptNew -UserId TestUser
```
**輸出：**  

```
Expires                StreamingURL
-------                ------------
12/27/2019 12:43:37 PM https://appstream2.us-east-1.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiRU5EX1VTRVIiLCJleHBpcmVzIjoiMTU3NzQ1MDYxNyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6IlRlc3RVc2
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSUsageReportSubscription`
<a name="appstream_CreateUsageReportSubscription_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSUsageReportSubscription`。

**Tools for PowerShell V5**  
**範例 1：此範例會啟用 AppStream 用量報告**  

```
New-APSUsageReportSubscription
```
**輸出：**  

```
S3BucketName                                   Schedule
------------                                   --------
appstream-logs-us-east-1-123456789012-sik2hnxe DAILY
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)。

### `New-APSUser`
<a name="appstream_CreateUser_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `New-APSUser`。

**Tools for PowerShell V5**  
**範例 1：此範例會在 USERPOOL 中建立使用者**  

```
New-APSUser -UserName Test@lab.com -AuthenticationType USERPOOL -FirstName 'kt' -LastName 'aws' -Select ^UserName
```
**輸出：**  

```
Test@lab.com
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateUser](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Register-APSFleet`
<a name="appstream_AssociateFleet_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Register-APSFleet`。

**Tools for PowerShell V5**  
**範例 1：此範例會向堆疊註冊機群**  

```
Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [AssociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Register-APSUserStackBatch`
<a name="appstream_BatchAssociateUserStack_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Register-APSUserStackBatch`。

**Tools for PowerShell V5**  
**範例 1：此範例會將堆疊指派給 USERPOOL 中的使用者**  

```
Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [BatchAssociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSDirectoryConfig`
<a name="appstream_DeleteDirectoryConfig_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSDirectoryConfig`。

**Tools for PowerShell V5**  
**範例 1：此範例會移除 AppStream Directory 組態**  

```
Remove-APSDirectoryConfig -DirectoryName contoso.com
```
**輸出：**  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSDirectoryConfig (DeleteDirectoryConfig)" on target "contoso.com".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSFleet`
<a name="appstream_DeleteFleet_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSFleet`。

**Tools for PowerShell V5**  
**範例 1：此範例會刪除 AppStream 機群**  

```
Remove-APSFleet -Name TestFleet -Region us-west-2
```
**輸出：**  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSFleet (DeleteFleet)" on target "TestFleet".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteFleet](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSImage`
<a name="appstream_DeleteImage_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSImage`。

**Tools for PowerShell V5**  
**範例 1：此範例會刪除映像**  

```
Remove-APSImage -Name TestImage -Region us-west-2
```
**輸出：**  

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

Applications                : {}
AppstreamAgentVersion       : LATEST
Arn                         : arn:aws:appstream:us-west-2:123456789012:image/TestImage
BaseImageArn                :
CreatedTime                 : 12/27/2019 1:34:10 PM
Description                 :
DisplayName                 : TestImage
ImageBuilderName            :
ImageBuilderSupported       : True
ImagePermissions            :
Name                        : TestImage
Platform                    : WINDOWS
PublicBaseImageReleasedDate : 6/12/2018 12:00:00 AM
State                       : AVAILABLE
StateChangeReason           :
Visibility                  : PRIVATE
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteImage](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSImageBuilder`
<a name="appstream_DeleteImageBuilder_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSImageBuilder`。

**Tools for PowerShell V5**  
**範例 1：此範例會刪除 ImageBuilder**  

```
Remove-APSImageBuilder -Name TestIB -Region us-west-2
```
**輸出：**  

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

AccessEndpoints             : {}
AppstreamAgentVersion       : 12-16-2019
Arn                         : arn:aws:appstream:us-west-2:123456789012:image-builder/TestIB
CreatedTime                 : 12/27/2019 11:39:24 AM
Description                 :
DisplayName                 : TestIB
DomainJoinInfo              :
EnableDefaultInternetAccess : True
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-west-2::image/AppStream-WinServer2012R2-12-12-2019
ImageBuilderErrors          : {}
InstanceType                : stream.standard.medium
Name                        : TestIB
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : DELETING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSImagePermission`
<a name="appstream_DeleteImagePermissions_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSImagePermission`。

**Tools for PowerShell V5**  
**範例 1：此範例會移除映像的許可**  

```
Remove-APSImagePermission -Name Powershell -SharedAccountId 123456789012
```
**輸出：**  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSImagePermission (DeleteImagePermissions)" on target "Powershell".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSResourceTag`
<a name="appstream_UntagResource_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSResourceTag`。

**Tools for PowerShell V5**  
**範例 1：此範例會從 AppStream 資源移除資源標籤**  

```
Remove-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -TagKey StackState
```
**輸出：**  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSResourceTag (UntagResource)" on target "arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSStack`
<a name="appstream_DeleteStack_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSStack`。

**Tools for PowerShell V5**  
**範例 1：此範例會刪除堆疊**  

```
Remove-APSStack -Name TestStack -Region us-west-2
```
**輸出：**  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSStack (DeleteStack)" on target "TestStack".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
```
+  如需 API 詳細資訊，請參閱《*AWS Tools for PowerShell Cmdlet 參考 (V5)*》中的 [DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSUsageReportSubscription`
<a name="appstream_DeleteUsageReportSubscription_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSUsageReportSubscription`。

**Tools for PowerShell V5**  
**範例 1：此範例會停用 AppStream 用量報告訂閱**  

```
Remove-APSUsageReportSubscription
```
**輸出：**  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSUsageReportSubscription (DeleteUsageReportSubscription)" on target "".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Remove-APSUser`
<a name="appstream_DeleteUser_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Remove-APSUser`。

**Tools for PowerShell V5**  
**範例 1：此範例會從 USERPOOL 刪除使用者**  

```
Remove-APSUser -UserName TestUser@lab.com -AuthenticationType USERPOOL
```
**輸出：**  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSUser (DeleteUser)" on target "TestUser@lab.com".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Revoke-APSSession`
<a name="appstream_ExpireSession_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Revoke-APSSession`。

**Tools for PowerShell V5**  
**範例 1：此範例會撤銷 AppStream 機群的工作階段**  

```
Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ExpireSession](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Start-APSFleet`
<a name="appstream_StartFleet_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Start-APSFleet`。

**Tools for PowerShell V5**  
**範例 1：此範例會啟動機群**  

```
Start-APSFleet -Name PowershellFleet
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StartFleet](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Start-APSImageBuilder`
<a name="appstream_StartImageBuilder_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Start-APSImageBuilder`。

**Tools for PowerShell V5**  
**範例 1：此範例會啟動 ImageBuilder**  

```
Start-APSImageBuilder -Name TestImage
```
**輸出：**  

```
AccessEndpoints             : {}
AppstreamAgentVersion       : 06-19-2019
Arn                         : arn:aws:appstream:us-east-1:123456789012:image-builder/TestImage
CreatedTime                 : 1/14/2019 4:33:05 AM
Description                 :
DisplayName                 : TestImage
DomainJoinInfo              :
EnableDefaultInternetAccess : False
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors          : {}
InstanceType                : stream.standard.large
Name                        : TestImage
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : PENDING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StartImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Stop-APSFleet`
<a name="appstream_StopFleet_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Stop-APSFleet`。

**Tools for PowerShell V5**  
**範例 1：此範例會停止機群**  

```
Stop-APSFleet -Name PowershellFleet
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StopFleet](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Stop-APSImageBuilder`
<a name="appstream_StopImageBuilder_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Stop-APSImageBuilder`。

**Tools for PowerShell V5**  
**範例 1：此範例會停止 ImageBuilder**  

```
Stop-APSImageBuilder -Name TestImage
```
**輸出：**  

```
AccessEndpoints             : {}
AppstreamAgentVersion       : 06-19-2019
Arn                         : arn:aws:appstream:us-east-1:123456789012:image-builder/TestImage
CreatedTime                 : 1/14/2019 4:33:05 AM
Description                 :
DisplayName                 : TestImage
DomainJoinInfo              :
EnableDefaultInternetAccess : False
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors          : {}
InstanceType                : stream.standard.large
Name                        : TestImage
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : STOPPING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StopImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Unregister-APSFleet`
<a name="appstream_DisassociateFleet_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Unregister-APSFleet`。

**Tools for PowerShell V5**  
**範例 1：此範例會從堆疊取消註冊機群**  

```
Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DisassociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Unregister-APSUserStackBatch`
<a name="appstream_BatchDisassociateUserStack_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Unregister-APSUserStackBatch`。

**Tools for PowerShell V5**  
**範例 1：此範例會從指派的堆疊移除使用者**  

```
Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [BatchDisassociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Update-APSDirectoryConfig`
<a name="appstream_UpdateDirectoryConfig_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Update-APSDirectoryConfig`。

**Tools for PowerShell V5**  
**範例 1：此範例會更新在 AppStream 中建立的目錄組態**  

```
Update-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass@1$@# -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com"
```
**輸出：**  

```
CreatedTime           DirectoryName OrganizationalUnitDistinguishedNames           ServiceAccountCredentials
-----------           ------------- ------------------------------------           -------------------------
12/27/2019 3:50:02 PM contoso.com   {OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com} Amazon.AppStream.Model.ServiceAccountCredentials
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Update-APSFleet`
<a name="appstream_UpdateFleet_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Update-APSFleet`。

**Tools for PowerShell V5**  
**範例 1：此範例會更新機群的屬性**  

```
Update-APSFleet -Name PowershellFleet -EnableDefaultInternetAccess $True -DisconnectTimeoutInSecond 950
```
**輸出：**  

```
Arn                            : arn:aws:appstream:us-east-1:123456789012:fleet/PowershellFleet
ComputeCapacityStatus          : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime                    : 4/24/2019 8:39:41 AM
Description                    : PowershellFleet
DisconnectTimeoutInSeconds     : 950
DisplayName                    : PowershellFleet
DomainJoinInfo                 :
EnableDefaultInternetAccess    : True
FleetErrors                    : {}
FleetType                      : ON_DEMAND
IamRoleArn                     :
IdleDisconnectTimeoutInSeconds : 900
ImageArn                       : arn:aws:appstream:us-east-1:123456789012:image/Powershell
ImageName                      : Powershell
InstanceType                   : stream.standard.medium
MaxUserDurationInSeconds       : 57600
Name                           : PowershellFleet
State                          : STOPPED
VpcConfig                      : Amazon.AppStream.Model.VpcConfig
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateFleet](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Update-APSImagePermission`
<a name="appstream_UpdateImagePermissions_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Update-APSImagePermission`。

**Tools for PowerShell V5**  
**範例 1：此範例會與其他帳戶共用 AppStream 映像**  

```
Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)。

### `Update-APSStack`
<a name="appstream_UpdateStack_powershell_5_topic"></a>

以下程式碼範例顯示如何使用 `Update-APSStack`。

**Tools for PowerShell V5**  
**範例 1：此範例會更新 (啟用) 堆疊上的應用程式設定持續性和主資料夾**  

```
Update-APSStack -Name PowershellStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup PowershellStack -StorageConnector @{ConnectorType="HOMEFOLDERS"}
```
**輸出：**  

```
AccessEndpoints     : {}
ApplicationSettings : Amazon.AppStream.Model.ApplicationSettingsResponse
Arn                 : arn:aws:appstream:us-east-1:123456789012:stack/PowershellStack
CreatedTime         : 4/24/2019 8:49:29 AM
Description         : PowershellStack
DisplayName         : PowershellStack
EmbedHostDomains    : {}
FeedbackURL         :
Name                : PowershellStack
RedirectURL         :
StackErrors         : {}
StorageConnectors   : {Amazon.AppStream.Model.StorageConnector, Amazon.AppStream.Model.StorageConnector}
UserSettings        : {Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting}
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)。