vip_swap

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

Overview

Name	vip_swap
Type	Resource
Id	azure.network.vip_swap

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
slotType	string	Specifies slot info on a cloud service. Known values are: "Production" and "Staging". (Production, Staging)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group_name, resource_name, subscription_id		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.
create	insert	group_name, resource_name, subscription_id		Performs vip swap operation on swappable cloud services.
list_raw	exec	group_name, resource_name, subscription_id		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.

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
group_name	string	Required.
resource_name	string	The name of the cloud service. Required.
subscription_id	string

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,
slotType,
type
FROM azure.network.vip_swap
WHERE group_name = '{{ group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Performs vip swap operation on swappable cloud services.

INSERT INTO azure.network.vip_swap (
properties,
group_name,
resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: vip_swap
props:
  - name: group_name
    value: "{{ group_name }}"
    description: Required parameter for the vip_swap resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the vip_swap resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vip_swap resource.
  - name: properties
    description: |
      Swap resource properties.
    value:
      slotType: "{{ slotType }}"

Lifecycle Methods

list_raw

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.

EXEC azure.network.vip_swap.list_raw 
@group_name='{{ group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;