New-FilesGpgKey
Create GPG Key.
Syntax
Description
Create GPG Key.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.
Examples
Example 1: Create GPG Key
Writes the gpg key returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-UserId
User ID. Provide a value of 0 to operate the current session's user.
- Type:
System.Int64 - Parameter sets:
(All)
-PartnerId
Partner ID who owns this GPG Key, if applicable.
- Type:
System.Int64 - Parameter sets:
(All)
-PublicKey
The GPG public key
- Type:
System.String - Parameter sets:
(All)
-PrivateKey
The GPG private key Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
(All)
-PrivateKeyPassword
The GPG private key password Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
(All)
-Name
GPG key name.
- Type:
System.String - Parameter sets:
(All)(required)
-WorkspaceId
Workspace ID (0 for default workspace).
- Type:
System.Int64 - Parameter sets:
(All)
-GenerateExpiresAt
Expiration date of the key. Used for the generation of the key. Will be ignored if generate_keypair is false. Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.
- Type:
System.DateTimeOffset - Parameter sets:
(All)
-GenerateKeypair
If true, generate a new GPG key pair. Can not be used with public_key/private_key
- Type:
System.Boolean - Parameter sets:
(All)
-GenerateFullName
Full name of the key owner. Used for the generation of the key. Will be ignored if generate_keypair is false.
- Type:
System.String - Parameter sets:
(All)
-GenerateEmail
Email address of the key owner. Used for the generation of the key. Will be ignored if generate_keypair is false.
- Type:
System.String - Parameter sets:
(All)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: High. At the default
$ConfirmPreferenceofHigh, the command asks before each change;-Confirm:$falseruns it without asking.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.GpgKey: the gpg key as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.