Remove-​Azure​Rm​Api​Management​Backend

Removes a Backend.

Syntax

Remove-AzureRmApiManagementBackend
      -BackendId <String>
      -Context <PsApiManagementContext>
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]

Description

Removes a backend specified by the Identifier from the Api Management.

Examples

-------------------------- Example 1 --------------------------

@{paragraph=PS C:\>}

Remove-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -PassThru

Required Parameters

-BackendId

Identifier of existing backend. This parameter is required.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Context

Instance of PsApiManagementContext. This parameter is required.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

If specified will write true in case operation succeeds. This parameter is optional. Default value is false.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

bool