Operations

Get-APIOperations

Synopsis

Search operations.

Syntax

Get-APIOperations [[-QueryType] <String>] [[-ActiveStartTime] <String>] [[-ActiveEndTime] <String>]
 [-IncludeDetails] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets a filtered list of operations with their endpoints and resources. Use the -QueryType parameter to filter by the date range or activation status.

Note that if -QueryType is set to ACTIVE_WITHIN_DATE_RANGE, you also need to specify the values for the -ActiveStartTime and -ActiveEndTime parameters.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ActiveEndTime

The ISO 8601 timestamp for the end of the date range.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ActiveStartTime

The ISO 8601 timestamp for the start of the date range.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeDetails

Specify to include all the resource and operation details.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-QueryType

The type of query. Options: ACTIVE_IN_PRODUCTION, ACTIVE_IN_STAGING, or ACTIVE_WITHIN_DATE_RANGE.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ACTIVE_IN_PRODUCTION, ACTIVE_IN_STAGING, ACTIVE_WITHIN_DATE_RANGE

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object