Set-FilesCustomDomain
Update Custom Domain.
Syntax
Id (Default)
InputObject
Description
Update Custom Domain.
The command accepts custom domains from the pipeline as -InputObject, and uses each one's Id and the connection that fetched it.
When given -InputObject, the command updates that object with the values Files.com returns and writes it.
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: Update Custom Domain
Writes the custom domain as Files.com returns it.
Example 2: Act on custom domains from the pipeline
Takes the custom domain from the pipeline and uses its Id and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Id
Custom Domain ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-AvailableToAllWorkspaces
Allow all workspaces to use this default-workspace Custom Domain.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-WorkspaceId
Workspace ID (0 for the default workspace).
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-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:
Id,InputObject
-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:
Id,InputObject
-SslCertificateId
Current SSL certificate ID.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-Domain
Customer-owned domain name.
- Type:
System.String - Parameter sets:
Id,InputObject
-InputObject
The custom domain to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.CustomDomain - Parameter sets:
InputObject(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
$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
FilesCom.PowerShell.Models.CustomDomain: a custom domain from another command of the module, as-InputObject.
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.