WorkSpaces ejemplos de uso de herramientas para PowerShell - AWS SDKEjemplos de código

Hay más AWS SDK ejemplos disponibles en el GitHub repositorio de AWS Doc SDK Examples.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

WorkSpaces ejemplos de uso de herramientas para PowerShell

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Tools for PowerShell with 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 funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

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

Herramientas para PowerShell

Ejemplo 1: Este ejemplo agrega 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

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

Herramientas para PowerShell

Ejemplo 1: en este ejemplo se copia la imagen del espacio de trabajo con el identificador 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

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

Herramientas para PowerShell

Ejemplo 1: Este ejemplo permite la reconexión del cliente de Workspaces

Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369

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

Herramientas para PowerShell

Ejemplo 1: Este ejemplo habilita los permisos de autoservicio para cambiar el tipo de procesamiento 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

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

Herramientas para PowerShell

Ejemplo 1: Este ejemplo permite el acceso a Workspace en Android y Chrome OS para el directorio especificado

Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW

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

Herramientas para PowerShell

Ejemplo 1: En este ejemplo se activa el acceso a Internet y el modo de mantenimiento como valores predeterminados al crear un espacio de trabajo

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 usar Edit-WKSWorkspaceProperty.

Herramientas para PowerShell

Ejemplo 1: Este ejemplo 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

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

Herramientas para PowerShell

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

En el siguiente ejemplo de código se muestra cómo usar Get-WKSClientProperty.

Herramientas para PowerShell

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

Get-WKSClientProperty -ResourceId d-223562a123
  • Para API obtener más información, consulte DescribeClientPropertiesla referencia de AWS Tools for PowerShell cmdlets.

En el siguiente ejemplo de código se muestra cómo usar Get-WKSIpGroup.

Herramientas para PowerShell

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}

En el siguiente ejemplo de código se muestra cómo usar Get-WKSTag.

Herramientas para PowerShell

Ejemplo 1: Este ejemplo busca la etiqueta del espacio de trabajo dado

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

Salida:

Key Value --- ----- auto-delete no purpose Workbench
  • Para API obtener más información, consulte la referencia DescribeTagsdel AWS Tools for PowerShell cmdlet.

En el siguiente ejemplo de código se muestra cómo usar Get-WKSWorkspace.

Herramientas para PowerShell

Ejemplo 1: Recupera los detalles de todos los que llevas WorkSpaces a 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 un espacio WorkSpaceProperties de trabajo de la us-west-2 región. Para obtener más información sobre las propiedades secundarias deWorkSpaceProperties, 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 un espacio WorkSpaceProperties de trabajo de la us-west-2 región. El tamaño del volumen de la raíz, en GiB, es 80.

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

Salida:

80
  • Para API obtener más información, consulte la referencia DescribeWorkspacesde AWS Tools for PowerShell cmdlets.

En el siguiente ejemplo de código se muestra cómo usar Get-WKSWorkspaceBundle.

Herramientas para PowerShell

Ejemplo 1: En este ejemplo se obtienen detalles de todos los paquetes de Workspace 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

En el siguiente ejemplo de código se muestra cómo usar Get-WKSWorkspaceDirectory.

Herramientas para PowerShell

Ejemplo 1: En este ejemplo se enumeran los detalles del 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

En el siguiente ejemplo de código se muestra cómo usar Get-WKSWorkspaceImage.

Herramientas para PowerShell

Ejemplo 1: En este ejemplo se muestran todos 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

En el siguiente ejemplo de código se muestra cómo usar Get-WKSWorkspaceSnapshot.

Herramientas para PowerShell

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}

En el siguiente ejemplo de código se muestra cómo usar Get-WKSWorkspacesConnectionStatus.

Herramientas para PowerShell

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 usar New-WKSIpGroup.

Herramientas para PowerShell

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

New-WKSIpGroup -GroupName "FreshNewIPGroup"

Salida:

wsipg-w45rty4ty

En el siguiente ejemplo de código se muestra cómo usar New-WKSTag.

Herramientas para PowerShell

