Guide
  1. AppSec
  2. Get

Export status

Synopsis

Get asynchronous export status.

Syntax

Get-AppSecExportStatus [-ConfigName] <String> [-VersionNumber] <String> -ExportID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-AppSecExportStatus -ConfigID <Int32> [-VersionNumber] <String> -ExportID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Get a security configuration version's export status. When PENDING, the task is still running. When COMPLETED, the task finished successfully and you can collect the results through the link in the response. A status of FAILED appears when the task can't complete.

Parameters

‑AccountSwitchKey
StringPipeline 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.

‑ConfigID
Alias: ‑id
Conditionally required
IntParameter sets: Config IDPipeline input: ByPropertyName

Your configuration's ID.

‑ConfigName
Conditionally required
StringParameter sets: Config namePipeline input: False

The name of your security configuration.

‑EdgeRCFile
StringPipeline input: False

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

‑ExportID
Required
StringPipeline input: ByValue, ByPropertyName

A unique identifier for each asynchronous export.

‑Section
StringPipeline input: False

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

‑VersionNumber
Alias: ‑version
Required
StringPipeline input: ByPropertyName

A configuration's version. Can be an integer or the word latest.

Related Links

Updated 7 days ago