Remove-AzureRmApiManagementRegion

Removes an existing deployment region from PsApiManagement instance.

Syntax

Remove-AzureRmApiManagementRegion
      -ApiManagement <PsApiManagement>
      -Location <String>
      [-DefaultProfile <IAzureContextContainer>]
      [<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:Microsoft.Azure.Commands.ApiManagement.Models.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.

Specifies the location of the new deployment region amongst the supported region for Api Management service. To obtain valid locations, use the cmdlet Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations

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

Optional Parameters

-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PsApiManagement

Parameter 'ApiManagement' accepts value of type 'PsApiManagement' from the pipeline

Outputs

Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement