Policy

Get-CloudletPolicy

Synopsis

Get a policy.

Syntax

all (Default)

Get-CloudletPolicy [-Legacy] [-Page <String>] [-Size <Int32>] [-GroupID <Int32>] [-IncludeDeleted]
 [-CloudletID <String>] [-All] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

single

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

Description

Gets all Cloudlet policies or returns a specific policy by its ID. When listing all policies, you can control paging with the -Page and -Size parameters.

When listing v2 policies, you can additionally limit them by group ID or Cloudlet ID and include deleted policies with the -IncludeDeleted 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

-All

Following paging links until exhausted, returning all policies.

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

-CloudletID

For GET operations, returns only policies for this particular cloudletId. The cloudletId for:

Edge Redirector is 0
Visitor Prioritization is 1
Forward Rewrite is 3
Request Control is 4
API Prioritization is 5
Audience Segmentation is 6
Phased Release is 7
Application Load Balancer is 9

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

-GroupID

Unique identifier for each group.

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

-IncludeDeleted

For GET operations, includes deleted policies in the results.

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

-Page

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

Type: String
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: single
Aliases: None
Required: False
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

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