Guide

Property

Find-Property

Suggest Edits

Synopsis

Search properties or includes.

Syntax

Find-Property [-PropertyName] <String> [-Latest] [-JustProductionActive] [-JustStagingActive] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Find-Property -PropertyHostname <String> [-Latest] [-JustProductionActive] [-JustStagingActive] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Find-Property -EdgeHostname <String> [-Latest] [-JustProductionActive] [-JustStagingActive] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Find-Property -IncludeName <String> [-Latest] [-JustProductionActive] [-JustStagingActive] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Searches the includes by name or properties either by name, hostname, or edge hostname for which they're currently active.

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.
‑EdgeHostname
Conditionally required
String Parameter sets: Edge Pipeline input: False

Searches for property versions active on a specific edge hostname.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑IncludeName
Conditionally required
String Parameter sets: Include Pipeline input: False

A human-readable name of your property include.
‑JustProductionActive
Switch Pipeline input: False

When enabled, limits responses to only the production-active version.
‑JustStagingActive
Switch Pipeline input: False

When enabled, limits responses to only the staging-active version.
‑Latest
Switch Pipeline input: False

When enabled, limit responses to only the latest version.
‑PropertyHostname
Conditionally required
String Parameter sets: Host Pipeline input: False

Searches for properties by hostname.
‑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 10 days ago