New-FilesSecret

Create Secret.

Syntax

New-FilesSecret -Name <System.String> [-Description <System.String>] -SecretType <System.String> [-Metadata <System.Collections.IDictionary>] [-WorkspaceId <System.Int64>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Secret.

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 Secret

New-FilesSecret -Name 'Production API token' -SecretType 'token' -Description 'Used by production API integrations.' -Metadata @{ header_name = 'Authorization' }

Writes the secret returned.

Example 2: Preview the change

New-FilesSecret -Name 'Production API token' -SecretType 'token' -Description 'Used by production API integrations.' -Metadata @{ header_name = 'Authorization' } -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Name

Secret name.

  • Type: System.String
  • Parameter sets: (All) (required)

-Description

Internal description for your reference.

  • Type: System.String
  • Parameter sets: (All)

-SecretType

Secret type.

  • Type: System.String
  • Parameter sets: (All) (required)

-Metadata

Non-secret metadata for the Secret type. Give a hashtable or PSCustomObject; keys keep their case and values their types.

  • Type: System.Collections.IDictionary
  • 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 $ConfirmPreference of High, the command asks before each change; -Confirm:$false runs 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.Secret: the secret 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.