Guide

Bulk search

New-BulkSearch

Suggest Edits

Synopsis

Bulk search a set of properties or includes.

Syntax

New-BulkSearch [-Match] <String> [-BulkSearchQualifier <String>] [-Synchronous] [-GroupId <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-BulkSearch -Body <Object> [-Synchronous] [-GroupId <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Performs a search across all active property or include versions by specifying a JSONPath expression to query the rule trees. By default, this operation is asynchronous, and thus, in this case, you can retrieve the results of your search with the Get-BulkSearch operation.

Alternatively, you can add the -Synchronous switch parameter and await results.

In either case, once you have your results, you can create new property versions, bulk patch the rule trees, and then activate them.

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.
‑Body
Conditionally required
Object Parameter sets: postbody Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑BulkSearchQualifier
String Parameter sets: attributes Pipeline input: False

An additional set of JSON Path test expressions that must all succeed for the main match on the rule tree to yield results.
‑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.
‑Match
Conditionally required
String Parameter sets: attributes Pipeline input: False

The JSON Path expression to search within available rule trees.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Synchronous
Switch Pipeline input: False

If present, the function makes a synchronous request and awaits the results. If absent, the function makes an asynchronous request which returns an ID you can retrieve later.

Related Links

Updated 16 days ago