Ejemplos de WorkSpaces con las Herramientas para PowerShell V4 - Herramientas de AWS para PowerShell (versión 4)

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 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.

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.

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar Approve-WKSIpRule.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se añaden reglas a un grupo de IP existente

$Rule = @( @{IPRule = "10.1.0.0/0"; RuleDesc = "First Rule Added"}, @{IPRule = "10.2.0.0/0"; RuleDesc = "Second Rule Added"} ) Approve-WKSIpRule -GroupId wsipg-abcnx2fcw -UserRule $Rule
  • Para obtener información sobre la API, consulte AuthorizeIpRules en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Copy-WKSWorkspaceImage.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se copia la imagen del espacio de trabajo con el ID especificado de us-west-2 a la región actual con el nombre “CopiedImageTest”.

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

Salida:

wsi-456abaqfe
  • Para obtener información sobre la API, consulte CopyWorkspaceImage en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Edit-WKSClientProperty.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se permite la reconexión del cliente de Workspaces.

Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369
  • Para obtener información sobre la API, consulte ModifyClientProperties en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Edit-WKSSelfServicePermission.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se habilitan los permisos de autoservicio para cambiar el tipo de computación y aumentar el tamaño del volumen del directorio especificado.

Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED
  • Para obtener información sobre la API, consulte ModifySelfservicePermissions en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Edit-WKSWorkspaceAccessProperty.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se permite el acceso al espacio de trabajo en Android y Chrome OS para el directorio especificado.

Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW
  • Para obtener información sobre la API, consulte ModifyWorkspaceAccessProperties en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Edit-WKSWorkspaceCreationProperty.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se establece el acceso a Internet y el modo de mantenimiento en “true” como valores predeterminados al crear una instancia de Workspaces.

Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true

En el siguiente ejemplo de código, se muestra cómo utilizar Edit-WKSWorkspaceProperty.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se cambia la propiedad del modo de ejecución del espacio de trabajo a Parada automática para el espacio de trabajo especificado.

Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
  • Para obtener información sobre la API, consulte ModifyWorkspaceProperties en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Edit-WKSWorkspaceState.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se cambia el estado del espacio de trabajo especificado a Disponible.

Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
  • Para obtener información sobre la API, consulte ModifyWorkspaceState 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-WKSClientProperty.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se obtienen las propiedades de cliente del cliente de WorkSpaces para el directorio especificado.

Get-WKSClientProperty -ResourceId d-223562a123
  • Para obtener información sobre la API, consulte DescribeClientProperties 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-WKSIpGroup.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se obtienen los detalles del grupo de IP especificado en la región especificada.

Get-WKSIpGroup -Region us-east-1 -GroupId wsipg-8m1234v45

Salida:

GroupDesc GroupId GroupName UserRules --------- ------- --------- --------- wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}
  • Para obtener información sobre la API, consulte DescribeIpGroups 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-WKSTag.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se busca la etiqueta del espacio de trabajo especificado.

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

Salida:

Key Value --- ----- auto-delete no purpose Workbench
  • Para obtener información sobre la API, consulte DescribeTags 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-WKSWorkspace.

Herramientas para PowerShell V4

Ejemplo 1: Se recuperan los detalles de todas sus instancias de WorkSpaces en la canalización.

Get-WKSWorkspace

Salida:

BundleId : wsb-1a2b3c4d ComputerName : DirectoryId : d-1a2b3c4d ErrorCode : ErrorMessage : IpAddress : RootVolumeEncryptionEnabled : False State : PENDING SubnetId : UserName : myuser UserVolumeEncryptionEnabled : False VolumeEncryptionKey : WorkspaceId : ws-1a2b3c4d WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties

Ejemplo 2: Este comando muestra los valores de las propiedades secundarias de WorkSpaceProperties para un espacio de trabajo de la región us-west-2. Para obtener más información sobre las propiedades secundarias de WorkSpaceProperties, consulte https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Salida:

ComputeTypeName : STANDARD RootVolumeSizeGib : 80 RunningMode : AUTO_STOP RunningModeAutoStopTimeoutInMinutes : 60 UserVolumeSizeGib : 50

Ejemplo 3: Este comando muestra el valor de la propiedad secundaria RootVolumeSizeGib de WorkSpaceProperties para un espacio de trabajo en la región us-west-2. El tamaño del volumen de la raíz es de 80 GiB.

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

Salida:

80
  • Para obtener información sobre la API, consulte DescribeWorkspaces 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-WKSWorkspaceBundle.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se obtienen los detalles de todas las agrupaciones de espacios de trabajo de la región actual.

