Esempi per WorkSpaces con Strumenti per PowerShell V5

Gli esempi di codice seguenti mostrano come eseguire operazioni e implementare scenari comuni utilizzando AWS Strumenti per PowerShell V5 con WorkSpaces.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Azioni

L’esempio di codice seguente mostra come utilizzare Approve-WKSIpRule.

Strumenti per PowerShell V5

Esempio 1: questo esempio aggiunge regole a un gruppo di IP esistente


$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

Per informazioni dettagliate sull’API, consulta AuthorizeIpRules nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Copy-WKSWorkspaceImage.

Strumenti per PowerShell V5

Esempio 1: questo esempio copia l’immagine dello spazio di lavoro con l’ID specificato da us-west-2 alla Regione corrente denominata “CopiedImageTest”


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

Output:


wsi-456abaqfe

Per informazioni dettagliate sull’API, consulta CopyWorkspaceImage nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Edit-WKSClientProperty.

Strumenti per PowerShell V5

Esempio 1: questo esempio abilita la riconnessione per il client Workspaces


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

Per informazioni dettagliate sull’API, consulta ModifyClientProperties nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Edit-WKSSelfServicePermission.

Strumenti per PowerShell V5

Esempio 1: questo esempio abilita le autorizzazioni self-service per modificare il tipo di calcolo e aumentare le dimensioni del volume per la directory specificata


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

Per informazioni dettagliate sull’API, consulta ModifySelfservicePermissions nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Edit-WKSWorkspaceAccessProperty.

Strumenti per PowerShell V5

Esempio 1: questo esempio abilita l’accesso allo spazio di lavoro su Android e Chrome OS per la directory specificata


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

Per informazioni dettagliate sull’API, consulta ModifyWorkspaceAccessProperties nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Edit-WKSWorkspaceCreationProperty.

Strumenti per PowerShell V5

Esempio 1: questo esempio abilita le opzioni Accesso a Internet e Modalità di manutenzione su true come valori predefiniti durante la creazione di uno spazio di lavoro


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

Per informazioni dettagliate sull’API, consulta ModifyWorkspaceCreationProperties nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Edit-WKSWorkspaceProperty.

Strumenti per PowerShell V5

Esempio 1: questo esempio imposta la proprietà della modalità di esecuzione dello spazio di lavoro sull’arresto automatico dello spazio di lavoro specificato


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

Per informazioni dettagliate sull’API, consulta ModifyWorkspaceProperties nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Edit-WKSWorkspaceState.

Strumenti per PowerShell V5

Esempio 1: questo esempio modifica lo stato dello spazio di lavoro specificato in Available


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

Per informazioni dettagliate sull’API, consulta ModifyWorkspaceState nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSClientProperty.

Strumenti per PowerShell V5

Esempio 1: questo esempio ottiene le proprietà del client Workspace per la directory specificata


Get-WKSClientProperty -ResourceId d-223562a123

Per informazioni dettagliate sull’API, consulta DescribeClientProperties nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSIpGroup.

Strumenti per PowerShell V5

Esempio 1: questo esempio ottiene i dettagli del gruppo di IP specificato nella Regione specificata


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

Output:


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

Per informazioni dettagliate sull’API, consulta DescribeIpGroups nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSTag.

Strumenti per PowerShell V5

Esempio 1: questo esempio recupera il tag per lo spazio di lavoro specificato


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

Output:


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

Per informazioni dettagliate sull’API, consulta DescribeTags nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSWorkspace.

Strumenti per PowerShell V5

Esempio 1: recupera i dettagli di tutti gli spazi di lavoro nella pipeline.


Get-WKSWorkspace

Output:


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

Esempio 2: questo comando mostra i valori delle proprietà secondarie di WorkSpaceProperties per uno spazio di lavoro nella Regione us-west-2. Per ulteriori informazioni sulle proprietà secondarie di WorkSpaceProperties, consulta https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.


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

Output:


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

Esempio 3: questo comando mostra i valori delle proprietà secondarie RootVolumeSizeGib di WorkSpaceProperties per uno spazio di lavoro nella Regione us-west-2. La dimensione del volume root, in GiB, è 80.


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

Output:

Per informazioni dettagliate sull’API, consulta DescribeWorkspaces nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSWorkspaceBundle.

Strumenti per PowerShell V5

Esempio 1: questo esempio recupera i dettagli di tutti i bundle dello spazio di lavoro nella Regione corrente


Get-WKSWorkspaceBundle

Output:


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

Per informazioni dettagliate sull’API, consulta DescribeWorkspaceBundles nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSWorkspaceDirectory.

Strumenti per PowerShell V5

Esempio 1: questo esempio elenca i dettagli delle directory registrate


Get-WKSWorkspaceDirectory

Output:


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

Per informazioni dettagliate sull’API, consulta DescribeWorkspaceDirectories nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSWorkspaceImage.

Strumenti per PowerShell V5

Esempio 1: questo esempio recupera tutti i dettagli di tutte le immagini nella Regione


Get-WKSWorkspaceImage

Output:


Description     :This image is copied from another image
ErrorCode       :
ErrorMessage    :
ImageId         : wsi-345ahdjgo
Name            : CopiedImageTest
OperatingSystem : Amazon.WorkSpaces.Model.OperatingSystem
RequiredTenancy : DEFAULT
State           : AVAILABLE

Per informazioni dettagliate sull’API, consulta DescribeWorkspaceImages nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSWorkspaceSnapshot.

Strumenti per PowerShell V5

Esempio 1: questo esempio mostra il timestamp dello snapshot più recente creato per lo spazio di lavoro specificato


Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v

Output:


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

