Bucket activation

Get-BucketActivation

Synopsis

Get or list hostname bucket activations.

Syntax

Get-BucketActivation [-PropertyName] <String> [-HostnameActivationID <String>] [-IncludeHostnames] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-BucketActivation -PropertyID <String> [-HostnameActivationID <String>] [-IncludeHostnames] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all hostname bucket activations or returns an individual activation by its -HostnameActivationID. Optionally, you can retrieve the hostnames of your bucket with the IncludeHostnames switch.

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.

‑ContractId

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.

‑EdgeRCFile

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

‑GroupID

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.

‑HostnameActivationID

Your hostname activation's ID.

‑IncludeHostnames

When enabled, the response includes the property hostnames associated with an activation and the related certificate status on staging and production networks.

‑PropertyID
Conditionally required

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑PropertyName
Conditionally required

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑Section

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

Related Links