New-FilesCustomDomain

Create Custom Domain.

Syntax

New-FilesCustomDomain [-AvailableToAllWorkspaces <System.Boolean>] [-WorkspaceId <System.Int64>] [-Destination <System.String>] [-FolderBehaviorId <System.Int64>] [-SslCertificateId <System.Int64>] -Domain <System.String> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Custom Domain.

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 Custom Domain

New-FilesCustomDomain -Domain 'files.example.com' -WorkspaceId 1 -Destination 'site_alias'

Writes the custom domain returned.

Example 2: Preview the change

New-FilesCustomDomain -Domain 'files.example.com' -WorkspaceId 1 -Destination 'site_alias' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-AvailableToAllWorkspaces

Allow all workspaces to use this default-workspace Custom Domain.

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

-WorkspaceId

Workspace ID (0 for the default workspace).

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

-Destination

Where this custom domain routes. Can be site_alias, public_hosting, s3_endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound public_hosting folder behavior is deleted, and can be set manually via the API for any reason.

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

-FolderBehaviorId

Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.

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

-SslCertificateId

Current SSL certificate ID.

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

-Domain

Customer-owned domain name.

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

-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.CustomDomain: the custom domain 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.