Guide

Bucket activation

Get-BucketActivation

Suggest Edits

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
String Pipeline input: False

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
String Pipeline input: False

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
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
String Pipeline input: False

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
String Pipeline input: False

Your hostname activation's ID.
‑IncludeHostnames
Switch Pipeline input: False

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
String Parameter sets: id Pipeline input: False

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.
‑PropertyName
Conditionally required
String Parameter sets: name Pipeline input: False

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.
‑Section
String Pipeline input: False

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

Related Links

Updated 4 months ago