Schema

Get-CloudletSchema

Synopsis

Get a schema.

Syntax

all (Default)

Get-CloudletSchema -CloudletType <String> [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

single

Get-CloudletSchema -SchemaName <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all Cloudlet schemas or returns a specific schema by its Cloudlet type. The -CloudletType parameter is translated automatically from the product name, for example, Phased Release, to its API-specific type code, for example, CD.

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

-CloudletType

The name of the cloudlet type, for example, Phased Release. This is translated to the correct 2- or 3-letter code automatically.

Type: String
Parameter Sets: all
Aliases:
Accepted values: API Prioritization, Application Load Balancer, Audience Segmentation, Edge Redirector, Forward Rewrite, Phased Release, Request Control, Visitor Prioritization

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

-SchemaName

The name of the JSON schema file. JSON schema filenames include:

  • create-policy.json
  • update-policy.json
  • clone-policy.json
  • create-nimbus_policy_version-{cloudletCode}-1.0.json
  • update-nimbus_policy_version-{cloudletCode}-1.0.json
  • match_rule-{cloudletCode}-1.0.json

The value for cloudletCode is either ALB, AP, AS, CD, ER, FR, IG, or VP.

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

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

Related links