New-AzureRmApiManagementRegion

NAME New-AzureRmApiManagementRegion



SYNOPSIS

Creates an instance of PsApiManagementRegion.





SYNTAX

New-AzureRmApiManagementRegion [-Capacity <Int32>] [-DefaultProfile <IAzureContextContainer>] -Location <String> [-VirtualNetwork

<PsApiManagementVirtualNetwork>] [<CommonParameters>]





DESCRIPTION

Helper command to create an instance of PsApiManagementRegion. This command is to be used with New-AzureRmApiManagement command.





PARAMETERS

-Capacity <Int32>

Sku capacity of the Azure API Management service additional region. Default value is 1.



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



-VirtualNetwork <PsApiManagementVirtualNetwork>

Virtual Network Configuration of Azure API Management deployment region. Default value is $null.



Required? false

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

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion







NOTES









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



$apimRegion = New-AzureRmApiManagementRegion -Location "Central US"



$additionalRegions = @($apimRegion)



New-AzureRmApiManagement -ResourceGroupName ContosoGroup -Location "West US" -Name ContosoApi -Organization Contoso -AdminEmail admin@contoso.com

-AdditionalRegions $additionalRegions -Sku "Premium"









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



$apimRegionVirtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "Central US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8

-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/centralusvirtualNetwork/subnets/backendSubnet"



$apimRegion = New-AzureRmApiManagementRegion -Location "Central US" -VirtualNetwork $apimRegionVirtualNetwork



$additionalRegions = @($apimRegion)



$virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc2-4174-a1e8-3726ab15d0e2

/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"



New-AzureRmApiManagement -ResourceGroupName ContosoGroup -Location "West US" -Name ContosoApi -Organization Contoso -AdminEmail admin@contoso.com

-AdditionalRegions $additionalRegions -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium"



Creates an ApiManagement service of External VpnType in West US Region, with an Additional Region in Central US.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... mentregion