D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
WorkSpaces exemples utilisant des outils pour PowerShell
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du Outils AWS pour PowerShell with WorkSpaces.
Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.
Rubriques
Actions
L'exemple de code suivant montre comment utiliserApprove-WKSIpRule.
- Outils pour PowerShell
-
Exemple 1 : cet exemple ajoute des règles à un groupe IP existant
$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-
Pour plus de détails sur l'API, reportez-vous AuthorizeIpRulesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserCopy-WKSWorkspaceImage.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple copie l'image de l'espace de travail avec l'ID spécifié de us-west-2 vers la région actuelle avec le nom « » CopiedImageTest
Copy-WKSWorkspaceImage -Name CopiedImageTest -SourceRegion us-west-2 -SourceImageId wsi-djfoedhw6Sortie :
wsi-456abaqfe-
Pour plus de détails sur l'API, reportez-vous CopyWorkspaceImageà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserEdit-WKSClientProperty.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple active la reconnexion pour le client Workspaces
Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369-
Pour plus de détails sur l'API, reportez-vous ModifyClientPropertiesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserEdit-WKSSelfServicePermission.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple active les autorisations en libre-service pour modifier le type de calcul et augmenter la taille du volume pour le répertoire spécifié
Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED-
Pour plus de détails sur l'API, reportez-vous ModifySelfservicePermissionsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserEdit-WKSWorkspaceAccessProperty.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple active l'accès à Workspace sur Android et Chrome OS pour le répertoire spécifié
Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW-
Pour plus de détails sur l'API, reportez-vous ModifyWorkspaceAccessPropertiesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserEdit-WKSWorkspaceCreationProperty.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple active l'accès à Internet et le mode de maintenance sur true comme valeurs par défaut lors de la création d'un espace de travail
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true-
Pour plus de détails sur l'API, reportez-vous ModifyWorkspaceCreationPropertiesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserEdit-WKSWorkspaceProperty.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple modifie la propriété Workspace Running Mode en Auto Stop pour l'espace de travail spécifié
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP-
Pour plus de détails sur l'API, reportez-vous ModifyWorkspacePropertiesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserEdit-WKSWorkspaceState.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple fait passer l'état de l'espace de travail spécifié à Disponible
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE-
Pour plus de détails sur l'API, reportez-vous ModifyWorkspaceStateà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSClientProperty.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple obtient les propriétés client du client Workspace pour le répertoire spécifié
Get-WKSClientProperty -ResourceId d-223562a123-
Pour plus de détails sur l'API, reportez-vous DescribeClientPropertiesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSIpGroup.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple obtient les détails du groupe IP spécifié dans la région spécifiée
Get-WKSIpGroup -Region us-east-1 -GroupId wsipg-8m1234v45Sortie :
GroupDesc GroupId GroupName UserRules --------- ------- --------- --------- wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}-
Pour plus de détails sur l'API, reportez-vous DescribeIpGroupsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSTag.
- Outils pour PowerShell
-
Exemple 1 : cet exemple récupère la balise pour l'espace de travail donné
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2Sortie :
Key Value --- ----- auto-delete no purpose Workbench-
Pour plus de détails sur l'API, reportez-vous DescribeTagsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSWorkspace.
- Outils pour PowerShell
-
Exemple 1 : récupère les détails de toutes vos connexions WorkSpaces au pipeline.
Get-WKSWorkspaceSortie :
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.WorkspacePropertiesExemple 2 : Cette commande affiche les valeurs des propriétés enfant
WorkSpacePropertiesd'un espace de travail de laus-west-2région. Pour plus d'informations sur les propriétés enfant deWorkSpaceProperties, consultez https://docs.aws.amazon.com/workspaces/ latest/api/API _ WorkspaceProperties .html.(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspacePropertiesSortie :
ComputeTypeName : STANDARD RootVolumeSizeGib : 80 RunningMode : AUTO_STOP RunningModeAutoStopTimeoutInMinutes : 60 UserVolumeSizeGib : 50Exemple 3 : Cette commande indique la valeur de la propriété enfant
RootVolumeSizeGibdeWorkSpacePropertiespour un espace de travail de laus-west-2région. La taille du volume racine, en GiB, est de 80.(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGibSortie :
80-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspacesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSWorkspaceBundle.
- Outils pour PowerShell
-
Exemple 1 : cet exemple récupère les détails de tous les packs Workspace de la région actuelle
Get-WKSWorkspaceBundleSortie :
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-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspaceBundlesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSWorkspaceDirectory.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple répertorie les détails des annuaires enregistrés
Get-WKSWorkspaceDirectorySortie :
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-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspaceDirectoriesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSWorkspaceImage.
- Outils pour PowerShell
-
Exemple 1 : cet exemple récupère tous les détails de toutes les images de la région
Get-WKSWorkspaceImageSortie :
Description :This image is copied from another image ErrorCode : ErrorMessage : ImageId : wsi-345ahdjgo Name : CopiedImageTest OperatingSystem : Amazon.WorkSpaces.Model.OperatingSystem RequiredTenancy : DEFAULT State : AVAILABLE-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspaceImagesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSWorkspaceSnapshot.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple montre l'horodatage du dernier instantané créé pour l'espace de travail spécifié
Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100vSortie :
RebuildSnapshots RestoreSnapshots ---------------- ---------------- {Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspaceSnapshotsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserGet-WKSWorkspacesConnectionStatus.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple extrait l'état de connexion pour l'espace de travail spécifié
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspacesConnectionStatusà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserNew-WKSIpGroup.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple crée un groupe d'adresses IP vide nommé FreshEmptyIpGroup
New-WKSIpGroup -GroupName "FreshNewIPGroup"Sortie :
wsipg-w45rty4ty-
Pour plus de détails sur l'API, reportez-vous CreateIpGroupà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserNew-WKSTag.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple ajoute une nouvelle balise à un espace de travail nommé
ws-wsname. La balise possède une clé « Nom » et une valeur clé 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 $tagExemple 2 : Cet exemple ajoute plusieurs balises à un espace de travail nommé
ws-wsname. Une balise possède une clé « Nom » et une valeur clé deAWS_Workspace; l'autre balise a une clé « Stage » et une valeur clé « 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-
Pour plus de détails sur l'API, reportez-vous CreateTagsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserNew-WKSWorkspace.
- Outils pour PowerShell
-
Exemple 1 : créez un WorkSpace pour le bundle, le répertoire et l'utilisateur fournis.
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}Exemple 2 : Cet exemple crée plusieurs WorkSpaces
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}-
Pour plus de détails sur l'API, reportez-vous CreateWorkspacesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserRegister-WKSIpGroup.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple enregistre le groupe IP spécifié dans le répertoire spécifié
Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123-
Pour plus de détails sur l'API, reportez-vous AssociateIpGroupsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserRegister-WKSWorkspaceDirectory.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple enregistre le répertoire spécifié pour le service Workspaces
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false-
Pour plus de détails sur l'API, reportez-vous RegisterWorkspaceDirectoryà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserRemove-WKSIpGroup.
- Outils pour PowerShell
-
Exemple 1 : cet exemple supprime le groupe IP spécifié
Remove-WKSIpGroup -GroupId wsipg-32fhgtredSortie :
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-
Pour plus de détails sur l'API, reportez-vous DeleteIpGroupà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserRemove-WKSTag.
- Outils pour PowerShell
-
Exemple 1 : cet exemple supprime la balise associée à l'espace de travail
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"Sortie :
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-
Pour plus de détails sur l'API, reportez-vous DeleteTagsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserRemove-WKSWorkspace.
- Outils pour PowerShell
-
Exemple 1 : met fin à plusieurs WorkSpaces. L'utilisation du commutateur -Force empêche l'applet de commande de demander une confirmation.
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -ForceExemple 2 : Récupère la collection de tous vos WorkSpaces et les dirige IDs vers le WorkSpaceId paramètre - de Remove-WKSWorkspace, en mettant fin à tous les. WorkSpaces L'applet de commande affiche un message avant de terminer chacune d'entre elles WorkSpace . Pour supprimer l'invite de confirmation, ajoutez le commutateur -Force.
Get-WKSWorkspaces | Remove-WKSWorkspaceExemple 3 : Cet exemple montre comment transmettre TerminateRequest des objets définissant le WorkSpaces à terminer. L'applet de commande demandera une confirmation avant de continuer, sauf si le paramètre de commutation -Force est également spécifié.
$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-
Pour plus de détails sur l'API, reportez-vous TerminateWorkspacesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserReset-WKSWorkspace.
- Outils pour PowerShell
-
Exemple 1 : reconstruit le fichier spécifié WorkSpace.
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"Exemple 2 : récupère la collection de tous vos fichiers WorkSpaces et les redirige IDs vers le WorkSpaceId paramètre - de Reset-WKSWorkspace, ce qui entraîne WorkSpaces leur reconstruction.
Get-WKSWorkspaces | Reset-WKSWorkspace-
Pour plus de détails sur l'API, reportez-vous RebuildWorkspacesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserRestart-WKSWorkspace.
- Outils pour PowerShell
-
Exemple 1 : redémarre le paramètre spécifié WorkSpace.
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"Exemple 2 : redémarre plusieurs WorkSpaces.
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"Exemple 3 : récupère la collection de tous vos fichiers WorkSpaces et les redirige IDs vers le WorkSpaceId paramètre - de Restart-WKSWorkspace, provoquant le WorkSpaces redémarrage du.
Get-WKSWorkspaces | Restart-WKSWorkspace-
Pour plus de détails sur l'API, reportez-vous RebootWorkspacesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserStop-WKSWorkspace.
- Outils pour PowerShell
-
Exemple 1 : arrête plusieurs WorkSpaces
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"Exemple 2 : récupère la collection de tous vos WorkSpaces fichiers et les dirige IDs vers le WorkSpaceId paramètre - de Stop- WKSWorkspace provoquant WorkSpaces leur arrêt.
Get-WKSWorkspaces | Stop-WKSWorkspaceExemple 3 : Cet exemple montre comment transmettre StopRequest des objets définissant le WorkSpaces à arrêter.
$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-
Pour plus de détails sur l'API, reportez-vous StopWorkspacesà la section Référence des Outils AWS pour PowerShell applets de commande.
-
L'exemple de code suivant montre comment utiliserUnregister-WKSIpGroup.
- Outils pour PowerShell
-
Exemple 1 : Cet exemple annule l'enregistrement du groupe IP spécifié dans le répertoire spécifié
Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123-
Pour plus de détails sur l'API, reportez-vous DisassociateIpGroupsà la section Référence des Outils AWS pour PowerShell applets de commande.
-