Get-WKSWorkspaceBundle

Salida:

BundleId : wsb-sfhdgv342 ComputeType : Amazon.WorkSpaces.Model.ComputeType Description : This bundle is custom ImageId : wsi-235aeqges LastUpdatedTime : 12/26/2019 06:44:07 Name : CustomBundleTest Owner : 233816212345 RootStorage : Amazon.WorkSpaces.Model.RootStorage UserStorage : Amazon.WorkSpaces.Model.UserStorage
  • Para obtener información sobre la API, consulte DescribeWorkspaceBundles 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-WKSWorkspaceDirectory.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se muestran los detalles de directorio de los directorios registrados.

Get-WKSWorkspaceDirectory

Salida:

Alias : TestWorkspace CustomerUserName : Administrator DirectoryId : d-123414a369 DirectoryName : TestDirectory.com DirectoryType : MicrosoftAD DnsIpAddresses : {172.31.43.45, 172.31.2.97} IamRoleId : arn:aws:iam::761234567801:role/workspaces_RoleDefault IpGroupIds : {} RegistrationCode : WSpdx+4RRT43 SelfservicePermissions : Amazon.WorkSpaces.Model.SelfservicePermissions State : REGISTERED SubnetIds : {subnet-1m3m7b43, subnet-ard11aba} Tenancy : SHARED WorkspaceAccessProperties : Amazon.WorkSpaces.Model.WorkspaceAccessProperties WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties WorkspaceSecurityGroupId : sg-0ed2441234a123c43
  • Para obtener información sobre la API, consulte DescribeWorkspaceDirectories 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-WKSWorkspaceImage.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se obtienen los detalles de todas las imágenes de la región.

Get-WKSWorkspaceImage

Salida:

Description :This image is copied from another image ErrorCode : ErrorMessage : ImageId : wsi-345ahdjgo Name : CopiedImageTest OperatingSystem : Amazon.WorkSpaces.Model.OperatingSystem RequiredTenancy : DEFAULT State : AVAILABLE
  • Para obtener información sobre la API, consulte DescribeWorkspaceImages 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-WKSWorkspaceSnapshot.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se muestra la marca de tiempo de la instantánea más reciente creada para el espacio de trabajo especificado.

Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v

Salida:

RebuildSnapshots RestoreSnapshots ---------------- ---------------- {Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}
  • Para obtener información sobre la API, consulte DescribeWorkspaceSnapshots 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-WKSWorkspacesConnectionStatus.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se obtiene el estado de la conexión del espacio de trabajo especificado.

Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r

En el siguiente ejemplo de código, se muestra cómo utilizar New-WKSIpGroup.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se crea un grupo de direcciones IP vacío denominado FreshEmptyIpGroup.

New-WKSIpGroup -GroupName "FreshNewIPGroup"

Salida:

wsipg-w45rty4ty
  • Para obtener información sobre la API, consulte CreateIpGroup 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-WKSTag.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se añade una etiqueta nueva a un espacio de trabajo denominado ws-wsname. La etiqueta tiene la clave “Name” y el valor de clave AWS_Workspace.

$tag = New-Object Amazon.WorkSpaces.Model.Tag $tag.Key = "Name" $tag.Value = "AWS_Workspace" New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag

Ejemplo 2: En este ejemplo se añaden varias etiquetas a un espacio de trabajo denominado ws-wsname. Una etiqueta tiene la clave “Name” y el valor de clave AWS_Workspace; la otra etiqueta tiene la clave de etiqueta “Stage” y el valor de clave “Test”.

$tag = New-Object Amazon.WorkSpaces.Model.Tag $tag.Key = "Name" $tag.Value = "AWS_Workspace" $tag2 = New-Object Amazon.WorkSpaces.Model.Tag $tag2.Key = "Stage" $tag2.Value = "Test" New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2
  • Para obtener información sobre la API, consulte CreateTags 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-WKSWorkspace.

Herramientas para PowerShell V4

Ejemplo 1: Se crea una instancia de WorkSpaces para la agrupación, el directorio y el usuario especificados.

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

Ejemplo 2: En este ejemplo se crean varias instancias de WorkSpaces.

New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
  • Para obtener información sobre la API, consulte CreateWorkspaces 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-WKSIpGroup.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se registra el grupo de direcciones IP especificado en el directorio especificado.

Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123
  • Para obtener información sobre la API, consulte AssociateIpGroups 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-WKSWorkspaceDirectory.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se registra el directorio especificado para el servicio de WorkSpaces.

Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
  • Para obtener información sobre la API, consulte RegisterWorkspaceDirectory 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-WKSIpGroup.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se elimina el grupo de direcciones IP especificado.

