Edge hostname

New-EdgeHostname

Synopsis

Create a new edge hostname.

Syntax

New-EdgeHostname -DomainPrefix <String> -DomainSuffix <String> -IPVersionBehavior <String> -ProductID <String> [-SecureNetwork <String>] [-SlotNumber <Int32>] [-CertEnrollmentID <Int32>] -GroupID <String> -ContractId <String> [-Options <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-EdgeHostname -Body <Object> -GroupID <String> -ContractId <String> [-Options <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates a new edge hostname on either the amaized.net, edgesuite.net, or edgekey.net domains. If using edgekey.net, you need to provide the certificate enrollment ID to associate the new edge hostname with a certificate slot.

You can retrieve this ID by running the Get-CPSEnrollment operation and filtering the results for your desired certificate.

Parameters

‑AccountSwitchKey

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑Body
Conditionally required

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑CertEnrollmentID

When creating an Enhanced TLS edge hostname, this sets the certificate enrollment ID. Specify this with SecureNetwork set to ENHANCED_TLS. Enrollment IDs can be retrieved with Get-CPSEnrollment.

‑ContractId
Required

Your contract's ID. 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 the create requests.

‑DomainPrefix
Conditionally required

The customer-specific namePrefix of an edge hostname, such as www.example.com. As opposed to the Akamai-specific domainSuffix, such as edgesuite.net. The edge hostname's final DNS CNAME combines the two, for example, www.example.com.edgesuite.net.

‑DomainSuffix
Conditionally required

The Akamai-specific portion of the edge hostname, for example, edgesuite.net.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑GroupID
Required

Your group's ID. 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 the create requests.

‑IPVersionBehavior
Conditionally required

The version of the IP protocol to use, either IPV4 for version 4 only or IPV6_COMPLIANCE for both 4 and 6. The default value for requests is IPV4.

‑Options

Currently, the only supported option is mapDetails which enables extra mapping-related information.

‑ProductID
Conditionally required

The product's ID.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

‑SecureNetwork

The type of security for the new edge hostname. One of:

- For STANDARD, provide a -DomainSuffix of edgesuite.net.

- For SHAREDCERT, provide a -DomainSuffix of akamaized.net.

- For ENHANCED_TLS, provide a -CertEnrollmentID value along with a -DomainSuffix of edgekey.net.

‑SlotNumber

The slot number for Enhanced TLS edge hostnames. You can retrieve slot numbers with Get-CPSEnrollment.

Related Links