Policy version

Get-CloudletPolicyVersion

Synopsis

Get a policy version.

Syntax

all (Default)

Get-CloudletPolicyVersion -PolicyID <Int32> [-Legacy] [-Size <Int32>] [-Page <Int32>] [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

single

Get-CloudletPolicyVersion -PolicyID <Int32> [-Version <String>] [-Legacy] [-OmitRules] [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all versions of a given Cloudlet policy or returns a specific policy version. The -Version parameter is an integer or the word latest. Use the -Legacy switch to specify v2 policies; otherwise, the command will apply only to v3 (shared) policies.

When listing all versions, you can control paging with the -Page and -Size parameters as well as include the Cloudlet rules in the version response with the -IncludeRules switch parameter.

When retrieving a specific version of a v2 policy, you can also optionally omit its rules from the output with the -OmitRules switch parameter.

Parameters

-AccountSwitchKey

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

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

-Legacy

Indicate that your policy is legacy (v2). Without this, v3 of the Cloudlets API will be used.

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

-OmitRules

Excludes the match rules from the results.

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

-Page

Specifies a page number for batched results, starting at zero.

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

-PolicyID

The ID of the cloudlet policy.

Type: Int32
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

-Size

Specifies the number of objects on a page, at least 10 objects if using Shared. Otherwise, the minimum is 1.

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

-Version

Version number. Can be an integer or the word latest.

Type: String
Parameter Sets: single
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