New-​Azure​Rm​Api​Management

Creates an API Management deployment.

Syntax

New-AzureRmApiManagement
   [-AdditionalRegions <PsApiManagementRegion[]>]
   -AdminEmail <String>
   [-Capacity <Int32>]
   -Location <String>
   -Name <String>
   -Organization <String>
   -ResourceGroupName <String>
   [-Sku <PsApiManagementSku>]
   [-Tags <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-VirtualNetwork <PsApiManagementVirtualNetwork>]
   [-VpnType <PsApiManagementVpnType>]
   [<CommonParameters>]

Description

The New-AzureRmApiManagement cmdlet creates an API Management deployment in Azure API Management.

Examples

Example 1: Create a Developer tier API Management service

PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com"

This command creates a Developer tier API Management service. The command specifies the organization and the administrator address. The command does not specify the SKU parameter. Therefore, the cmdlet uses the default value of Developer.

Example 2: Create a Standard tier service that has three units

PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02 -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3

This command creates a Standard tier API Management service that has three units.

Example 3: Create an API Management service for an external virtual network

PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
PS C:\> New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium"

This command creates a Premium-tier API Management service in an Azure virtual network subnet having an external-facing gateway endpoint with a master region in the West US.

Example 4: Create an API Management service for an internal virtual network

PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
PS C:\> New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization "Contoso" -AdminEmail "admin@contoso.com" -VirtualNetwork $virtualNetwork -VpnType "Internal" -Sku "Premium"

This command creates a Premium-tier API Management service in an Azure virtual network subnet having an internal-facing gateway endpoint with a master region in the West US.

Required Parameters

-AdminEmail

Specifies the originating email address for all notifications that the API Management system sends.

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

Specifies the location in which this cmdlet creates an API Management deployment. To obtain valid locations, use the Get-AzureLocation cmdlets.

Valid values are:

  • North Central US
  • South Central US
  • Central US
  • West Europe
  • North Europe
  • West US
  • East US
  • East US 2
  • Japan East
  • Japan West
  • Brazil South
  • Southeast Asia
  • East Asia
  • Australia East
  • Australia Southeast
Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies a name for the API Management deployment.

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

Specifies the name of an organization. API Management uses this address in the developer portal in email notifications.

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

Specifies the name of the of resource group under which this cmdlet creates an API Management deployment.

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

Optional Parameters

-AdditionalRegions

Additional deployment regions of Azure API Management.

Type:PsApiManagementRegion[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Capacity

Specifies the SKU capacity of the Azure API Management service. The default is one (1).

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

Specifies the tier of the API Management service. Valid values are:

  • Developer
  • Standard
  • Premium

The default is Developer.

Type:PsApiManagementSku
Parameter Sets:Developer, Standard, Premium
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Tags

Specifies a dictionary of tags.

Type:System.Collections.Generic.Dictionary`2[System.String,System.String]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VirtualNetwork

Virtual Network Configuration of master Azure API Management deployment region.

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

Virtual Network Type of the ApiManagement Deployment. Valid Values are

  • "None" (Default Value. ApiManagement is not part of any Virtual Network")
  • "External" (ApiManagement Deployment is setup inside a Virtual Network having an Internet Facing Endpoint)
  • "Internal" (ApiManagement Deployment is setup inside a Virtual Network having an Intranet Facing Endpoint)
Type:PsApiManagementVpnType
Parameter Sets:None, External, Internal
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False