Endpoint details

Expand-APIEndpointDetails

Synopsis

Expand API details.

Syntax

Expand-APIEndpointDetails [[-APIEndpointName] <String>] [[-APIEndpointID] <String>] [[-VersionNumber] <String>]
 [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [[-UnusedArgs] <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

This is an internal function used to retrieve API endpoints and their versions more easily in other commands.

-APIEndpointID

The ID for the endpoint.

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

-APIEndpointName

The name of the endpoint.

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

-AccountSwitchKey

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

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 5
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: 3
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: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UnusedArgs

Remaining arguments.

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

-VersionNumber

The ID for the endpoint version. Defaults to latest.

Type: String
Parameter Sets: (All)
Aliases: CloneVersionNumber

Required: False
Position: 2
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

System.Object

Outputs