Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-AzureApiManagementRegion

Remove-AzureApiManagementRegion

microsoft.azure.commands.apimanagement.dll

Synopsis

Removes existing deployment region from PsApiManagement instance.

Syntax

Remove-AzureApiManagementRegion [-ApiManagement] [-Location] [-Profile] [<CommonParameters>]

Detailed Description

Remove-AzureApiManagementRegion cmdlet removes instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion from collection of AdditionalRegions of provided instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. This cmdlet does not modifies deployment by itself but updates instance of PsApiManagement in-memory. Related cmdltes are: Update-AzureApiManagementRegion and Add-AzureApiManagementRegion. To actually update a deployment of an API Management pass the modified PsApiManagementInstance to Update-AzureApiManagement cmdlet.

Parameters

-ApiManagement <PsApiManagement>

PsApiManagement instance to remove additional deployment region from.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Location <String>

Location of the removing region.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Profile <AzureProfile>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

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

Remove a region from the PsApiManagement instance.

PS C:\> Remove-AzureApiManagementRegion –ApiManagement $apiManagement -Location “East US”

-------------------------- Example 2 --------------------------

Script to get a PsApiManagement, remove a region and update deployment with piping.

PS C:\> Get-AzureApiManagement –ResourceGroupName Contoso –Name ContosoApi | Remove-AzureApiManagementRegion -Location “East US” | Update-AzureApiManagementDeployment