< Back
New-AzureRmApiManagement
Post
NAME New-AzureRmApiManagement
SYNOPSIS
Creates an API Management deployment.
SYNTAX
New-AzureRmApiManagement [-AdditionalRegions <PsApiManagementRegion[]>] -AdminEmail <String> [-Capacity <Int32>] [-DefaultProfile
<IAzureContextContainer>] -Location <String> -Name <String> -Organization <String> -ResourceGroupName <String> [-Sku {Developer | Standard |
Premium}] [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] [-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-VpnType {None | External | Internal}] [<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagement cmdlet creates an API Management deployment in Azure API Management.
PARAMETERS
-AdditionalRegions <PsApiManagementRegion[]>
Additional deployment regions of Azure API Management.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AdminEmail <String>
Specifies the originating email address for all notifications that the API Management system sends.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Capacity <Int32>
Specifies the SKU capacity of the Azure API Management service. The default is one (1).
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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 to create the 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
-Name <String>
Specifies a name for the API Management deployment.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Organization <String>
Specifies the name of an organization. API Management uses this address in the developer portal in email notifications.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the of resource group under which this cmdlet creates an API Management deployment.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <PsApiManagementSku>
Specifies the tier of the API Management service. Valid values are:
- Developer
- Standard
- Premium
The default is Developer.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>
Tags dictionary.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetwork <PsApiManagementVirtualNetwork>
Virtual Network Configuration of master Azure API Management deployment region.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VpnType <PsApiManagementVpnType>
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)
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
NOTES
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-3726
ab15d0e2/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-3726
ab15d0e2/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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... management
Backup-AzureRmApiManagement
Get-AzureRmApiManagement
Remove-AzureRmApiManagement
Restore-AzureRmApiManagement
SYNOPSIS
Creates an API Management deployment.
SYNTAX
New-AzureRmApiManagement [-AdditionalRegions <PsApiManagementRegion[]>] -AdminEmail <String> [-Capacity <Int32>] [-DefaultProfile
<IAzureContextContainer>] -Location <String> -Name <String> -Organization <String> -ResourceGroupName <String> [-Sku {Developer | Standard |
Premium}] [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] [-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-VpnType {None | External | Internal}] [<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagement cmdlet creates an API Management deployment in Azure API Management.
PARAMETERS
-AdditionalRegions <PsApiManagementRegion[]>
Additional deployment regions of Azure API Management.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AdminEmail <String>
Specifies the originating email address for all notifications that the API Management system sends.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Capacity <Int32>
Specifies the SKU capacity of the Azure API Management service. The default is one (1).
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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 to create the 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
-Name <String>
Specifies a name for the API Management deployment.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Organization <String>
Specifies the name of an organization. API Management uses this address in the developer portal in email notifications.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the of resource group under which this cmdlet creates an API Management deployment.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <PsApiManagementSku>
Specifies the tier of the API Management service. Valid values are:
- Developer
- Standard
- Premium
The default is Developer.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>
Tags dictionary.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetwork <PsApiManagementVirtualNetwork>
Virtual Network Configuration of master Azure API Management deployment region.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VpnType <PsApiManagementVpnType>
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)
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
NOTES
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-3726
ab15d0e2/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-3726
ab15d0e2/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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... management
Backup-AzureRmApiManagement
Get-AzureRmApiManagement
Remove-AzureRmApiManagement
Restore-AzureRmApiManagement