Per informazioni dettagliate sull’API, consulta DescribeWorkspaceSnapshots nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Get-WKSWorkspacesConnectionStatus.

Strumenti per PowerShell V5

Esempio 1: questo esempio recupera lo stato della connessione per lo spazio di lavoro specificato


Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r

Per informazioni dettagliate sull’API, consulta DescribeWorkspacesConnectionStatus nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare New-WKSIpGroup.

Strumenti per PowerShell V5

Esempio 1: questo esempio crea un gruppo di IP vuoto denominato FreshEmptyIpGroup


New-WKSIpGroup -GroupName "FreshNewIPGroup"

Output:


wsipg-w45rty4ty

Per informazioni dettagliate sull’API, consulta CreateIpGroup nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare New-WKSTag.

Strumenti per PowerShell V5

Esempio 1: questo esempio aggiunge un nuovo tag a uno spazio di lavoro denominato ws-wsname. Il tag include la chiave “Name” e il valore chiave 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

Esempio 2: questo esempio aggiunge più tag a uno spazio di lavoro denominato ws-wsname. Un tag include la chiave “Name” e il valore di chiave AWS_Workspace, mentre l’altro tag include una chiave “Stage” e il valore di chiave “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

Per informazioni dettagliate sull’API, consulta CreateTags nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare New-WKSWorkspace.

Strumenti per PowerShell V5

Esempio 1: come creare uno spazio di lavoro per il bundle, la directory e l’utente specificati.


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

Esempio 2: questo esempio crea più spazi di lavoro


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

Per informazioni dettagliate sull’API, consulta CreateWorkspaces nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Register-WKSIpGroup.

Strumenti per PowerShell V5

Esempio 1: questo esempio registra il gruppo di IP specificato con la directory specificata


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

Per informazioni dettagliate sull’API, consulta AssociateIpGroups nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Register-WKSWorkspaceDirectory.

Strumenti per PowerShell V5

Esempio 1: questo esempio registra la directory specificata per il servizio Workspaces


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

Per informazioni dettagliate sull’API, consulta RegisterWorkspaceDirectory nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Remove-WKSIpGroup.

Strumenti per PowerShell V5

Esempio 1: questo esempio elimina il gruppo di IP specificato


Remove-WKSIpGroup -GroupId wsipg-32fhgtred

Output:


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

Per informazioni dettagliate sull’API, consulta DeleteIpGroup nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Remove-WKSTag.

Strumenti per PowerShell V5

Esempio 1: questo esempio rimuove il tag associato allo spazio di lavoro


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

Output:


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

Per informazioni dettagliate sull’API, consulta DeleteTags nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Remove-WKSWorkspace.

Strumenti per PowerShell V5

Esempio 1: termina più spazi di lavoro. L’uso del parametro -Force impedisce al cmdlet di richiedere la conferma.


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

Esempio 2: recupera la raccolta di tutti gli spazi di lavoro e reindirizza gli ID al parametro -WorkSpaceId di Remove-WKSWorkspace causando la terminazione degli spazi di lavoro. Il cmdlet visualizzerà un prompt prima della terminazione di ogni spazio di lavoro. Per disattivare la richiesta di conferma, aggiungi il parametro -Force.


Get-WKSWorkspaces | Remove-WKSWorkspace

Esempio 3: questo esempio mostra come passare oggetti TerminateRequest che definiscono gli spazi di lavoro da terminare. Il cmdlet richiederà una conferma prima di procedere, a meno che non venga specificato anche il parametro switch -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

Per informazioni dettagliate sull’API, consulta TerminateWorkspaces nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Reset-WKSWorkspace.

Strumenti per PowerShell V5

Esempio 1: ricompila lo spazio di lavoro specificato.


Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Esempio 2: recupera la raccolta di tutti gli spazi di lavoro e reindirizza gli ID al parametro -WorkSpaceId di Reset-WKSWorkspace, causando la ricompilazione degli spazi di lavoro.


Get-WKSWorkspaces | Reset-WKSWorkspace

Per informazioni dettagliate sull’API, consulta RebuildWorkspaces nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Restart-WKSWorkspace.

Strumenti per PowerShell V5

Esempio 1: riavvia lo spazio di lavoro specificato.


Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"

Esempio 2: riavvia più spazi di lavoro.


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

Esempio 3: recupera la raccolta di tutti gli spazi di lavoro e reindirizza gli ID al parametro -WorkspaceID di Restart-WKSWorkspace causando il riavvio degli spazi di lavoro.


Get-WKSWorkspaces | Restart-WKSWorkspace

Per informazioni dettagliate sull’API, consulta RebootWorkspaces nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Stop-WKSWorkspace.

Strumenti per PowerShell V5

Esempio 1: arresta più spazi di lavoro.


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

Esempio 2: recupera la raccolta di tutti gli spazi di lavoro e reindirizza gli ID al parametro -WorkspaceID di Stop-WksWorkspace causando l’arresto degli spazi di lavoro.


Get-WKSWorkspaces | Stop-WKSWorkspace

Esempio 3: questo esempio mostra come passare oggetti StopRequest che definiscono gli spazi di lavoro da arrestare.


$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

Per informazioni dettagliate sull’API, consulta StopWorkspaces nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

L’esempio di codice seguente mostra come utilizzare Unregister-WKSIpGroup.

Strumenti per PowerShell V5

Esempio 1: questo esempio annulla la registrazione del gruppo di IP specificato con la directory specificata


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

Per informazioni dettagliate sull’API, consulta DisassociateIpGroups nella documentazione di riferimento dei cmdlet di AWS Strumenti per PowerShell (V5).

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

AWS WAFV2

SDK per Python (Boto3)