sql_sites_controllers

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

Overview

Name	sql_sites_controllers
Type	Resource
Id	azure.migrate.sql_sites_controllers

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_master_site

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to get a site.
list_by_master_site	select	subscriptionId, resourceGroupName, siteName		Method to get all sites.
create	insert	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to create a SQL site.
update	update	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to update an existing site.
delete	delete	subscriptionId, resourceGroupName, siteName, sqlSiteName		Deletes the SQL site.
error_summary	exec	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to get error summary from SQL site.
export_sql_server_errors	exec	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to generate report containing SQL servers.
export_sql_servers	exec	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to generate report containing SQL servers.
refresh	exec	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to refresh a site.
summary	exec	subscriptionId, resourceGroupName, siteName, sqlSiteName		Method to get site usage/summary.

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
sqlSiteName	string	SQL site name.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Method to get a site.

SELECT
properties
FROM azure.migrate.sql_sites_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
AND sqlSiteName = '{{ sqlSiteName }}' -- required
;

list_by_master_site

Method to get all sites.

SELECT
properties
FROM azure.migrate.sql_sites_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
;

INSERT examples

create

Method to create a SQL site.

INSERT INTO azure.migrate.sql_sites_controllers (
data__properties,
subscriptionId,
resourceGroupName,
siteName,
sqlSiteName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ siteName }}',
'{{ sqlSiteName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_sites_controllers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_sites_controllers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_sites_controllers resource.
    - name: siteName
      value: string
      description: Required parameter for the sql_sites_controllers resource.
    - name: sqlSiteName
      value: string
      description: Required parameter for the sql_sites_controllers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

UPDATE examples

update

Method to update an existing site.

UPDATE azure.migrate.sql_sites_controllers
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND siteName = '{{ siteName }}' --required
AND sqlSiteName = '{{ sqlSiteName }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the SQL site.

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

Lifecycle Methods

error_summary

Method to get error summary from SQL site.

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

export_sql_server_errors

Method to generate report containing SQL servers.

EXEC azure.migrate.sql_sites_controllers.export_sql_server_errors 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required, 
@sqlSiteName='{{ sqlSiteName }}' --required
;

export_sql_servers

Method to generate report containing SQL servers.

EXEC azure.migrate.sql_sites_controllers.export_sql_servers 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required, 
@sqlSiteName='{{ sqlSiteName }}' --required 
@@json=
'{
"applianceName": "{{ applianceName }}", 
"filter": "{{ filter }}"
}'
;

refresh

Method to refresh a site.

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

summary

Method to get site usage/summary.

EXEC azure.migrate.sql_sites_controllers.summary 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required, 
@sqlSiteName='{{ sqlSiteName }}' --required
;