Property hostname

Add-PropertyHostname

Synopsis

Add hostnames to a property version.

Syntax

name (Default)

Add-PropertyHostname [-PropertyName] <String> [-PropertyVersion] <String> -NewHostnames <Object[]>
 [-GroupID <String>] [-ContractId <String>] [-IncludeCertStatus] [-ValidateHostnames] [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id

Add-PropertyHostname -PropertyID <String> [-PropertyVersion] <String> -NewHostnames <Object[]>
 [-GroupID <String>] [-ContractId <String>] [-IncludeCertStatus] [-ValidateHostnames] [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Adds one or more hostnames to a property version. The -PropertyVersion you provide in this operation needs to be INACTIVE on both the production and staging networks.

To see the format of hostnames to add, it's recommended that you run the Get-PropertyHostname operation and clone the object from the returned data.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContractId

Unique identifier for the contract. The parameter is optional if a property belongs to only one contract, otherwise you need to specify it along with the GroupID. This parameter is optional except for create requests.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupID

Unique identifier for the group. The parameter is optional if a property belongs to only one group, otherwise you need to specify it along with the ContractID. This parameter is optional except for create requests.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeCertStatus

Whether the response should include the certificate status for the hostname on staging and production networks.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-NewHostnames

Array of hostnames to be added. Each entry need to contain these members: cnameFrom, cnameType, edgeHostnameId, and certProvisioningType.

Type: Object[]
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PropertyID

Unique identifier for the property. Commonly you only need to specify one of: PropertyName, PropertyID.

Type: String
Parameter Sets: id
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyName

Name of your property. Commonly you only need to specify one of: PropertyName, PropertyID.

Type: String
Parameter Sets: name
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyVersion

Property's incremental version number. Can be an integer or the word latest.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidateHostnames

Run validation tests that would identify potential hostname-related problems within the response object's errors and warnings arrays.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Object[]

Outputs

System.Object