Exemplos do WorkSpaces que usam o Tools for PowerShell V4 - Ferramentas da AWS para PowerShell (versão 4)
Ações

A versão 5 (V5) do Ferramentas da AWS para PowerShell foi lançada!

Para começar a usar a nova versão do SDK, consulte o Guia do usuário do Ferramentas da AWS para PowerShell (V5), especialmente o tópico Migração para V5.

Exemplos do WorkSpaces que usam o Tools for PowerShell V4

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V4 com o WorkSpaces.

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.

Tópicos

Ações

O código de exemplo a seguir mostra como usar Approve-WKSIpRule.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo adiciona regras a um 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 obter detalhes da API, consulte AuthorizeIpRules em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Copy-WKSWorkspaceImage.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo copia a imagem do espaço de trabalho com o ID especificado de us-west-2 para a região atual com o nome “CopiedImageTest”

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

Saída:

wsi-456abaqfe

  • Para obter detalhes da API, consulte CopyWorkspaceImage em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Edit-WKSClientProperty.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo permite a reconexão para o cliente do Workspaces

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

  • Para obter detalhes da API, consulte ModifyClientProperties em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Edit-WKSSelfServicePermission.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo concede permissões de autoatendimento para alterar o tipo de computação e aumentar o tamanho do volume para o diretório especificado

Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED

O código de exemplo a seguir mostra como usar Edit-WKSWorkspaceAccessProperty.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo permite o acesso ao Workspace no Android e no Chrome OS para o diretório especificado

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

O código de exemplo a seguir mostra como usar Edit-WKSWorkspaceCreationProperty.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo permite que o Modo de Manutenção e Acesso à Internet seja verdadeiro como valores padrão ao criar um espaço de trabalho

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

O código de exemplo a seguir mostra como usar Edit-WKSWorkspaceProperty.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo altera a propriedade do modo de execução do espaço de trabalho para interrupção automática referente ao espaço de trabalho especificado

Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP

  • Para obter detalhes da API, consulte ModifyWorkspaceProperties em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Edit-WKSWorkspaceState.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo altera o estado do espaço de trabalho especificado para Disponível

Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE

  • Para obter detalhes da API, consulte ModifyWorkspaceState em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSClientProperty.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo obtém as propriedades do cliente do Workspace Client para o diretório especificado

Get-WKSClientProperty -ResourceId d-223562a123

  • Para obter detalhes da API, consulte DescribeClientProperties em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSIpGroup.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo obtém os detalhes do grupo de IP especificado na região especificada

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

Saída:

GroupDesc GroupId         GroupName UserRules
--------- -------         --------- ---------
          wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}

  • Para obter detalhes da API, consulte DescribeIpGroups em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSTag.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo busca a tag para o espaço de trabalho fornecido

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

Saída:

Key         Value
---         -----
auto-delete no
purpose     Workbench

  • Para obter detalhes da API, consulte DescribeTags em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSWorkspace.

Ferramentas para PowerShell V4

Exemplo 1: recupera detalhes de todos os seus WorkSpaces para o pipeline.

Get-WKSWorkspace

Saída:

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

Exemplo 2: este comando mostra os valores das propriedades secundárias de WorkSpaceProperties para um espaço de trabalho na região us-west-2. Para obter mais informações sobre as propriedades filho de WorkSpaceProperties, consulte https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Saída:

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

Exemplo 3: este comando mostra o valor da propriedade secundária RootVolumeSizeGib de WorkSpaceProperties para um espaço de trabalho na região us-west-2. O tamanho do volume raiz, em GiB, é 80.

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

Saída:

        80

  • Para obter detalhes da API, consulte DescribeWorkspaces em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSWorkspaceBundle.

Ferramentas para PowerShell V4

Exemplo 1: esta amostra busca detalhes de todos os pacotes do Workspace na região atual

Get-WKSWorkspaceBundle

Saída:

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 obter detalhes da API, consulte DescribeWorkspaceBundles em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSWorkspaceDirectory.

Ferramentas para PowerShell V4

Exemplo 1: esta amostra lista os detalhes do diretório para diretórios registrados

Get-WKSWorkspaceDirectory

Saída:

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

O código de exemplo a seguir mostra como usar Get-WKSWorkspaceImage.

Ferramentas para PowerShell V4

Exemplo 1: esta amostra busca todos os detalhes de todas as imagens na região

Get-WKSWorkspaceImage

Saída:

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 obter detalhes da API, consulte DescribeWorkspaceImages em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSWorkspaceSnapshot.

Ferramentas para PowerShell V4

Exemplo 1: esta amostra mostra o carimbo de data/hora do snapshot mais recente criado para o espaço de trabalho especificado

Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v

Saída:

RebuildSnapshots                   RestoreSnapshots
----------------                   ----------------
{Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}

  • Para obter detalhes da API, consulte DescribeWorkspaceSnapshots em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Get-WKSWorkspacesConnectionStatus.

Ferramentas para PowerShell V4

