master_sites_controllers

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

Overview

Name	master_sites_controllers
Type	Resource
Id	azure.migrate.master_sites_controllers

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

ARM operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

ARM operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, siteName		Get a MasterSite
list_by_resource_group	select	subscriptionId, resourceGroupName		Get all the sites in the resource group.
list_by_subscription	select	subscriptionId		List MasterSite resources by subscription ID
create	insert	subscriptionId, resourceGroupName, siteName		Method to create or update a site.
update	update	subscriptionId, resourceGroupName, siteName		Method to update an existing site.
delete	delete	subscriptionId, resourceGroupName, siteName		Method to delete a site.
error_summary	exec	subscriptionId, resourceGroupName, siteName		Method to get error summary from master site for an appliance.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
siteName	string	Site name
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a MasterSite

SELECT
location,
properties,
tags
FROM azure.migrate.master_sites_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
;

list_by_resource_group

Get all the sites in the resource group.

SELECT
location,
properties,
tags
FROM azure.migrate.master_sites_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List MasterSite resources by subscription ID

SELECT
location,
properties,
tags
FROM azure.migrate.master_sites_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Method to create or update a site.

INSERT INTO azure.migrate.master_sites_controllers (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
siteName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ siteName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: master_sites_controllers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the master_sites_controllers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the master_sites_controllers resource.
    - name: siteName
      value: string
      description: Required parameter for the master_sites_controllers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Method to update an existing site.

UPDATE azure.migrate.master_sites_controllers
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND siteName = '{{ siteName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Method to delete a site.

DELETE FROM azure.migrate.master_sites_controllers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND siteName = '{{ siteName }}' --required
;

Lifecycle Methods

error_summary

Method to get error summary from master site for an appliance.

EXEC azure.migrate.master_sites_controllers.error_summary 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required 
@@json=
'{
"applianceName": "{{ applianceName }}"
}'
;