sap_discovery_sites

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

Overview

Name	sap_discovery_sites
Type	Resource
Id	azure_extras.migration_discovery_sap.sap_discovery_sites

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
errors	object	Indicates any errors on the SAP Migration discovery site resource.
extendedLocation	object	The extended location definition.
location	string	The geo-location where the resource lives. Required.
masterSiteId	string	The master site ID from Azure Migrate.
migrateProjectId	string	The migrate project ID from Azure Migrate.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Failed", "Creating", "Canceled", "Accepted", "Deleting", and "Unknown".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
errors	object	Indicates any errors on the SAP Migration discovery site resource.
extendedLocation	object	The extended location definition.
location	string	The geo-location where the resource lives. Required.
masterSiteId	string	The master site ID from Azure Migrate.
migrateProjectId	string	The migrate project ID from Azure Migrate.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Failed", "Creating", "Canceled", "Accepted", "Deleting", and "Unknown".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
errors	object	Indicates any errors on the SAP Migration discovery site resource.
extendedLocation	object	The extended location definition.
location	string	The geo-location where the resource lives. Required.
masterSiteId	string	The master site ID from Azure Migrate.
migrateProjectId	string	The migrate project ID from Azure Migrate.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Failed", "Creating", "Canceled", "Accepted", "Deleting", and "Unknown".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, sap_discovery_site_name, subscription_id		Gets a SAP Migration discovery site resource.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all SAP Migration discovery site resources in a Resource Group.
list_by_subscription	select	subscription_id		Gets all SAP Migration discovery site resources in a Subscription.
create	insert	resource_group_name, sap_discovery_site_name, subscription_id, location		Creates a discovery site resource for SAP Migration. This resource will be used to run system discovery and assessment with Azure Migrate.
update	update	resource_group_name, sap_discovery_site_name, subscription_id		Updates a SAP Migration discovery site resource.
delete	delete	resource_group_name, sap_discovery_site_name, subscription_id		Deletes a SAP Migration discovery site resource and its child resources, that is the associated SAP Instances and Server Instances.
import_entities	exec	resource_group_name, sap_discovery_site_name, subscription_id		Import your SAP systems' inventory using the Discovery template _ into your SAP Migration discovery site resource and it's child resources, the SAP instances and Server instances.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sap_discovery_site_name	string	The name of the discovery site resource for SAP Migration. Required.
subscription_id	string

SELECT examples

get

Gets a SAP Migration discovery site resource.

SELECT
id,
name,
errors,
extendedLocation,
location,
masterSiteId,
migrateProjectId,
provisioningState,
systemData,
tags,
type
FROM azure_extras.migration_discovery_sap.sap_discovery_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_discovery_site_name = '{{ sap_discovery_site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all SAP Migration discovery site resources in a Resource Group.

SELECT
id,
name,
errors,
extendedLocation,
location,
masterSiteId,
migrateProjectId,
provisioningState,
systemData,
tags,
type
FROM azure_extras.migration_discovery_sap.sap_discovery_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all SAP Migration discovery site resources in a Subscription.

SELECT
id,
name,
errors,
extendedLocation,
location,
masterSiteId,
migrateProjectId,
provisioningState,
systemData,
tags,
type
FROM azure_extras.migration_discovery_sap.sap_discovery_sites
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a discovery site resource for SAP Migration. This resource will be used to run system discovery and assessment with Azure Migrate.

INSERT INTO azure_extras.migration_discovery_sap.sap_discovery_sites (
tags,
location,
properties,
extendedLocation,
resource_group_name,
sap_discovery_site_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ sap_discovery_site_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sap_discovery_sites
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_discovery_sites resource.
  - name: sap_discovery_site_name
    value: "{{ sap_discovery_site_name }}"
    description: Required parameter for the sap_discovery_sites resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_discovery_sites resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      masterSiteId: "{{ masterSiteId }}"
      migrateProjectId: "{{ migrateProjectId }}"
      provisioningState: "{{ provisioningState }}"
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          recommendation: "{{ recommendation }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              recommendation: "{{ recommendation }}"
              details: "{{ details }}"
  - name: extendedLocation
    description: |
      The extended location definition.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Updates a SAP Migration discovery site resource.

UPDATE azure_extras.migration_discovery_sap.sap_discovery_sites
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sap_discovery_site_name = '{{ sap_discovery_site_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a SAP Migration discovery site resource and its child resources, that is the associated SAP Instances and Server Instances.

DELETE FROM azure_extras.migration_discovery_sap.sap_discovery_sites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sap_discovery_site_name = '{{ sap_discovery_site_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

import_entities

Import your SAP systems' inventory using the Discovery template _ into your SAP Migration discovery site resource and it's child resources, the SAP instances and Server instances.

EXEC azure_extras.migration_discovery_sap.sap_discovery_sites.import_entities 
@resource_group_name='{{ resource_group_name }}' --required, 
@sap_discovery_site_name='{{ sap_discovery_site_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;