A versão 5 (V5) do Ferramentas da AWS para PowerShell foi lançada\$1
Para obter informações sobre mudanças significativas e migrar seus aplicativos, consulte o [tópico de migração](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html).
[https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html)
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# WorkSpaces Exemplos de aplicativos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com WorkSpaces aplicativos.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-APSResourceTag`
O código de exemplo a seguir mostra como usar `Add-APSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo adiciona uma tag de recurso ao AppStream recurso**
```
Add-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -Tag @{StackState='Test'} -Select ^Tag
```
**Saída**:
```
Name Value
---- -----
StackState Test
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Copy-APSImage`
O código de exemplo a seguir mostra como usar `Copy-APSImage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra copia uma imagem para outra região**
```
Copy-APSImage -DestinationImageName TestImageCopy -DestinationRegion us-west-2 -SourceImageName Powershell
```
**Saída**:
```
TestImageCopy
```
+ Para obter detalhes da API, consulte [CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-APSUSer`
O código de exemplo a seguir mostra como usar `Disable-APSUSer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra desativa um usuário em USERPOOL**
```
Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ Para obter detalhes da API, consulte [DisableUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-APSUser`
O código de exemplo a seguir mostra como usar `Enable-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra ativa um usuário desativado em USERPOOL**
```
Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ Para obter detalhes da API, consulte [EnableUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSAssociatedFleetList`
O código de exemplo a seguir mostra como usar `Get-APSAssociatedFleetList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a frota associada a uma pilha**
```
Get-APSAssociatedFleetList -StackName PowershellStack
```
**Saída**:
```
PowershellFleet
```
+ Para obter detalhes da API, consulte [ListAssociatedFleets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSAssociatedStackList`
O código de exemplo a seguir mostra como usar `Get-APSAssociatedStackList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a frota associada a uma frota**
```
Get-APSAssociatedStackList -FleetName PowershellFleet
```
**Saída**:
```
PowershellStack
```
+ Para obter detalhes da API, consulte [ListAssociatedStacks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSDirectoryConfigList`
O código de exemplo a seguir mostra como usar `Get-APSDirectoryConfigList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe as configurações de diretório criadas em AppStream**
```
Get-APSDirectoryConfigList | Select DirectoryName, OrganizationalUnitDistinguishedNames, CreatedTime
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DescribeDirectoryConfigs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSFleetList`
O código de exemplo a seguir mostra como usar `Get-APSFleetList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe detalhes de uma frota**
```
Get-APSFleetList -Name Test
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DescribeFleets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSImageBuilderList`
O código de exemplo a seguir mostra como usar `Get-APSImageBuilderList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esta amostra exibe detalhes de um ImageBuilder**
```
Get-APSImageBuilderList -Name TestImage
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DescribeImageBuilders](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSImageList`
O código de exemplo a seguir mostra como usar `Get-APSImageList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe AppStream imagens privadas**
```
Get-APSImageList -Type PRIVATE | select DisplayName, ImageBuilderName, Visibility, arn
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DescribeImages](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSImagePermission`
O código de exemplo a seguir mostra como usar `Get-APSImagePermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe permissões de imagem em uma AppStream imagem compartilhada**
```
Get-APSImagePermission -Name Powershell | select SharedAccountId, @{n="AllowFleet";e={$_.ImagePermissions.AllowFleet}}, @{n="AllowImageBuilder";e={$_.ImagePermissions.AllowImageBuilder}}
```
**Saída**:
```
SharedAccountId AllowFleet AllowImageBuilder
--------------- ---------- -----------------
123456789012 True True
```
+ Para obter detalhes da API, consulte [DescribeImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSSessionList`
O código de exemplo a seguir mostra como usar `Get-APSSessionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a lista de sessões de uma frota**
```
Get-APSSessionList -FleetName PowershellFleet -StackName PowershellStack
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DescribeSessions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSStackList`
O código de exemplo a seguir mostra como usar `Get-APSStackList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe uma lista de AppStream pilhas**
```
Get-APSStackList | Select DisplayName, Arn, CreatedTime
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSTagsForResourceList`
O código de exemplo a seguir mostra como usar `Get-APSTagsForResourceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe tags em um AppStream recurso**
```
Get-APSTagsForResourceList -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest
```
**Saída**:
```
Key Value
--- -----
StackState Test
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSUsageReportSubscription`
O código de exemplo a seguir mostra como usar `Get-APSUsageReportSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe detalhes AppStreamUsageReport de configuração**
```
Get-APSUsageReportSubscription
```
**Saída**:
```
LastGeneratedReportDate S3BucketName Schedule SubscriptionErrors
----------------------- ------------ -------- ------------------
1/1/0001 12:00:00 AM appstream-logs-us-east-1-123456789012-sik1hnxe DAILY {}
```
+ Para obter detalhes da API, consulte [DescribeUsageReportSubscriptions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSUser`
O código de exemplo a seguir mostra como usar `Get-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a lista de usuários com status ativado**
```
Get-APSUser -AuthenticationType USERPOOL | Select-Object UserName, AuthenticationType, Enabled
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DescribeUsers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSUserStackAssociation`
O código de exemplo a seguir mostra como usar `Get-APSUserStackAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a lista de usuários atribuídos a uma pilha**
```
Get-APSUserStackAssociation -StackName PowershellStack
```
**Saída**:
```
AuthenticationType SendEmailNotification StackName UserName
------------------ --------------------- --------- --------
USERPOOL False PowershellStack TestUser1@lab.com
USERPOOL False PowershellStack TestUser2@lab.com
```
+ Para obter detalhes da API, consulte [DescribeUserStackAssociations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSDirectoryConfig`
O código de exemplo a seguir mostra como usar `New-APSDirectoryConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo cria uma configuração de diretório no AppStream**
```
New-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStream,OU=Contoso,DC=Contoso,DC=com"
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [CreateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSFleet`
O código de exemplo a seguir mostra como usar `New-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma nova AppStream frota**
```
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
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [CreateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSImageBuilder`
O código de exemplo a seguir mostra como usar `New-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um Image Builder em 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
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [CreateImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSImageBuilderStreamingURL`
O código de exemplo a seguir mostra como usar `New-APSImageBuilderStreamingURL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um URL ImageBuilder de streaming com validade de 2 horas**
```
New-APSImageBuilderStreamingURL -Name TestIB -Validity 7200 -Region us-west-2
```
**Saída**:
```
Expires StreamingURL
------- ------------
12/27/2019 1:49:13 PM https://appstream2.us-west-2.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiQURNSU4iLCJleHBpcmVzIjoiMTU3NzQ1NDU1MyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6ImFkbWluIiwiY2F
```
+ Para obter detalhes da API, consulte [CreateImageBuilderStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência do Ferramentas da AWS para PowerShell Cmdlet (V5)*.
### `New-APSStack`
O código de exemplo a seguir mostra como usar `New-APSStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma nova AppStream pilha**
```
New-APSStack -Name TestStack -DisplayName TestStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup TestStack -Region us-west-2
```
**Saída**:
```
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}
```
+ Para obter detalhes da API, consulte [CreateStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSStreamingURL`
O código de exemplo a seguir mostra como usar `New-APSStreamingURL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra cria um URL de streaming da pilha**
```
New-APSStreamingURL -StackName SessionScriptTest -FleetName SessionScriptNew -UserId TestUser
```
**Saída**:
```
Expires StreamingURL
------- ------------
12/27/2019 12:43:37 PM https://appstream2.us-east-1.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiRU5EX1VTRVIiLCJleHBpcmVzIjoiMTU3NzQ1MDYxNyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6IlRlc3RVc2
```
+ Para obter detalhes da API, consulte [CreateStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência do Ferramentas da AWS para PowerShell Cmdlet (V5)*.
### `New-APSUsageReportSubscription`
O código de exemplo a seguir mostra como usar `New-APSUsageReportSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo habilita relatórios AppStream de uso**
```
New-APSUsageReportSubscription
```
**Saída**:
```
S3BucketName Schedule
------------ --------
appstream-logs-us-east-1-123456789012-sik2hnxe DAILY
```
+ Para obter detalhes da API, consulte [CreateUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSUser`
O código de exemplo a seguir mostra como usar `New-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra cria um usuário em USERPOOL**
```
New-APSUser -UserName Test@lab.com -AuthenticationType USERPOOL -FirstName 'kt' -LastName 'aws' -Select ^UserName
```
**Saída**:
```
Test@lab.com
```
+ Para obter detalhes da API, consulte [CreateUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-APSFleet`
O código de exemplo a seguir mostra como usar `Register-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra registra a frota com uma pilha**
```
Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ Para obter detalhes da API, consulte [AssociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-APSUserStackBatch`
O código de exemplo a seguir mostra como usar `Register-APSUserStackBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra atribui a pilha a um usuário em USERPOOL**
```
Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ Para obter detalhes da API, consulte [BatchAssociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSDirectoryConfig`
O código de exemplo a seguir mostra como usar `Remove-APSDirectoryConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove a configuração AppStream do diretório**
```
Remove-APSDirectoryConfig -DirectoryName contoso.com
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSFleet`
O código de exemplo a seguir mostra como usar `Remove-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove e exclui uma frota AppStream **
```
Remove-APSFleet -Name TestFleet -Region us-west-2
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSImage`
O código de exemplo a seguir mostra como usar `Remove-APSImage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exclui uma imagem**
```
Remove-APSImage -Name TestImage -Region us-west-2
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSImageBuilder`
O código de exemplo a seguir mostra como usar `Remove-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui um ImageBuilder**
```
Remove-APSImageBuilder -Name TestIB -Region us-west-2
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSImagePermission`
O código de exemplo a seguir mostra como usar `Remove-APSImagePermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra remove as permissões de uma imagem**
```
Remove-APSImagePermission -Name Powershell -SharedAccountId 123456789012
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSResourceTag`
O código de exemplo a seguir mostra como usar `Remove-APSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo remove uma tag de recurso do AppStream recurso**
```
Remove-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -TagKey StackState
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSStack`
O código de exemplo a seguir mostra como usar `Remove-APSStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exclui uma pilha**
```
Remove-APSStack -Name TestStack -Region us-west-2
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSUsageReportSubscription`
O código de exemplo a seguir mostra como usar `Remove-APSUsageReportSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo desativa a assinatura do Relatório AppStream de Uso**
```
Remove-APSUsageReportSubscription
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSUser`
O código de exemplo a seguir mostra como usar `Remove-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exclui um usuário de USERPOOL**
```
Remove-APSUser -UserName TestUser@lab.com -AuthenticationType USERPOOL
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Revoke-APSSession`
O código de exemplo a seguir mostra como usar `Revoke-APSSession`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo revoga uma sessão para a frota AppStream **
```
Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877
```
+ Para obter detalhes da API, consulte [ExpireSession](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-APSFleet`
O código de exemplo a seguir mostra como usar `Start-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra inicia uma frota**
```
Start-APSFleet -Name PowershellFleet
```
+ Para obter detalhes da API, consulte [StartFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-APSImageBuilder`
O código de exemplo a seguir mostra como usar `Start-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esta amostra inicia um ImageBuilder**
```
Start-APSImageBuilder -Name TestImage
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [StartImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-APSFleet`
O código de exemplo a seguir mostra como usar `Stop-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra interrompe uma frota**
```
Stop-APSFleet -Name PowershellFleet
```
+ Para obter detalhes da API, consulte [StopFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-APSImageBuilder`
O código de exemplo a seguir mostra como usar `Stop-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esta amostra interrompe um ImageBuilder**
```
Stop-APSImageBuilder -Name TestImage
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [StopImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-APSFleet`
O código de exemplo a seguir mostra como usar `Unregister-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra cancela o registro de uma frota da pilha**
```
Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ Para obter detalhes da API, consulte [DisassociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-APSUserStackBatch`
O código de exemplo a seguir mostra como usar `Unregister-APSUserStackBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra remove um usuário de uma pilha atribuída**
```
Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ Para obter detalhes da API, consulte [BatchDisassociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSDirectoryConfig`
O código de exemplo a seguir mostra como usar `Update-APSDirectoryConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo atualiza a configuração do diretório criada no AppStream**
```
Update-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass@1$@# -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com"
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [UpdateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSFleet`
O código de exemplo a seguir mostra como usar `Update-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra atualiza as propriedades de uma frota**
```
Update-APSFleet -Name PowershellFleet -EnableDefaultInternetAccess $True -DisconnectTimeoutInSecond 950
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [UpdateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSImagePermission`
O código de exemplo a seguir mostra como usar `Update-APSImagePermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esta amostra compartilha uma AppStream imagem com outra conta**
```
Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True
```
+ Para obter detalhes da API, consulte [UpdateImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSStack`
O código de exemplo a seguir mostra como usar `Update-APSStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra atualiza (ativa) a persistência das configurações do aplicativo e as pastas pessoais em uma pilha**
```
Update-APSStack -Name PowershellStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup PowershellStack -StorageConnector @{ConnectorType="HOMEFOLDERS"}
```
**Saída**:
```
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}
```
+ Para obter detalhes da API, consulte [UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.