Weitere AWS SDK-Beispiele sind im Repo AWS Doc SDK Examples
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
WorkSpaces Beispiele für die Verwendung von Tools für PowerShell
Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von AWS -Tools für PowerShell with Aktionen ausführen und allgemeine Szenarien implementieren WorkSpaces.
Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarios anzeigen.
Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.
Themen
Aktionen
Das folgende Codebeispiel zeigt die VerwendungApprove-WKSIpRule.
- Tools für PowerShell
-
Beispiel 1: Dieses Beispiel fügt Regeln zu einer vorhandenen IP-Gruppe hinzu
$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-
Einzelheiten zur API finden Sie unter AuthorizeIpRules AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Copy-WKSWorkspaceImage
- Tools für PowerShell
-
Beispiel 1: Dieses Beispiel kopiert das Workspace-Bild mit der angegebenen ID von us-west-2 in die aktuelle Region mit dem Namen "" CopiedImageTest
Copy-WKSWorkspaceImage -Name CopiedImageTest -SourceRegion us-west-2 -SourceImageId wsi-djfoedhw6Ausgabe:
wsi-456abaqfe-
Einzelheiten zur API finden Sie unter CopyWorkspaceImage AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Edit-WKSClientProperty
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird Reconnection für den Workspaces-Client aktiviert
Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369-
Einzelheiten zur API finden Sie unter ModifyClientProperties AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Edit-WKSSelfServicePermission
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel werden Self-Service-Berechtigungen aktiviert, um den Rechnertyp zu ändern und die Volume-Größe für das angegebene Verzeichnis zu erhöhen
Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED-
Einzelheiten zur API finden Sie unter ModifySelfservicePermissions AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Edit-WKSWorkspaceAccessProperty
- Tools für PowerShell
-
Beispiel 1: Dieses Beispiel aktiviert den Workspace-Zugriff auf Android und Chrome OS für das angegebene Verzeichnis
Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW-
Einzelheiten zur API finden Sie unter ModifyWorkspaceAccessProperties AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Edit-WKSWorkspaceCreationProperty
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel werden beim Erstellen eines Workspace die Standardwerte „Internetzugriff“ und „Wartungsmodus“ auf „true“ gesetzt
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true-
Einzelheiten zur API finden Sie unter ModifyWorkspaceCreationProperties AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Edit-WKSWorkspaceProperty
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird die Eigenschaft Workspace Running Mode für den angegebenen Workspace auf Auto Stop geändert
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP-
Einzelheiten zur API finden Sie unter ModifyWorkspaceProperties AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Edit-WKSWorkspaceState
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird der Status des angegebenen Workspace auf Verfügbar geändert
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE-
Einzelheiten zur API finden Sie unter ModifyWorkspaceState AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSClientProperty
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel werden die Client-Eigenschaften des Workspace Client für das angegebene Verzeichnis abgerufen
Get-WKSClientProperty -ResourceId d-223562a123-
Einzelheiten zur API finden Sie unter DescribeClientProperties AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSIpGroup
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel werden die Details der angegebenen IP-Gruppe in der angegebenen Region abgerufen
Get-WKSIpGroup -Region us-east-1 -GroupId wsipg-8m1234v45Ausgabe:
GroupDesc GroupId GroupName UserRules --------- ------- --------- --------- wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}-
Einzelheiten zur API finden Sie unter DescribeIpGroups AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSTag
- Tools für PowerShell
-
Beispiel 1: Dieses Beispiel ruft das Tag für den angegebenen Workspace ab
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2Ausgabe:
Key Value --- ----- auto-delete no purpose Workbench-
Einzelheiten zur API finden Sie unter DescribeTags AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSWorkspace
- Tools für PowerShell
-
Beispiel 1: Ruft Details WorkSpaces zu all Ihren Kontakten in der Pipeline ab.
Get-WKSWorkspaceAusgabe:
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.WorkspacePropertiesBeispiel 2: Dieser Befehl zeigt die Werte der untergeordneten Eigenschaften eines
WorkSpacePropertiesWorkspace in derus-west-2Region an. Weitere Informationen zu den untergeordneten Eigenschaften vonWorkSpacePropertiesfinden Sie unter https://docs.aws.amazon.com/workspaces/ latest/api/API _ WorkspaceProperties .html.(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspacePropertiesAusgabe:
ComputeTypeName : STANDARD RootVolumeSizeGib : 80 RunningMode : AUTO_STOP RunningModeAutoStopTimeoutInMinutes : 60 UserVolumeSizeGib : 50Beispiel 3: Dieser Befehl zeigt den Wert der untergeordneten Eigenschaft
RootVolumeSizeGibvonWorkSpacePropertiesfür einen Workspace in derus-west-2Region an. Die Größe des Root-Volumes in GiB beträgt 80.(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGibAusgabe:
80-
Einzelheiten zur API finden Sie unter DescribeWorkspaces AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSWorkspaceBundle
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel werden Details zu allen Workspace-Bundles in der aktuellen Region abgerufen
Get-WKSWorkspaceBundleAusgabe:
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-
Einzelheiten zur API finden Sie unter DescribeWorkspaceBundles AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSWorkspaceDirectory
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel werden die Verzeichnisdetails für registrierte Verzeichnisse aufgeführt
Get-WKSWorkspaceDirectoryAusgabe:
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-
Einzelheiten zur API finden Sie unter DescribeWorkspaceDirectories AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSWorkspaceImage
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel werden alle Details aller Bilder in der Region abgerufen
Get-WKSWorkspaceImageAusgabe:
Description :This image is copied from another image ErrorCode : ErrorMessage : ImageId : wsi-345ahdjgo Name : CopiedImageTest OperatingSystem : Amazon.WorkSpaces.Model.OperatingSystem RequiredTenancy : DEFAULT State : AVAILABLE-
Einzelheiten zur API finden Sie unter DescribeWorkspaceImages AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSWorkspaceSnapshot
- Tools für PowerShell
-
Beispiel 1: Dieses Beispiel zeigt den Zeitstempel des zuletzt für den angegebenen Workspace erstellten Snapshots
Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100vAusgabe:
RebuildSnapshots RestoreSnapshots ---------------- ---------------- {Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}-
Einzelheiten zur API finden Sie unter DescribeWorkspaceSnapshots AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Get-WKSWorkspacesConnectionStatus
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird der Verbindungsstatus für den angegebenen Workspace abgerufen
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r-
Einzelheiten zur API finden Sie unter DescribeWorkspacesConnectionStatus AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. New-WKSIpGroup
- Tools für PowerShell
-
Beispiel 1: Dieses Beispiel erstellt eine leere IP-Gruppe mit dem Namen FreshEmptyIpGroup
New-WKSIpGroup -GroupName "FreshNewIPGroup"Ausgabe:
wsipg-w45rty4ty-
Einzelheiten zur API finden Sie unter CreateIpGroup AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. New-WKSTag
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird ein neues Tag zu einem Workspace mit dem Namen hinzugefügt
ws-wsname. Das Tag hat den Schlüssel „Name“ und den SchlüsselwertAWS_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 $tagBeispiel 2: In diesem Beispiel werden mehrere Tags zu einem Arbeitsbereich mit dem Namen hinzugefügt
ws-wsname. Ein Tag hat den Schlüssel „Name“ und den SchlüsselwertAWS_Workspace; das andere Tag hat den Tag-Schlüssel „Stage“ und den Schlüsselwert „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-
Einzelheiten zur API finden Sie unter CreateTags AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. New-WKSWorkspace
- Tools für PowerShell
-
Beispiel 1: Erstellen Sie eine WorkSpace für das bereitgestellte Paket, das Verzeichnis und den Benutzer.
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}Beispiel 2: In diesem Beispiel werden mehrere erstellt WorkSpaces
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}-
Einzelheiten zur API finden Sie unter CreateWorkspaces AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Register-WKSIpGroup
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird die angegebene IP-Gruppe im angegebenen Verzeichnis registriert
Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123-
Einzelheiten zur API finden Sie unter AssociateIpGroups AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Register-WKSWorkspaceDirectory
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird das angegebene Verzeichnis für Workspaces Service registriert
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false-
Einzelheiten zur API finden Sie unter RegisterWorkspaceDirectory AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Remove-WKSIpGroup
- Tools für PowerShell
-
Beispiel 1: Dieses Beispiel löscht die angegebene IP-Gruppe
Remove-WKSIpGroup -GroupId wsipg-32fhgtredAusgabe:
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-
Einzelheiten zur API finden Sie unter DeleteIpGroup AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Remove-WKSTag
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird das dem Workspace zugeordnete Tag entfernt
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"Ausgabe:
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-
Einzelheiten zur API finden Sie unter DeleteTags AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Remove-WKSWorkspace
- Tools für PowerShell
-
Beispiel 1: Beendet mehrere WorkSpaces. Die Verwendung der Option -Force verhindert, dass das Cmdlet zur Bestätigung auffordert.
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -ForceBeispiel 2: Ruft die Auflistung aller Ihrer Daten ab WorkSpaces und leitet sie über die Pipeline IDs an den WorkSpaceId Parameter - von Remove- WKSWorkspace weiter, wodurch alle von. WorkSpaces Das Cmdlet fragt nach, bevor jedes Cmdlet beendet wird. WorkSpace Um die Bestätigungsaufforderung zu unterdrücken, fügen Sie die Option -Force hinzu.
Get-WKSWorkspaces | Remove-WKSWorkspaceBeispiel 3: Dieses Beispiel zeigt, wie TerminateRequest Objekte übergeben werden, die definieren, dass sie beendet werden WorkSpaces sollen. Das Cmdlet fordert Sie zur Bestätigung auf, bevor Sie fortfahren, es sei denn, der Switch-Parameter -Force ist ebenfalls angegeben.
$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-
Einzelheiten zur API finden Sie unter TerminateWorkspacesCmdlet-Referenz.AWS -Tools für PowerShell
-
Das folgende Codebeispiel zeigt die Verwendung. Reset-WKSWorkspace
- Tools für PowerShell
-
Beispiel 1: Baut die angegebene WorkSpace Datei neu auf.
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"Beispiel 2: Ruft die Sammlung aller Ihrer Dateien ab WorkSpaces und leitet sie IDs an den WorkSpaceId -Parameter von Reset- weiterWKSWorkspace, wodurch der WorkSpaces neu erstellt wird.
Get-WKSWorkspaces | Reset-WKSWorkspace-
Einzelheiten zur API finden Sie unter RebuildWorkspaces AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Restart-WKSWorkspace
- Tools für PowerShell
-
Beispiel 1: Startet den angegebenen WorkSpace neu.
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"Beispiel 2: Startet mehrere neu. WorkSpaces
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"Beispiel 3: Ruft die Sammlung all Ihrer Daten ab WorkSpaces und leitet sie IDs an den WorkSpaceId Parameter - von Restart- weiterWKSWorkspace, wodurch der WorkSpaces neu gestartet wird.
Get-WKSWorkspaces | Restart-WKSWorkspace-
Einzelheiten zur API finden Sie unter RebootWorkspaces AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Stop-WKSWorkspace
- Tools für PowerShell
-
Beispiel 1: Stoppt mehrere WorkSpaces.
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"Beispiel 2: Ruft die Sammlung all Ihrer Daten ab WorkSpaces und leitet sie IDs an den WorkSpaceId Parameter - von Stop- weiter WorkSpaces , WKSWorkspace wodurch der gestoppt wird.
Get-WKSWorkspaces | Stop-WKSWorkspaceBeispiel 3: Dieses Beispiel zeigt, wie StopRequest Objekte übergeben werden, die definieren, was gestoppt werden WorkSpaces soll.
$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-
Einzelheiten zur API finden Sie unter StopWorkspaces AWS -Tools für PowerShellCmdlet-Referenz.
-
Das folgende Codebeispiel zeigt die Verwendung. Unregister-WKSIpGroup
- Tools für PowerShell
-
Beispiel 1: In diesem Beispiel wird die Registrierung der angegebenen IP-Gruppe im angegebenen Verzeichnis aufgehoben
Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123-
Einzelheiten zur API finden Sie unter DisassociateIpGroups AWS -Tools für PowerShellCmdlet-Referenz.
-
