Edit

Share via

Set-AzureReservedIPAssociation

  • Reference
Module:
Azure

Associates a reserved IP address with an existing virtual machine or cloud service.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Set-AzureReservedIPAssociation
   [-ReservedIPName] <String>
   [-ServiceName] <String>
   [[-VirtualIPName] <String>]
   [[-Slot] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Set-AzureReservedIPAssociation cmdlet associates a reserved IP address with the Virtual IP address (VIP) of a running virtual machine or cloud service. The reserved IP address must not be in use at the time of invocation of this cmdlet, and must be in the same region as the virtual machine or cloud service.

The operation takes about 30 seconds to complete, after which the virtual machine or service is accessible using the reserved IP address.

Examples

Example 1: Set a reserved IP association

PS C:\> Set-AzureReservedIPAssociation -ReservedIPName "ResIp14" -ServiceName "PipTestWestEurope"

This command assigns the reserved IP address named ResIp14 to the service PipTestWestEurope. ResIp14 is a reserved IP in the West Europe region.

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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Specifies an information variable.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReservedIPName

Specifies the name of the reserved IP address to associate with a virtual machine or service.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServiceName

Specifies the name of the service that has the deployment with which to associate the reserved IP address.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Slot

Specifies the deployment slot. The acceptable values for this parameter are:

  • Staging
  • Production
Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VirtualIPName

Specifies the name of an existing VIP to associate with a reserved IP. See Add-AzureVirtualIP to add VIPs to your cloud service.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext