diff --git a/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.Help.pshproj b/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.Help.pshproj index fb5c384d187e..0c7eeb147469 100644 --- a/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.Help.pshproj +++ b/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.Help.pshproj @@ -409,8 +409,8 @@ true/false WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -421,8 +421,8 @@ true/false Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -644,8 +644,8 @@ true/false Get-AzureRmApiManagementCertificate - Gets all or specific certificates. - Gets all or specific certificates. + Gets API Management certificates configured for authentication with backend. + The Get-AzureRmApiManagementCertificate cmdlet gets all Azure API Management certificates or certificates that you specify which are configured for Authentication with the Backend. @@ -710,8 +710,8 @@ true/false WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -722,8 +722,8 @@ true/false Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -734,13 +734,13 @@ true/false - Example 1 + Example 1: Get all certificates Get-AzureRmApiManagementCertificate –Context $apimContext Get all certificates. - Example 2 + Example 2: Get a certificate by its ID Get-AzureRmApiManagementCertificate –Context $apimContext –CertificateId 0123456789 Get specific certificate. @@ -1095,8 +1095,8 @@ true/false WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -1107,8 +1107,8 @@ true/false Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -2166,8 +2166,8 @@ Imported API New-AzureRmApiManagementCertificate - Creates new certificate. - Creates new certificate. + Creates an API Management certificate for authentication with backend. + The New-AzureRmApiManagementCertificate cmdlet creates an Azure API Management certificate which can be configured for authentication with backend. @@ -2260,7 +2260,7 @@ Imported API - Example 1 + Example 1: Create and upload a certificate New-AzureRmApiManagementCertificate –Context $apimContext –PfxFilePath 'C:\contoso\certificates\apimanagement.pfx' –PfxPassword 1111 Create/upload new certificate. @@ -3137,8 +3137,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -3149,8 +3149,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -3354,8 +3354,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -3366,8 +3366,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -3391,8 +3391,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Remove-AzureRmApiManagementCertificate - Deletes existing certificate. - Deletes existing certificate. + Removes an API Management certificate configured for authentication with backend. + The Remove-AzureRmApiManagementCertificate cmdlet removes an Azure API Management certificate. @@ -3474,8 +3474,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -3486,8 +3486,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -3594,8 +3594,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -3606,8 +3606,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -3724,8 +3724,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -3736,8 +3736,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -3868,8 +3868,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -3880,8 +3880,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -4015,8 +4015,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -4027,8 +4027,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -4232,8 +4232,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -4244,8 +4244,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -4361,8 +4361,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -4373,8 +4373,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -4905,8 +4905,8 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Set-AzureRmApiManagementCertificate - Sets certificate data. - Sets certificate data. + Modifies an API Management certificate which is configured for authentication with backend. + The Set-AzureRmApiManagementCertificate cmdlet modifies an Azure API Management certificate which is configured for authentication with backend. @@ -6402,8 +6402,8 @@ New-AzureRmApiManagementProperty -Context $apimContext -PropertyId 123 -Name pro WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -6414,8 +6414,8 @@ New-AzureRmApiManagementProperty -Context $apimContext -PropertyId 123 -Name pro Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -6522,8 +6522,8 @@ New-AzureRmApiManagementProperty -Context $apimContext -PropertyId 123 -Name pro WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -6534,8 +6534,8 @@ New-AzureRmApiManagementProperty -Context $apimContext -PropertyId 123 -Name pro Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -7122,8 +7122,8 @@ Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId 123 -Tags $ta WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -7134,8 +7134,8 @@ Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId 123 -Tags $ta Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -7520,8 +7520,8 @@ OpenId Connect Provider. WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -7532,8 +7532,8 @@ OpenId Connect Provider. Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -7646,8 +7646,8 @@ OpenId Connect Provider. WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -7658,8 +7658,8 @@ OpenId Connect Provider. Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -8016,8 +8016,8 @@ OpenId Connect Provider. WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -8028,8 +8028,8 @@ OpenId Connect Provider. Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -8127,8 +8127,8 @@ OpenId Connect Provider. WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -8139,8 +8139,8 @@ OpenId Connect Provider. Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -8265,8 +8265,8 @@ OpenId Connect Provider. WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -8277,8 +8277,8 @@ OpenId Connect Provider. Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf diff --git a/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.xml b/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.xml index 2409e8824dd7..134d0959a501 100644 --- a/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.xml +++ b/src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.xml @@ -1452,7 +1452,7 @@ true/false Get-AzureRmApiManagementCertificate - Gets all or specific certificates. + Gets API Management certificates configured for authentication with backend. @@ -1462,7 +1462,7 @@ true/false - Gets all or specific certificates. + The Get-AzureRmApiManagementCertificate cmdlet gets all Azure API Management certificates or certificates that you specify which are configured for Authentication with the Backend. @@ -1657,7 +1657,7 @@ true/false - -------------------------- Example 1 -------------------------- + -------------------------- Example 1: Get all certificates -------------------------- PS C:\> @@ -1677,7 +1677,7 @@ true/false - -------------------------- Example 2 -------------------------- + -------------------------- Example 2: Get a certificate by its ID -------------------------- PS C:\> @@ -5250,7 +5250,7 @@ Imported API New-AzureRmApiManagementCertificate - Creates new certificate. + Creates an API Management certificate for authentication with backend. @@ -5260,7 +5260,7 @@ Imported API - Creates new certificate. + The New-AzureRmApiManagementCertificate cmdlet creates an Azure API Management certificate which can be configured for authentication with backend. @@ -5474,7 +5474,7 @@ Imported API - -------------------------- Example 1 -------------------------- + -------------------------- Example 1: Create and upload a certificate -------------------------- PS C:\> @@ -7690,7 +7690,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Remove-AzureRmApiManagementCertificate - Deletes existing certificate. + Removes an API Management certificate configured for authentication with backend. @@ -7700,7 +7700,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope - Deletes existing certificate. + The Remove-AzureRmApiManagementCertificate cmdlet removes an Azure API Management certificate. @@ -10702,7 +10702,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope Set-AzureRmApiManagementCertificate - Sets certificate data. + Modifies an API Management certificate which is configured for authentication with backend. @@ -10712,7 +10712,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope - Sets certificate data. + The Set-AzureRmApiManagementCertificate cmdlet modifies an Azure API Management certificate which is configured for authentication with backend. @@ -12951,7 +12951,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope PsApiManagementContext - + LoggerId Identifier of a logger. If specified will try to find logger by the identifier. This parameter is optional. @@ -13011,7 +13011,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope - + LoggerId Identifier of a logger. If specified will try to find logger by the identifier. This parameter is optional. @@ -17047,7 +17047,7 @@ OpenId Connect Provider. PsApiManagementContext - + Type Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional. @@ -17107,7 +17107,7 @@ OpenId Connect Provider. - + Type Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional. diff --git a/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.Help.pshproj b/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.Help.pshproj index cd47fa3f6174..9ba450d99fd4 100644 --- a/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.Help.pshproj +++ b/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.Help.pshproj @@ -536,7 +536,7 @@ Update-AzureRmApiManagementDeployments - New-AzureRmApiManagement -ResourceGroupName <String> -Name <String> -Location <String> -Organization <String> -AdminEmail <String> [-Sku <Nullable`1[PsApiManagementSku]>] [-Capacity <Nullable`1[Int32]>] [-VpnType <PsApiManagementVpnType>] [-VirtualNetwork <PsApiManagementVirtualNetwork>] [-Tags <Dictionary`2[String]>] [-AdditionalRegions <PsApiManagementRegion[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] + New-AzureRmApiManagement -ResourceGroupName <String> -Name <String> -Location <String> -Organization <String> -AdminEmail <String> [-Sku <Nullable`1[PsApiManagementSku]> {Developer | Standard | Premium} ] [-Capacity <Nullable`1[Int32]>] [-VpnType <PsApiManagementVpnType> {None | External | Internal} ] [-VirtualNetwork <PsApiManagementVirtualNetwork>] [-Tags <Dictionary`2[String]>] [-AdditionalRegions <PsApiManagementRegion[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] @@ -584,6 +584,8 @@ Update-AzureRmApiManagementDeployments System.Management.Automation.ParameterAttribute System.Management.Automation.ValidateNotNullOrEmptyAttribute + System.Management.Automation.ValidateLengthAttribute + System.Management.Automation.ValidatePatternAttribute The originating e-mail address for all e-mail notifications sent from the API Management system. @@ -593,6 +595,8 @@ Update-AzureRmApiManagementDeployments Sku System.Management.Automation.ParameterAttribute + System.Management.Automation.ValidateSetAttribute + System.Management.Automation.PSDefaultValueAttribute The tier of the Azure API Management service. Valid values are Developer, Standard and Premium . Default value is Developer @@ -602,6 +606,8 @@ Update-AzureRmApiManagementDeployments Capacity System.Management.Automation.ParameterAttribute + System.Management.Automation.ValidateRangeAttribute + System.Management.Automation.PSDefaultValueAttribute Sku capacity of the Azure API Management service. Default value is 1. @@ -620,6 +626,8 @@ Update-AzureRmApiManagementDeployments VpnType System.Management.Automation.ParameterAttribute + System.Management.Automation.ValidateSetAttribute + System.Management.Automation.PSDefaultValueAttribute Virtual Network Type of the ApiManagement Deployment. Valid Values are @@ -966,8 +974,8 @@ Update-AzureRmApiManagementDeployment –ResourceGroupName ContosoGroup –Name WhatIf - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute wi @@ -978,8 +986,8 @@ Update-AzureRmApiManagementDeployment –ResourceGroupName ContosoGroup –Name Confirm - System.Management.Automation.AliasAttribute System.Management.Automation.ParameterAttribute + System.Management.Automation.AliasAttribute cf @@ -1472,13 +1480,13 @@ Set-AzureApiHostnames -Name ContosoApi -ResourceGroupName Contoso –PortalHostn - Example 1 + Example 1: Update a deployment of an ApiManagement instance PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName Contoso -Name ContosoApi –Sku “Standard” –Capacity 3 Command to update deployment of an ApiManagement to 3 unit ‘Standard’. - Example 2 + Example 2: Get an ApiManagement instance and rescale it $apiManagement = Get-AzureRmApiManagement –ResourceGroupName Contoso –Name ContosoApi $apiManagement.Sku = “Premium” $apiManagement.Capacity = 5 @@ -1488,6 +1496,39 @@ Update-AzureRmApiManagementDeployment –ApiManagement $apiManagement Script to get an ApiManagement, scale to 5 ‘Premium’ units and add additional 3 unit ‘Premium’ region. + + Example 3: Move API Management instance inside a Virtual Network + PS C:\># Create a Virtual Network Object +PS C:\>$virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "North Central US" -SubnetResourceId +"/subscriptions/20010444-2b48-4245-a95c-090db6312d5f/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNe +tworks/contosoVnet/subnets/default" + +PS C:\># Get the service +PS C:\>$service = Get-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "contosoapim" + +PS C:\>$service.VirtualNetwork = $virtualNetwork +PS C:\>$service.VpnType = "External" + +PS C:\># Update the Deployment with Virtual Network +PS C:\>Update-AzureRmApiManagementDeployment -ApiManagement $service + + This example moves an existing API Management deployment inside a Virtual Network configures external *VpnType* + + + + Example 4: Update deployment (external VNET) + PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" + PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "External" + This command updates an existing API Management deployment and joins to an external *VpnType*. + + + + Example 5: Update deployment (internal VNET) + PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" + PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "Internal" + This command updates an existing API Management deployment and joins to an internal VpnType. + + @@ -1611,7 +1652,7 @@ Update-AzureRmApiManagementDeployment –ApiManagement $apiManagement New-AzureRmApiManagementRegion -Location <String> [-Capacity <Nullable`1[Int32]>] [-VirtualNetwork <PsApiManagementVirtualNetwork>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] - + Location System.Management.Automation.ParameterAttribute @@ -1621,7 +1662,7 @@ Update-AzureRmApiManagementDeployment –ApiManagement $apiManagement Location of the additional deployment region. - + Capacity System.Management.Automation.ParameterAttribute diff --git a/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.xml b/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.xml index c07bbf589eed..616f6f1798bd 100644 --- a/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.xml +++ b/src/ResourceManager/ApiManagement/Commands.ApiManagement/Microsoft.Azure.Commands.ApiManagement.dll-help.xml @@ -36,7 +36,7 @@ Sku - Tier of the deployment region. Valid and Default value is Premium. + Tier of the deployment region. Valid values are Developer, Standard and Premium. Default value is Developer. Nullable`1[PsApiManagementSku] @@ -3043,7 +3043,7 @@ Set-AzureApiHostnames -Name ContosoApi -ResourceGroupName Contoso –PortalHostn - -------------------------- Example 1 -------------------------- + -------------------------- Example 1: Update a deployment of an ApiManagement instance -------------------------- PS C:\> @@ -3063,7 +3063,7 @@ Set-AzureApiHostnames -Name ContosoApi -ResourceGroupName Contoso –PortalHostn - -------------------------- Example 2 -------------------------- + -------------------------- Example 2: Get an ApiManagement instance and rescale it -------------------------- PS C:\> @@ -3087,6 +3087,81 @@ Update-AzureRmApiManagementDeployment –ApiManagement $apiManagement + + -------------------------- Example 3: Move API Management instance inside a Virtual Network -------------------------- + + PS C:\> + + PS C:\># Create a Virtual Network Object +PS C:\>$virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "North Central US" -SubnetResourceId +"/subscriptions/20010444-2b48-4245-a95c-090db6312d5f/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNe +tworks/contosoVnet/subnets/default" + +PS C:\># Get the service +PS C:\>$service = Get-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "contosoapim" + +PS C:\>$service.VirtualNetwork = $virtualNetwork +PS C:\>$service.VpnType = "External" + +PS C:\># Update the Deployment with Virtual Network +PS C:\>Update-AzureRmApiManagementDeployment -ApiManagement $service + + + This example moves an existing API Management deployment inside a Virtual Network configures external *VpnType* + + + + + + + + + + + + + + -------------------------- Example 4: Update deployment (external VNET) -------------------------- + + PS C:\> + + PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" + PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "External" + + This command updates an existing API Management deployment and joins to an external *VpnType*. + + + + + + + + + + + + + + -------------------------- Example 5: Update deployment (internal VNET) -------------------------- + + PS C:\> + + PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" + PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "Internal" + + This command updates an existing API Management deployment and joins to an internal VpnType. + + + + + + + + + + + + @@ -3305,14 +3380,14 @@ Update-AzureRmApiManagementDeployment –ApiManagement $apiManagement New-AzureRmApiManagementRegion - + Location Location of the additional deployment region. String - + Capacity Sku capacity of the Azure API Management service additional region. Default value is 1. @@ -3343,7 +3418,7 @@ Update-AzureRmApiManagementDeployment –ApiManagement $apiManagement - + Location Location of the additional deployment region. @@ -3355,7 +3430,7 @@ Update-AzureRmApiManagementDeployment –ApiManagement $apiManagement - + Capacity Sku capacity of the Azure API Management service additional region. Default value is 1.