Merge pull request #10023 from solankisamir/docfix

Update doc to remove deprecated cmdlet Update-AzApiManagementDeployment references

Author: markcowl

src/ApiManagement/ApiManagement/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 ## Upcoming Release
 * Update `-Format` parameter description in `Set-AzApiManagementPolicy` reference documentation
+* Removed references of deprecated cmdlet `Update-AzApiManagementDeployment` from reference documentation. Use `Set-AzApiManagement` instead.
 
 ## Version 1.3.0
 * Fixed miscellaneous typos across module

src/ApiManagement/ApiManagement/help/Add-AzApiManagementRegion.md

@@ -22,7 +22,7 @@ Add-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String> [-
 ## DESCRIPTION
 The **Add-AzApiManagementRegion** 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-AzApiManagementDeployment.
+To update a deployment of an API Management pass the modified **PsApiManagement** Instance to Set-AzApiManagement.
 
 ## EXAMPLES
 
@@ -34,8 +34,10 @@ PS C:\>Add-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East U
 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-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" | Add-AzApiManagementRegion -Location "East US" -Sku "Premium" -Capacity 2 | Update-AzApiManagementDeployment
+```powershell
+PS C:\>$service = Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
+PS C:\>$service = Add-AzApiManagementRegion -ApiManagement $service -Location $secondarylocation -VirtualNetwork $additionalRegionVirtualNetwork
+PS C:\>$service = Set-AzApiManagement -InputObject $service -PassThru 
 ```
 
 This command gets a **PsApiManagement** object, adds two premium SKU units for the region named East US, and then updates deployment.
@@ -159,6 +161,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 [Update-AzApiManagementRegion](./Update-AzApiManagementRegion.md)
 
-[Update-AzApiManagementDeployment](./Update-AzApiManagementDeployment.md)
+[Set-AzApiManagement](./Set-AzApiManagement.md)
 
 

src/ApiManagement/ApiManagement/help/New-AzApiManagementVirtualNetwork.md

@@ -20,30 +20,28 @@ New-AzApiManagementVirtualNetwork -SubnetResourceId <String> [-DefaultProfile <I
 
 ## DESCRIPTION
 The **New-AzApiManagementVirtualNetwork** cmdlet is a helper command to create an instance of **PsApiManagementVirtualNetwork**.
-This command is used with **Update-AzApiManagementDeployment** cmdlet.
+This command is used with **Set-AzApiManagement** and **New-AzApiManagement** cmdlet.
 
 ## EXAMPLES
 
-### Example 1: Create a virtual network
+### Example 1: Create a virtual network and Update an existing APIM service into the VNET
+```powershell
+PS C:\> $virtualNetwork = New-AzApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
+PS C:\> $apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi"
+PS C:\> $apim.VpnType = "External"
+PS C:\> $apim.VirtualNetwork = $virtualNetwork
+PS C:\> Set-AzApiManagement -InputObject $apim
 ```
-PS C:\>$vnetName = "myvnet"
-PS C:\>$subnetName = "default"
-PS C:\>$subnet = New-AzVirtualNetworkSubnetConfig -Name $subnetName -AddressPrefix 10.0.1.0/24
-PS C:\>$vnet = New-AzVirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroupName -Location $location -AddressPrefix 10.0.0.0/16 -Subnet $subnet
 
-# Create a Virtual Network Object
-PS C:\>$virtualNetwork = New-AzApiManagementVirtualNetwork -Location $location -SubnetResourceId $vnet.Subnets[0].Id
+This example creates a virtual network and then calls the **Set-AzApiManagement** cmdlet.
 
-# Get the service
-PS C:\>$service = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName    
-PS C:\>$service.VirtualNetwork = $virtualNetwork
-PS C:\>$service.VpnType = "External"
-
-# Update the Deployment with Virtual Network
-PS C:\>Update-AzApiManagementDeployment -ApiManagement $service
+### Example 2: Create an API Management service for an external virtual network
+```powershell
+PS C:\> $virtualNetwork = New-AzApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
+PS C:\> New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail [email protected] -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium"
 ```
 
-This example creates a virtual network and then calls the **Update-AzApiManagementDeployment** cmdlet.
+This example creates a new APIM service into a Virtual Network in `External` mode
 
 ## PARAMETERS
 
@@ -92,5 +90,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## RELATED LINKS
 
-[Update-AzApiManagementDeployment](./Update-AzApiManagementDeployment.md)
+[Set-AzApiManagement](./Set-AzApiManagement.md)
+[New-AzApiManagement](./New-AzApiManagement.md)
 

src/ApiManagement/ApiManagement/help/Remove-AzApiManagementRegion.md

@@ -21,7 +21,7 @@ Remove-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String>
 ## DESCRIPTION
 The **Remove-AzApiManagementRegion** cmdlet removes instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** from a collection of **AdditionalRegions** of provided the instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**.
 This cmdlet does not modify deployment by itself but updates the instance of **PsApiManagement** in-memory.
-To update a deployment of an API Management, pass the modified **PsApiManagementInstance** to **Update-AzApiManagement**.
+To update a deployment of an API Management, pass the modified **PsApiManagementInstance** to **Set-AzApiManagement**.
 
 ## EXAMPLES
 
@@ -34,7 +34,7 @@ This command removes the region named East US from the **PsApiManagement** insta
 
 ### Example 2: Remove a region from a PsApiManagement instance using a series of commands
 ```
-PS C:\>Get-AzApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzApiManagementRegion -Location "East US" | Update-AzApiManagementDeployment
+PS C:\>Get-AzApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzApiManagementRegion -Location "East US" | Set-AzApiManagement
 ```
 
 This first command gets an instance of **PsApiManagement** from the resource group named Contoso named ContosoApi.

src/ApiManagement/ApiManagement/help/Update-AzApiManagementRegion.md

@@ -22,20 +22,18 @@ Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String>
 ## DESCRIPTION
 The **Update-AzApiManagementRegion** cmdlet updates an existing instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** in a collection of **AdditionalRegions** objects of a provided instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**.
 This cmdlet does not deploy anything but updates an instance of **PsApiManagement** in-memory.
-To update a deployment of an API Management use the modified **PsApiManagementInstance** to the Update-AzApiManagementDeployment cmdlet.
+To update a deployment of an API Management use the modified **PsApiManagementInstance** to the Set-AzApiManagement cmdlet.
 
 ## EXAMPLES
 
 ### Example 1: Increases capacity of Additional Region in a PsApiManagement instance
 ```powershell
 PS C:\>$apimService = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName
 PS C:\>$apimService = Update-AzApiManagementRegion -ApiManagement $apimService -Location "North Central US" -Capacity 2 -Sku Premium
-
-# Set the ApiManagement service and Enable Msi idenity on the service
-PS C:\>$updatedService = Set-AzApiManagement -InputObject $apimService -PassThru
+PS C:\>$apimService = Set-AzApiManagement -InputObject $apimService -PassThru
 ```
 
-This command gets the API Management Premium SKU service, having regions in South Central US and North Central US. It then increases the Capacity of the North Central US region to 2 using the **Update-AzApiManagementRegion**. The next cmdlet Set-AzApiManagement applies the configuration change to the Api Management service.
+This command gets the API Management Premium SKU service, having regions in South Central US and North Central US. It then increases the Capacity of the North Central US region to 2 using the **Set-AzApiManagement**. The next cmdlet **Set-AzApiManagement** applies the configuration change to the Api Management service.
 
 ## PARAMETERS
 
@@ -165,4 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 [Remove-AzApiManagementRegion](./Remove-AzApiManagementRegion.md)
 
-[Update-AzApiManagementDeployment](./Update-AzApiManagementDeployment.md)
+[Set-AzApiManagement](./Set-AzApiManagement.md)