< Back
Add-AzureRmApiManagementRegion
Post
NAME Add-AzureRmApiManagementRegion
SYNOPSIS
Adds new deployment regions to a PsApiManagement instance.
SYNTAX
Add-AzureRmApiManagementRegion -ApiManagement <PsApiManagement> [-Capacity <Int32>] [-DefaultProfile <IAzureContextContainer>] -Location <String>
[-Sku {Developer | Standard | Premium}] [-VirtualNetwork <PsApiManagementVirtualNetwork>] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmApiManagementRegion cmdlet adds new instance of type PsApiManagementRegion to the collection of AdditionalRegions of provided
instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement . This cmdlet does not deploy anything by itself but updates
instance of PsApiManagement in-memory. To update a deployment of an API Management pass the modified PsApiManagement Instance to
Update-AzureRmApiManagementDeployment.
PARAMETERS
-ApiManagement <PsApiManagement>
Specifies the PsApiManagement instance that this cmdlet adds additional deployment regions to.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Capacity <Int32>
Specifies the SKU capacity of the deployment region.
Required? false
Position? named
Default value None
Accept pipeline input? False
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 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? False
Accept wildcard characters? false
-Sku <PsApiManagementSku>
Specifies the tier of the deployment region. Valid values are:
- Developer
- Standard
- Premium
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VirtualNetwork <PsApiManagementVirtualNetwork>
Specifies a virtual network configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
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
The cmdlet writes updated PsApiManagement * instance to pipeline.
Example 1: Add new deployment regions to a PsApiManagement instance
PS C:\\>Add-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2
This command adds two premium SKU units and the region named East US to the PsApiManagement instance.
Example 2: Add new deployment regions to a PsApiManagement instance and then update deployment
PS C:\\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" | Add-AzureRmApiManagementRegion -Location "East US" -Sku
"Premium" -Capacity 2 | Update-AzureRmApiManagementDeployment
This command gets a PsApiManagement object, adds two premium SKU units for the region named East US, and then updates deployment.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mentregion
Remove-AzureRmApiManagementRegion
Update-AzureRmApiManagementRegion
Update-AzureRmApiManagementDeployment
SYNOPSIS
Adds new deployment regions to a PsApiManagement instance.
SYNTAX
Add-AzureRmApiManagementRegion -ApiManagement <PsApiManagement> [-Capacity <Int32>] [-DefaultProfile <IAzureContextContainer>] -Location <String>
[-Sku {Developer | Standard | Premium}] [-VirtualNetwork <PsApiManagementVirtualNetwork>] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmApiManagementRegion cmdlet adds new instance of type PsApiManagementRegion to the collection of AdditionalRegions of provided
instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement . This cmdlet does not deploy anything by itself but updates
instance of PsApiManagement in-memory. To update a deployment of an API Management pass the modified PsApiManagement Instance to
Update-AzureRmApiManagementDeployment.
PARAMETERS
-ApiManagement <PsApiManagement>
Specifies the PsApiManagement instance that this cmdlet adds additional deployment regions to.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Capacity <Int32>
Specifies the SKU capacity of the deployment region.
Required? false
Position? named
Default value None
Accept pipeline input? False
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 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? False
Accept wildcard characters? false
-Sku <PsApiManagementSku>
Specifies the tier of the deployment region. Valid values are:
- Developer
- Standard
- Premium
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VirtualNetwork <PsApiManagementVirtualNetwork>
Specifies a virtual network configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
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
The cmdlet writes updated PsApiManagement * instance to pipeline.
Example 1: Add new deployment regions to a PsApiManagement instance
PS C:\\>Add-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2
This command adds two premium SKU units and the region named East US to the PsApiManagement instance.
Example 2: Add new deployment regions to a PsApiManagement instance and then update deployment
PS C:\\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" | Add-AzureRmApiManagementRegion -Location "East US" -Sku
"Premium" -Capacity 2 | Update-AzureRmApiManagementDeployment
This command gets a PsApiManagement object, adds two premium SKU units for the region named East US, and then updates deployment.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mentregion
Remove-AzureRmApiManagementRegion
Update-AzureRmApiManagementRegion
Update-AzureRmApiManagementDeployment