Remove-​Azure​Rm​Api​Management​Region

Removes an existing deployment region from PsApiManagement instance.

Syntax

Remove-AzureRmApiManagementRegion
      -ApiManagement <PsApiManagement>
      -Location <String>
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]

Description

The Remove-AzureRmApiManagementRegion cmdlet removes instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion from a collection of AdditionalRegions of provided the instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. This cmdlet does not modify deployment by itself but updates the instance of PsApiManagement in-memory. To update a deployment of an API Management, pass the modified PsApiManagementInstance to Update-AzureRmApiManagement.

Examples

Example 1: Remove a region from a PsApiManagement instance

PS C:\>Remove-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US"

This command removes the region named East US from the PsApiManagement instance.

Example 2: Remove a region from a PsApiManagement instance using a series of commands

PS C:\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzureRmApiManagementRegion -Location "East US" | Update-AzureRmApiManagementDeployment

This first command gets an instance of PsApiManagement from the resource group named Contoso named ContosoApi. The final command then removes the region named East US from that instance then updates the deployment.

Required Parameters

-ApiManagement

Specifies the PsApiManagement instance that this cmdlet removes the additional deployment region from.

Type:PsApiManagement
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Location

Specifies the location of the region that this cmdlet removes.Valid values are: - North Central US

  • South Central US
  • Central US
  • West Europe
  • North Europe
  • West US
  • East US
  • East US 2
  • Japan East
  • Japan West
  • Brazil South
  • Southeast Asia
  • East Asia
  • Australia East
  • Australia Southeast
Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-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