Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AzureApiManagementVirtualNetworks

Set-AzureApiManagementVirtualNetworks

microsoft.azure.commands.apimanagement.dll

Synopsis

Sets VPN configuration for an API Management Service.

Syntax

Set-AzureApiManagementVirtualNetworks [-ResourceGroupName] [-Name] [-VirtualNetworks] [-PassThru] [-Profile] [<CommonParameters>]

Detailed Description

Set-AzureApiManagementVirtualNetworks cmdlet sets Virtual Network configuration for an API Management.

Parameters

-ResourceGroupName <String>

Name of resource group under which API Management exists.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Name of API Management.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-VirtualNetworks <PsApiManagementVirtualNetwork[]>

Virtual networks configuration. Default value is $null. Passing $null will remove virtual network configuration.

Aliases

None

Required?

false

Position

named

Default value

$null

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Sends updated PsApiManagement to pipeline if operation succeeds.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

Set virtual networks for an API Management service

PS C:\> Set-AzureApiManagementVirtualNetworks –ResourceGroupName ContosoGroup –Name ContosoApi -VirtualNetworks $virtualNetworks