Set-​Azure​Rm​Api​Management​Virtual​Networks

Sets the VPN configuration for an API Management Service.

Syntax

Set-AzureRmApiManagementVirtualNetworks
   -ResourceGroupName <String>
   -Name <String>
   [-VirtualNetworks <PsApiManagementVirtualNetwork[]>]
   [-PassThru]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Set-AzureRmApiManagementVirtualNetworks cmdlet sets Virtual Network configuration for an API Management service.

Examples

Example 1: Set virtual networks for an API Management service

PS C:\> Set-AzureRmApiManagementVirtualNetworks -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetworks $VirtualNetworks

This command sets virtual networks for an API Management service.

Required Parameters

-Name

Specifies the name of an API Management service.

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

Specifies the name of the resource group under which the API Management service exists.

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

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VirtualNetworks

Specifies an array of virtual networks configurations. Passing $null will remove the virtual network configuration.

Type:PsApiManagementVirtualNetwork[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False