Remove-WKSIpGroup -GroupId wsipg-32fhgtred

Salida:

Confirm Are you sure you want to perform this action? Performing the operation "Remove-WKSIpGroup (DeleteIpGroup)" on target "wsipg-32fhgtred". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
  • Para obtener información sobre la API, consulte DeleteIpGroup 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-WKSTag.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se elimina la etiqueta asociada a la instancia de WorkSpaces.

Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"

Salida:

Confirm Are you sure you want to perform this action? Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
  • Para obtener información sobre la API, consulte DeleteTags 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-WKSWorkspace.

Herramientas para PowerShell V4

Ejemplo 1: Se terminan varias instancias de WorkSpaces. El uso del modificador -Force impide que el cmdlet solicite confirmación.

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

Ejemplo 2: Se recupera la colección de todas sus instancias de WorkSpaces y envía los ID al parámetro -WorkSpaceId de Remove-WKSWorkspace, lo que provoca que se terminen todas las instancias de WorkSpaces. El cmdlet solicitará confirmación antes de terminar cada instancia de WorkSpaces. Añada el modificador -Force para suprimir la solicitud de confirmación.

Get-WKSWorkspaces | Remove-WKSWorkspace

Ejemplo 3: En este ejemplo se muestra cómo pasar los objetos TerminateRequest que definen las instancias de WorkSpaces que se deben terminar. El cmdlet solicitará confirmación antes de continuar, a menos que se especifique el modificador -Force.

$arrRequest = @() $request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest $request1.WorkspaceId = 'ws-12345678' $arrRequest += $request1 $request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest $request2.WorkspaceId = 'ws-abcdefgh' $arrRequest += $request2 Remove-WKSWorkspace -Request $arrRequest
  • Para obtener información sobre la API, consulte TerminateWorkspaces en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Reset-WKSWorkspace.

Herramientas para PowerShell V4

Ejemplo 1: Se recompila el espacio de trabajo especificado.

Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Ejemplo 2: Se recupera la colección de todas sus instancias de WorkSpaces y envía los ID al parámetro -WorkSpaceId de Reset-WKSWorkspace, lo que provoca que se recompilen las instancias de WorkSpaces.

Get-WKSWorkspaces | Reset-WKSWorkspace
  • Para obtener información sobre la API, consulte RebuildWorkspaces en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

En el siguiente ejemplo de código, se muestra cómo utilizar Restart-WKSWorkspace.

Herramientas para PowerShell V4

Ejemplo 1: Se reinicia el espacio de trabajo especificado.

Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Ejemplo 2: Se reinician varias instancias de Workspaces.

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

Ejemplo 3: Se recupera la colección de todas sus instancias de WorkSpaces y envía los ID al parámetro -WorkSpaceId de Restart-WKSWorkspace, lo que provoca que se reinicien las instancias de WorkSpaces.

Get-WKSWorkspaces | Restart-WKSWorkspace
  • Para obtener información sobre la API, consulte RebootWorkspaces 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-WKSWorkspace.

Herramientas para PowerShell V4

Ejemplo 1: Se detienen varias instancias de Workspaces.

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

Ejemplo 2: Se recupera la colección de todas sus instancias de WorkSpaces y envía los ID al parámetro -WorkSpaceId de Stop-WKSWorkspace, lo que provoca que se detengan las instancias de WorkSpaces.

Get-WKSWorkspaces | Stop-WKSWorkspace

Ejemplo 3: En este ejemplo se muestra cómo pasar los objetos StopRequest que definen las instancias de WorkSpaces que se van a detener.

$arrRequest = @() $request1 = New-Object Amazon.WorkSpaces.Model.StopRequest $request1.WorkspaceId = 'ws-12345678' $arrRequest += $request1 $request2 = New-Object Amazon.WorkSpaces.Model.StopRequest $request2.WorkspaceId = 'ws-abcdefgh' $arrRequest += $request2 Stop-WKSWorkspace -Request $arrRequest
  • Para obtener información sobre la API, consulte StopWorkspaces 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-WKSIpGroup.

Herramientas para PowerShell V4

Ejemplo 1: En este ejemplo se anula el registro del grupo de direcciones IP especificado en el directorio especificado.

Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123
  • Para obtener información sobre la API, consulte DisassociateIpGroups en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).