Load Balancers - Swap Public Ip Addresses

Swaps VIPs between two load balancers.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/setLoadBalancerFrontendPublicIpAddresses?api-version=2023-06-01

URI Parameters

Name In Required Type Description
location
path True

string

The region where load balancers are located at.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Request Body

Name Type Description
frontendIPConfigurations

LoadBalancerVipSwapRequestFrontendIPConfiguration[]

A list of frontend IP configuration resources that should swap VIPs.

Responses

Name Type Description
200 OK

Request successful.

202 Accepted

Accepted and the operation will complete asynchronously.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Swap VIPs between two load balancers.

Sample Request

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/setLoadBalancerFrontendPublicIpAddresses?api-version=2023-06-01

{
  "frontendIPConfigurations": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfe1",
      "properties": {
        "publicIPAddress": {
          "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/pip2"
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb2/frontendIPConfigurations/lbfe2",
      "properties": {
        "publicIPAddress": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip1"
        }
      }
    }
  ]
}

Sample Response

location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-06-01
location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-06-01

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

LoadBalancerVipSwapRequest

The request for a VIP swap.

LoadBalancerVipSwapRequestFrontendIPConfiguration

VIP swap request's frontend IP configuration object.

SubResource

Reference to another subresource.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

LoadBalancerVipSwapRequest

The request for a VIP swap.

Name Type Description
frontendIPConfigurations

LoadBalancerVipSwapRequestFrontendIPConfiguration[]

A list of frontend IP configuration resources that should swap VIPs.

LoadBalancerVipSwapRequestFrontendIPConfiguration

VIP swap request's frontend IP configuration object.

Name Type Description
id

string

The ID of frontend IP configuration resource.

properties.publicIPAddress

SubResource

A reference to public IP address resource.

SubResource

Reference to another subresource.

Name Type Description
id

string

Resource ID.