Endpoint from file

New-APIEndpointFromFile

Synopsis

Syntax

attributes (Default)

New-APIEndpointFromFile -ImportFileFormat <String> -ImportFileSource <String> [-ImportURL <String>]
 [-ImportFileContent <String>] [-Root <String>] -ContractID <String> -GroupID <Int32> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

body

New-APIEndpointFromFile -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Imports an API definition file and creates a new endpoint based on the file content. Optionally, when running this operation, you can specify whether to exclude the request or response body specifications from what's imported.

Parameters

-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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

Type: Object
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ContractID

Filters endpoints to a specific contract. You need to specify this along with a GroupID.

Type: String
Parameter Sets: attributes
Aliases: None
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

-GroupID

Filters endpoints to a specific group. You need to specify this along with a ContractID.

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

-ImportFileContent

The content of the API definition file encoded in Base64. Specify this only if you set the corresponding ImportFileSource to BODY_BASE64.

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

-ImportFileFormat

The format of the API definition file, either raml or swagger. You can import RAML 0.8 files and Swagger 2.0 or 3.0 files.

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: swagger, raml

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ImportFileSource

The location of the API definition file, either URL if you store the file on the web, or BODY_BASE64 if you encode the file contents in the request body.

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: URL, BODY_BASE64

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ImportURL

The URL from which to get the API definition file. Specify this only if you set the corresponding ImportFileSource to URL.

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

-Root

If the import file located at the ImportURL is a ZIP archive, this identifies the API definition's filename within the archive.

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

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