Vip Swap - Create

Performs vip swap operation on swappable cloud services.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/swap?api-version=2024-03-01

URI Parameters

Name In Required Type Description
groupName
path True

string

The name of the resource group.

resourceName
path True

string

The name of the cloud service.

singletonResource
path True

singletonResource

Specifies a synthetic resource that cannot be created or deleted. Value must be set to swap.

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
properties

SwapResourceProperties

Swap resource properties

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

Put vip swap operation.

Sample request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/testCloudService/providers/Microsoft.Network/cloudServiceSlots/swap?api-version=2024-03-01

{
  "properties": {
    "slotType": "Production"
  }
}

Sample response

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

singletonResource

Specifies a synthetic resource that cannot be created or deleted. Value must be set to swap.

slotType

Specifies slot info on a cloud service

SwapResource

SwapResource to represent slot type on the specified cloud service.

SwapResourceProperties

Swap resource properties

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.

singletonResource

Specifies a synthetic resource that cannot be created or deleted. Value must be set to swap.

Name Type Description
swap

string

slotType

Specifies slot info on a cloud service

Name Type Description
Production

string

Staging

string

SwapResource

SwapResource to represent slot type on the specified cloud service.

Name Type Description
id

string

Resource Id.

name

string

Resource name.

properties

SwapResourceProperties

Swap resource properties

type

string

Resource type.

SwapResourceProperties

Swap resource properties

Name Type Description
slotType

slotType

Specifies slot info on a cloud service