Policy version activation

New-CloudletPolicyActivation

Synopsis

Activate a policy version.

Syntax

__AllParametersets (Default)

New-CloudletPolicyActivation -PolicyID <Int32> -Version <String> -Network <String> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

legacy

New-CloudletPolicyActivation -PolicyID <Int32> -Version <String> [-Legacy] [-AdditionalPropertyNames <String>]
 -Network <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Activates a Cloudlet policy version. Use the -Legacy switch to specify v2 policies; otherwise, the command will apply only to v3 policies.

When using v2 policies, you can also provide additional properties with the -AdditionalPropertyNames parameter. You can also specify multiple properties as a comma-separated string.

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

-AdditionalPropertyNames

An array of one or more additional properties that you want to activate with the Cloudlet policy. Once activated, the property and policy are permanently linked.

Type: String
Parameter Sets: legacy
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: legacy
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: STAGING, PRODUCTION

Required: True
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

-Version

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

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
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