< Back
Remove-AzureRmApiManagementRegion
Post
NAME Remove-AzureRmApiManagementRegion
SYNOPSIS
Removes an existing deployment region from PsApiManagement instance.
SYNTAX
Remove-AzureRmApiManagementRegion -ApiManagement <PsApiManagement> [-DefaultProfile <IAzureContextContainer>] -Location <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 .
PARAMETERS
-ApiManagement <PsApiManagement>
Specifies the PsApiManagement instance that this cmdlet removes the additional deployment region from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
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
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PsApiManagement
Parameter 'ApiManagement' accepts value of type 'PsApiManagement' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mentregion
Add-AzureRmApiManagementRegion
Update-AzureRmApiManagementRegion
SYNOPSIS
Removes an existing deployment region from PsApiManagement instance.
SYNTAX
Remove-AzureRmApiManagementRegion -ApiManagement <PsApiManagement> [-DefaultProfile <IAzureContextContainer>] -Location <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 .
PARAMETERS
-ApiManagement <PsApiManagement>
Specifies the PsApiManagement instance that this cmdlet removes the additional deployment region from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
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
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PsApiManagement
Parameter 'ApiManagement' accepts value of type 'PsApiManagement' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mentregion
Add-AzureRmApiManagementRegion
Update-AzureRmApiManagementRegion