Image

Get-IVMImage

Synopsis

Get an image.

Syntax

all (Default)

Get-IVMImage -PolicySetID <String> -Network <String> [-PolicyID <String>] [-Limit <Int32>] [-URL <String>]
 [-ContractID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

single

Get-IVMImage -PolicySetID <String> -Network <String> [-ImageID <String>] [-ContractID <String>]
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

Gets a specific image by its ID.

Note: if your account has multiple IVM-enabled contracts you need to specify the contract ID.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

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

-ContractID

An ID for the contract.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ImageID

The ID of the image. This ID usually represents the part of the URL after the scheme, host, and port.

Type: String
Parameter Sets: single
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Limit

Specifies the maximum number of logs per day.

Type: Int32
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Network

Network environment to execute the API request on.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Staging, Production

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

-PolicyID

Filters the policy to specify a single image or video policy. To get a policy's ID, run Get-IVMPolicy. Use in conjunction with the url, transformationType, and size parameters.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PolicySetID

Unique identifier for a policy set.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-URL

Limits search results to a specific image or video URL.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
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