New-FilesKeyLifecycleRule
Create Key Lifecycle Rule.
Syntax
Description
Create Key Lifecycle Rule.
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 Key Lifecycle Rule
Writes the key lifecycle rule returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-ApplyToAllWorkspaces
If true, a default-workspace rule also applies to keys in all workspaces.
- Type:
System.Boolean - Parameter sets:
(All)
-ExpirationDays
Number of days after creation before an SSH key expires. Applies only to SSH keys.
- Type:
System.Int64 - Parameter sets:
(All)
-KeyType
Key type for which the rule will apply (gpg, ssh, or api).
- Type:
System.String - Parameter sets:
(All)
-InactivityDays
Number of days of inactivity before the rule applies.
- Type:
System.Int64 - Parameter sets:
(All)
-Name
Key Lifecycle Rule name
- Type:
System.String - Parameter sets:
(All)
-WorkspaceId
Workspace ID. 0 means the default workspace.
- Type:
System.Int64 - 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.KeyLifecycleRule: the key lifecycle rule 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.