Ejemplo 1: en este ejemplo se añade una etiqueta nueva a un espacio de trabajo denominadows-wsname. La etiqueta tiene la clave «Nombre» y el valor clave deAWS_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 denominadows-wsname. Una etiqueta tiene una clave de «Nombre» y un valor clave deAWS_Workspace; la otra etiqueta tiene una clave de etiqueta de «Etapa» y un valor clave de «Prueba».

$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

En el siguiente ejemplo de código se muestra cómo usar New-WKSWorkspace.

Herramientas para PowerShell

Ejemplo 1: cree un WorkSpace para el paquete, el directorio y el usuario proporcionados.

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

Ejemplo 2: En este ejemplo se crean varios WorkSpaces

New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
  • Para API obtener más información, consulte CreateWorkspacesla referencia del AWS Tools for PowerShell cmdlet.

En el siguiente ejemplo de código se muestra cómo usar Register-WKSIpGroup.

Herramientas para PowerShell

Ejemplo 1: Este ejemplo registra el grupo de IP especificado en el directorio especificado

Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123
  • Para API obtener más información, consulte AssociateIpGroupsla referencia del AWS Tools for PowerShell cmdlet.

En el siguiente ejemplo de código se muestra cómo usar Register-WKSWorkspaceDirectory.

Herramientas para PowerShell

Ejemplo 1: En este ejemplo se registra el directorio especificado para el servicio Workspaces

Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false

En el siguiente ejemplo de código se muestra cómo usar Remove-WKSIpGroup.

Herramientas para PowerShell

Ejemplo 1: En este ejemplo se elimina el grupo de 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

En el siguiente ejemplo de código se muestra cómo usar Remove-WKSTag.

Herramientas para PowerShell

Ejemplo 1: En este ejemplo se elimina la etiqueta asociada al espacio de trabajo

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

En el siguiente ejemplo de código se muestra cómo usar Remove-WKSWorkspace.

Herramientas para PowerShell

Ejemplo 1: Termina varios WorkSpaces. El uso del modificador -Force impide que el cmdlet solicite confirmación.

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

Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Remove-WKSWorkspace, finalizando todos los. WorkSpaces El cmdlet avisará antes de que finalice cada uno de ellos. WorkSpace Para suprimir la solicitud de confirmación, agregue el modificador -Force.

Get-WKSWorkspaces | Remove-WKSWorkspace

Ejemplo 3: En este ejemplo se muestra cómo pasar TerminateRequest objetos que definen lo WorkSpaces que se va a terminar. El cmdlet solicitará confirmación antes de continuar, a menos que también se especifique el parámetro -Force switch.

$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 API obtener más información, consulte la referencia del TerminateWorkspacescmdlet AWS Tools for PowerShell .

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

Herramientas para PowerShell

Ejemplo 1: Reconstruye lo especificado WorkSpace.

Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los IDs canaliza al WorkSpaceId parámetro de restablecimientoWKSWorkspace, lo que provoca su WorkSpaces reconstrucción.

Get-WKSWorkspaces | Reset-WKSWorkspace

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

Herramientas para PowerShell

Ejemplo 1: Reinicia el especificado WorkSpace.

Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Ejemplo 2: Reinicia varios. WorkSpaces

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

Ejemplo 3: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Restart-WKSWorkspace, lo que provoca que se WorkSpaces reinicie.

Get-WKSWorkspaces | Restart-WKSWorkspace
  • Para API obtener más información, consulte Cmdlet RebootWorkspacesReference AWS Tools for PowerShell .

En el siguiente ejemplo de código se muestra cómo usar Stop-WKSWorkspace.

Herramientas para PowerShell

Ejemplo 1: Detiene varios WorkSpaces.

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

Ejemplo 2: recupera la colección de todos sus datos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro Stop, WKSWorkspace lo que provoca WorkSpaces que se detenga.

Get-WKSWorkspaces | Stop-WKSWorkspace

Ejemplo 3: En este ejemplo se muestra cómo pasar StopRequest los objetos que definen lo WorkSpaces que se debe 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

En el siguiente ejemplo de código se muestra cómo usar Unregister-WKSIpGroup.

Herramientas para PowerShell

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

Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123