Policy activation

Get-CloudletPolicyActivation

Synopsis

Get status for an activation.

Syntax

all (Default)

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

single

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

Description

Gets all policy activations or returns a specific activation by its ID. Use the -Legacy switch to specify v2 policies (both when listing policies or retrieving a single policy); otherwise, the command will apply only to v3 (shared) policies.

When listing all activations, you can control paging with the -Page and -Size parameters. When listing v2 policy activations, you can additionally filter them by network and property name.

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

-ActivationID

Identifies the policy activation.

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

-Network

Returns only activations for the selected network, either staging or prod. This has no effect on shared policies.

Type: String
Parameter Sets: all
Aliases:
Accepted values: prod, staging

Required: False
Position: Named
Default value: None
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

-PropertyName

Returns only activations for the selected property. This has no effect on shared policies.

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