Se ha publicado la versión 5 (V5) de Herramientas de AWS para PowerShell.
Para empezar a utilizar la nueva versión de Tools para PowerShell, consulte la Guía del usuario de Herramientas de AWS para PowerShell (V5), especialmente el tema sobre la Migración a la V5.
Ejemplos de WorkSpaces Applications con las Herramientas para PowerShell V4
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante Herramientas de AWS para PowerShell V4 con WorkSpaces Applications.
Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
Temas
Acciones
En el siguiente ejemplo de código, se muestra cómo utilizar Add-APSResourceTag.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se añade una etiqueta de recurso al recurso de AppStream
Add-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -Tag @{StackState='Test'} -Select ^TagSalida:
Name Value ---- ----- StackState Test-
Para obtener información sobre la API, consulte TagResource en la Referencia de Cmdlet de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Copy-APSImage.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se copia una imagen a otra región
Copy-APSImage -DestinationImageName TestImageCopy -DestinationRegion us-west-2 -SourceImageName PowershellSalida:
TestImageCopy-
Para obtener información sobre la API, consulte CopyImage en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Disable-APSUSer.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se deshabilita a un usuario en USERPOOL
Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com-
Para obtener información sobre la API, consulte DisableUser en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Enable-APSUser.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se habilita a un usuario deshabilitado en USERPOOL
Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com-
Para obtener información sobre la API, consulte EnableUser en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSAssociatedFleetList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestra la flota asociada a una pila
Get-APSAssociatedFleetList -StackName PowershellStackSalida:
PowershellFleet-
Para obtener información sobre la API, consulte ListAssociatedFleets en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSAssociatedStackList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestra la pila asociada a una flota
Get-APSAssociatedStackList -FleetName PowershellFleetSalida:
PowershellStack-
Para obtener información sobre la API, consulte ListAssociatedStacks en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSDirectoryConfigList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestran las configuraciones de directorio creadas en AppStream
Get-APSDirectoryConfigList | Select DirectoryName, OrganizationalUnitDistinguishedNames, CreatedTimeSalida:
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 obtener información sobre la API, consulte DescribeDirectoryConfigs en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSFleetList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestran los detalles de una flota
Get-APSFleetList -Name TestSalida:
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 obtener información sobre la API, consulte DescribeFleets en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSImageBuilderList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestran los detalles de un ImageBuilder
Get-APSImageBuilderList -Name TestImageSalida:
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 obtener información sobre la API, consulte DescribeImageBuilders en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSImageList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestran imágenes privadas de AppStream
Get-APSImageList -Type PRIVATE | select DisplayName, ImageBuilderName, Visibility, arnSalida:
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 obtener información sobre la API, consulte DescribeImages en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSImagePermission.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestran los permisos de imagen de una imagen de AppStream compartida
Get-APSImagePermission -Name Powershell | select SharedAccountId, @{n="AllowFleet";e={$_.ImagePermissions.AllowFleet}}, @{n="AllowImageBuilder";e={$_.ImagePermissions.AllowImageBuilder}}Salida:
SharedAccountId AllowFleet AllowImageBuilder --------------- ---------- ----------------- 123456789012 True True-
Para obtener información sobre la API, consulte DescribeImagePermissions en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSSessionList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestra una lista de sesiones en una flota
Get-APSSessionList -FleetName PowershellFleet -StackName PowershellStackSalida:
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 obtener información sobre la API, consulte DescribeSessions en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSStackList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestra una lista de pilas de AppStream
Get-APSStackList | Select DisplayName, Arn, CreatedTimeSalida:
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 obtener información sobre la API, consulte DescribeStacks en Herramientas de AWS para PowerShell Cmdlet Reference (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSTagsForResourceList.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestran las etiquetas de un recurso de AppStream
Get-APSTagsForResourceList -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTestSalida:
Key Value --- ----- StackState Test-
Para obtener información sobre la API, consulte ListTagsForResource en la Referencia de Cmdlet de las Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSUsageReportSubscription.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestran los detalles de la configuración de AppStreamUsageReport
Get-APSUsageReportSubscriptionSalida:
LastGeneratedReportDate S3BucketName Schedule SubscriptionErrors ----------------------- ------------ -------- ------------------ 1/1/0001 12:00:00 AM appstream-logs-us-east-1-123456789012-sik1hnxe DAILY {}-
Para obtener información sobre la API, consulte DescribeUsageReportSubscriptions en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSUser.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestra una lista de usuarios con el estado activado
Get-APSUser -AuthenticationType USERPOOL | Select-Object UserName, AuthenticationType, EnabledSalida:
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 obtener información sobre la API, consulte DescribeUsers en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Get-APSUserStackAssociation.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se muestra la lista de usuarios asignados a una pila.
Get-APSUserStackAssociation -StackName PowershellStackSalida:
AuthenticationType SendEmailNotification StackName UserName ------------------ --------------------- --------- -------- USERPOOL False PowershellStack TestUser1@lab.com USERPOOL False PowershellStack TestUser2@lab.com-
Para obtener información sobre la API, consulte DescribeUserStackAssociations en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSDirectoryConfig.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se crea una configuración de directorio en AppStream
New-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStream,OU=Contoso,DC=Contoso,DC=com"Salida:
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 obtener información sobre la API, consulte CreateDirectoryConfig en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSFleet.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se crea una nueva flota de 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-2Salida:
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 obtener información sobre la API, consulte CreateFleet en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSImageBuilder.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se crea un generador de imágenes en 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-2Salida:
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 obtener información sobre la API, consulte CreateImageBuilder en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSImageBuilderStreamingURL.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se crea una URL de streaming de ImageBuilder con una validez de 2 horas
New-APSImageBuilderStreamingURL -Name TestIB -Validity 7200 -Region us-west-2Salida:
Expires StreamingURL ------- ------------ 12/27/2019 1:49:13 PM https://appstream2.us-west-2.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiQURNSU4iLCJleHBpcmVzIjoiMTU3NzQ1NDU1MyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6ImFkbWluIiwiY2F-
Para obtener información sobre la API, consulte CreateImageBuilderStreamingURL en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSStack.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se crea una nueva pila de AppStream
New-APSStack -Name TestStack -DisplayName TestStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup TestStack -Region us-west-2Salida:
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 obtener información sobre la API, consulte CreateStack en Herramientas de AWS para PowerShell Cmdlet Reference (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSStreamingURL.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se crea una URL de streaming de una pila
New-APSStreamingURL -StackName SessionScriptTest -FleetName SessionScriptNew -UserId TestUserSalida:
Expires StreamingURL ------- ------------ 12/27/2019 12:43:37 PM https://appstream2.us-east-1.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiRU5EX1VTRVIiLCJleHBpcmVzIjoiMTU3NzQ1MDYxNyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6IlRlc3RVc2-
Para obtener información sobre la API, consulte CreateStreamingURL en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSUsageReportSubscription.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se habilitan los informes de uso de AppStream
New-APSUsageReportSubscriptionSalida:
S3BucketName Schedule ------------ -------- appstream-logs-us-east-1-123456789012-sik2hnxe DAILY-
Para obtener información sobre la API, consulte CreateUsageReportSubscription en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar New-APSUser.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se crea un usuario en USERPOOL
New-APSUser -UserName Test@lab.com -AuthenticationType USERPOOL -FirstName 'kt' -LastName 'aws' -Select ^UserNameSalida:
Test@lab.com-
Para obtener información sobre la API, consulte CreateUser en la Referencia de Cmdlet de las Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Register-APSFleet.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se registra la flota con una pila
Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2-
Para obtener información sobre la API, consulte AssociateFleet en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Register-APSUserStackBatch.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se asigna una pila a un usuario de USERPOOL
Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}-
Para obtener información sobre la API, consulte BatchAssociateUserStack en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSDirectoryConfig.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina una configuración de directorio en AppStream
Remove-APSDirectoryConfig -DirectoryName contoso.comSalida:
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 obtener información sobre la API, consulte DeleteDirectoryConfig en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSFleet.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina una flota de AppStream
Remove-APSFleet -Name TestFleet -Region us-west-2Salida:
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 obtener información sobre la API, consulte DeleteFleet en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSImage.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina una imagen
Remove-APSImage -Name TestImage -Region us-west-2Salida:
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 obtener información sobre la API, consulte DeleteImage en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSImageBuilder.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina un ImageBuilder
Remove-APSImageBuilder -Name TestIB -Region us-west-2Salida:
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 obtener información sobre la API, consulte DeleteImageBuilder en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSImagePermission.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se eliminan los permisos de una imagen
Remove-APSImagePermission -Name Powershell -SharedAccountId 123456789012Salida:
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 obtener información sobre la API, consulte DeleteImagePermissions en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSResourceTag.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina una etiqueta de recurso del recurso de AppStream
Remove-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -TagKey StackStateSalida:
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 obtener información sobre la API, consulte UntagResource en la Referencia de Cmdlet de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSStack.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina una pila
Remove-APSStack -Name TestStack -Region us-west-2Salida:
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 obtener información sobre la API, consulte DeleteStack en Herramientas de AWS para PowerShell Cmdlet Reference (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSUsageReportSubscription.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se deshabilita la suscripción del informe de uso de AppStream
Remove-APSUsageReportSubscriptionSalida:
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 obtener información sobre la API, consulte DeleteUsageReportSubscription en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Remove-APSUser.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina a un usuario de USERPOOL
Remove-APSUser -UserName TestUser@lab.com -AuthenticationType USERPOOLSalida:
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 obtener información sobre la API, consulte DeleteUser en la Referencia de Cmdlet de las Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Revoke-APSSession.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se revoca una sesión en la flota de AppStream
Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877-
Para obtener información sobre la API, consulte ExpireSession en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Start-APSFleet.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se inicia una flota
Start-APSFleet -Name PowershellFleet-
Para obtener información sobre la API, consulte StartFleet en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Start-APSImageBuilder.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se inicia un ImageBuilder
Start-APSImageBuilder -Name TestImageSalida:
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 obtener información sobre la API, consulte StartImageBuilder en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Stop-APSFleet.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se detiene una flota
Stop-APSFleet -Name PowershellFleet-
Para obtener información sobre la API, consulte StopFleet en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Stop-APSImageBuilder.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se detiene un ImageBuilder
Stop-APSImageBuilder -Name TestImageSalida:
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 obtener información sobre la API, consulte StopImageBuilder en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Unregister-APSFleet.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se cancela el registro de una flota de una pila
Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2-
Para obtener información sobre la API, consulte DisassociateFleet en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Unregister-APSUserStackBatch.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se elimina un usuario de una pila asignada
Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}-
Para obtener información sobre la API, consulte BatchDisassociateUserStack en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Update-APSDirectoryConfig.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se actualiza la configuración de directorio creada en AppStream
Update-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass@1$@# -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com"Salida:
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 obtener información sobre la API, consulte UpdateDirectoryConfig en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Update-APSFleet.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se actualizan las propiedades de una flota
Update-APSFleet -Name PowershellFleet -EnableDefaultInternetAccess $True -DisconnectTimeoutInSecond 950Salida:
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 obtener información sobre la API, consulte UpdateFleet en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Update-APSImagePermission.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se comparte una imagen de AppStream con otra cuenta
Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True-
Para obtener información sobre la API, consulte UpdateImagePermissions en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).
-
En el siguiente ejemplo de código, se muestra cómo utilizar Update-APSStack.
- Herramientas para PowerShell V4
-
Ejemplo 1: En este ejemplo se actualiza (se habilita) la persistencia de la configuración de la aplicación y las carpetas principales de una pila
Update-APSStack -Name PowershellStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup PowershellStack -StorageConnector @{ConnectorType="HOMEFOLDERS"}Salida:
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 obtener información sobre la API, consulte UpdateStack en Herramientas de AWS para PowerShell Cmdlet Reference (V4).
-