Exemplo 1: esta amostra busca o status da conexão para o espaço de trabalho especificado

Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r

O código de exemplo a seguir mostra como usar New-WKSIpGroup.

Ferramentas para PowerShell V4

Exemplo 1: esta amostra cria um grupo de IP vazio chamado FreshEmptyIpGroup

New-WKSIpGroup -GroupName "FreshNewIPGroup"

Saída:

wsipg-w45rty4ty

  • Para obter detalhes da API, consulte CreateIpGroup em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar New-WKSTag.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo adiciona uma nova tag a um espaço de trabalho chamado ws-wsname. A tag tem uma chave de “Name” e um valor-chave de 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

Exemplo 2: este exemplo adiciona várias tags a um espaço de trabalho chamado ws-wsname. Uma tag tem uma chave de “Name” e um valor-chave de AWS_Workspace; a outra tag tem uma chave de tag de “Stage” e um valor-chave de “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 obter detalhes da API, consulte CreateTags em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar New-WKSWorkspace.

Ferramentas para PowerShell V4

Exemplo 1: crie um WorkSpace para o pacote, o diretório e o usuário fornecidos.

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

Exemplo 2: este exemplo cria vários WorkSpaces

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

  • Para obter detalhes da API, consulte CreateWorkspaces em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Register-WKSIpGroup.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo registra o grupo de IP especificado com o diretório especificado

Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123

  • Para obter detalhes da API, consulte AssociateIpGroups em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Register-WKSWorkspaceDirectory.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo registra o diretório especificado para o Workspaces Service

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

  • Para obter detalhes da API, consulte RegisterWorkspaceDirectory em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Remove-WKSIpGroup.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo exclui o grupo de IPs especificado

Remove-WKSIpGroup -GroupId wsipg-32fhgtred

Saída:

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 obter detalhes da API, consulte DeleteIpGroup em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Remove-WKSTag.

Ferramentas para PowerShell V4

Exemplo 1: este exemplo remove a tag associada ao espaço de trabalho

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

Saída:

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 obter detalhes da API, consulte DeleteTags em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Remove-WKSWorkspace.

Ferramentas para PowerShell V4

Exemplo 1: encerra vários WorkSpaces. O uso da opção -Force impede que o cmdlet solicite confirmação.

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

Exemplo 2: recupera a coleção de todos os WorkSpaces e canaliza os IDs para o parâmetro -WorkSpaceId de Remove-WKSWorkspace, encerrando todos os WorkSpaces. O cmdlet enviará um prompt antes que cada WorkSpace seja encerrado. Para ignorar o prompt de confirmação, adicione a opção -Force.

Get-WKSWorkspaces | Remove-WKSWorkspace

Exemplo 3: este exemplo mostra como passar objetos TerminateRequest definindo os WorkSpaces a serem encerrados. O cmdlet enviará um prompt de confirmação antes de continuar, a menos que o parâmetro da opção -Force também seja especificado.

$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 obter detalhes da API, consulte TerminateWorkspaces em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Reset-WKSWorkspace.

Ferramentas para PowerShell V4

Exemplo 1: recria o WorkSpace especificado.

Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Exemplo 2: recupera a coleção de todos os seus WorkSpaces e canaliza os IDs para o parâmetro -WorkSpaceId de Reset-WKSWorkspace, fazendo com que os WorkSpaces sejam reconstruídos.

Get-WKSWorkspaces | Reset-WKSWorkspace

  • Para obter detalhes da API, consulte RebuildWorkspaces em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Restart-WKSWorkspace.

Ferramentas para PowerShell V4

Exemplo 1: reinicia o WorkSpace especificado.

Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Exemplo 2: reinicializa vários WorkSpaces.

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

Exemplo 3: recupera a coleção de todos os WorkSpaces e canaliza os IDs para o parâmetro -WorkSpaceId de Restart-WKSWorkspace, fazendo com que os WorkSpaces sejam reiniciados.

Get-WKSWorkspaces | Restart-WKSWorkspace

  • Para obter detalhes da API, consulte RebootWorkspaces em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Stop-WKSWorkspace.

Ferramentas para PowerShell V4

Exemplo 1: interrompe vários WorkSpaces.

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

Exemplo 2: recupera a coleção de todos os seus WorkSpaces e canaliza os IDs para o parâmetro -WorkSpaceId de stop-WKSWorkspace, fazendo com que os WorkSpaces sejam interrompidos.

Get-WKSWorkspaces | Stop-WKSWorkspace

Exemplo 3: este exemplo mostra como passar objetos StopRequest definindo os WorkSpaces a serem interrompidos.

$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 obter detalhes da API, consulte StopWorkspaces em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

O código de exemplo a seguir mostra como usar Unregister-WKSIpGroup.

Ferramentas para PowerShell V4

Exemplo 1: esta amostra cancela o registro do grupo de IP especificado do diretório especificado

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

  • Para obter detalhes da API, consulte DisassociateIpGroups em Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).