Edit

Share via


New-AzApiManagementBackendProxy

Creates a new Backend Proxy Object.

Syntax

Default (Default)

New-AzApiManagementBackendProxy
    -Url <String>
    [-ProxyCredential <PSCredential>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Creates a new Backend Proxy Object which can be piped when creating a new Backend entity.

Examples

Example 1: Create a Backend Proxy In-Memory Object

$secpassword = ConvertTo-SecureString -String "****" -AsPlainText -Force
$proxyCreds = New-Object System.Management.Automation.PSCredential ("foo", $secpassword)
$credential = New-AzApiManagementBackendProxy -Url "http://12.168.1.1:8080" -ProxyCredential $proxyCreds

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

$backend = New-AzApiManagementBackend -Context  $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Proxy $credential -Description "backend with proxy server"

Creates a Backend Proxy Object and sets up Backend

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials used to connect to Backend Proxy. This parameter is optional.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Url

Url of the Proxy server to be used when forwarding calls to Backend. This parameter is required.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

PsApiManagementBackendProxy