vip_swaps

Creates, updates, deletes, gets or lists a vip_swaps resource.

Overview

Name	vip_swaps
Type	Resource
Id	azure.network.vip_swaps

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the slot type for the specified cloud service.

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
properties	object	Swap resource properties
type	string	Resource type.

list

Request successful. The operation returns the slot type for the specified cloud service.

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
properties	object	Swap resource properties
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	groupName, resourceName, singletonResource, subscriptionId		Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production
list	select	groupName, resourceName, subscriptionId		Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production
create	insert	groupName, resourceName, singletonResource, subscriptionId		Performs vip swap operation on swappable cloud services.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
groupName	string	The name of the resource group.
resourceName	string	The name of the cloud service.
singletonResource	string	Specifies a synthetic resource that cannot be created or deleted. Value must be set to swap.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production

SELECT
id,
name,
properties,
type
FROM azure.network.vip_swaps
WHERE groupName = '{{ groupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND singletonResource = '{{ singletonResource }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production

SELECT
id,
name,
properties,
type
FROM azure.network.vip_swaps
WHERE groupName = '{{ groupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Performs vip swap operation on swappable cloud services.

INSERT INTO azure.network.vip_swaps (
data__properties,
groupName,
resourceName,
singletonResource,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ groupName }}',
'{{ resourceName }}',
'{{ singletonResource }}',
'{{ subscriptionId }}'
;

Manifest

# Description fields are for documentation purposes
- name: vip_swaps
  props:
    - name: groupName
      value: string
      description: Required parameter for the vip_swaps resource.
    - name: resourceName
      value: string
      description: Required parameter for the vip_swaps resource.
    - name: singletonResource
      value: string
      description: Required parameter for the vip_swaps resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the vip_swaps resource.
    - name: properties
      value: object
      description: |
        Swap resource properties