server_instances

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

Overview

Name	server_instances
Type	Resource
Id	azure_extras.migration_discovery_sap.server_instances

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.
configurationData	object	Configuration data for this server instance.
errors	object	Defines the errors related to SAP Instance resource.
instanceSid	string	This is the Instance SID for ASCS/AP/DB instance. An SAP system with HANA database for example could have a different SID for database Instance than that of ASCS instance.
operatingSystem	string	This is Operating System on which the host server is running. Known values are: "IBMAIX", "RedHat", "SUSE", "Solaris", "Unix", and "WindowsServer".
performanceData	object	Configuration data for this server instance.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Failed", "Creating", "Canceled", "Accepted", "Deleting", and "Unknown".
sapInstanceType	string	Defines the type SAP instance on this server instance. Known values are: "ASCS", "DB", "APP", "SCS", and "WEBDISP".
sapProduct	string	This is the SAP Application Component; e.g. SAP S/4HANA 2022, SAP ERP ENHANCE PACKAGE.
sapProductVersion	string	Provide the product version of the SAP product.
serverName	string	This is the Virtual Machine Name of the SAP system. Add all the virtual machines attached to an SAP system which you wish to migrate to Azure. Keeping this not equal to ID as for single tier all InstanceTypes would be on same server, leading to multiple resources with same servername.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_sap_instance

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.
configurationData	object	Configuration data for this server instance.
errors	object	Defines the errors related to SAP Instance resource.
instanceSid	string	This is the Instance SID for ASCS/AP/DB instance. An SAP system with HANA database for example could have a different SID for database Instance than that of ASCS instance.
operatingSystem	string	This is Operating System on which the host server is running. Known values are: "IBMAIX", "RedHat", "SUSE", "Solaris", "Unix", and "WindowsServer".
performanceData	object	Configuration data for this server instance.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Failed", "Creating", "Canceled", "Accepted", "Deleting", and "Unknown".
sapInstanceType	string	Defines the type SAP instance on this server instance. Known values are: "ASCS", "DB", "APP", "SCS", and "WEBDISP".
sapProduct	string	This is the SAP Application Component; e.g. SAP S/4HANA 2022, SAP ERP ENHANCE PACKAGE.
sapProductVersion	string	Provide the product version of the SAP product.
serverName	string	This is the Virtual Machine Name of the SAP system. Add all the virtual machines attached to an SAP system which you wish to migrate to Azure. Keeping this not equal to ID as for single tier all InstanceTypes would be on same server, leading to multiple resources with same servername.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, sap_instance_name, server_instance_name, subscription_id		Gets the Server Instance resource.
list_by_sap_instance	select	resource_group_name, sap_discovery_site_name, sap_instance_name, subscription_id		Lists the Server Instance resources for the given SAP Instance resource.
create	insert	resource_group_name, sap_discovery_site_name, sap_instance_name, server_instance_name, subscription_id		Creates the Server Instance resource. ;This will be used by service only. PUT operation on this resource by end user will return a Bad Request error.
update	update	resource_group_name, sap_discovery_site_name, sap_instance_name, server_instance_name, subscription_id		Updates the Server Instance resource. This operation on a resource by end user will return a Bad Request error.
delete	delete	resource_group_name, sap_discovery_site_name, sap_instance_name, server_instance_name, subscription_id		Deletes the Server Instance resource. ;This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the SAP Migration discovery site resource, using the delete operation on it.

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.
sap_instance_name	string	The name of SAP Instance resource for SAP Migration. Required.
server_instance_name	string	The name of the Server instance resource for SAP Migration. Required.
subscription_id	string

SELECT examples

get

Gets the Server Instance resource.

SELECT
id,
name,
configurationData,
errors,
instanceSid,
operatingSystem,
performanceData,
provisioningState,
sapInstanceType,
sapProduct,
sapProductVersion,
serverName,
systemData,
type
FROM azure_extras.migration_discovery_sap.server_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_discovery_site_name = '{{ sap_discovery_site_name }}' -- required
AND sap_instance_name = '{{ sap_instance_name }}' -- required
AND server_instance_name = '{{ server_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_sap_instance

Lists the Server Instance resources for the given SAP Instance resource.

SELECT
id,
name,
configurationData,
errors,
instanceSid,
operatingSystem,
performanceData,
provisioningState,
sapInstanceType,
sapProduct,
sapProductVersion,
serverName,
systemData,
type
FROM azure_extras.migration_discovery_sap.server_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_discovery_site_name = '{{ sap_discovery_site_name }}' -- required
AND sap_instance_name = '{{ sap_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the Server Instance resource. ;This will be used by service only. PUT operation on this resource by end user will return a Bad Request error.

INSERT INTO azure_extras.migration_discovery_sap.server_instances (
properties,
resource_group_name,
sap_discovery_site_name,
sap_instance_name,
server_instance_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sap_discovery_site_name }}',
'{{ sap_instance_name }}',
'{{ server_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_instances resource.
  - name: sap_discovery_site_name
    value: "{{ sap_discovery_site_name }}"
    description: Required parameter for the server_instances resource.
  - name: sap_instance_name
    value: "{{ sap_instance_name }}"
    description: Required parameter for the server_instances resource.
  - name: server_instance_name
    value: "{{ server_instance_name }}"
    description: Required parameter for the server_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_instances resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      serverName: "{{ serverName }}"
      sapInstanceType: "{{ sapInstanceType }}"
      instanceSid: "{{ instanceSid }}"
      sapProduct: "{{ sapProduct }}"
      sapProductVersion: "{{ sapProductVersion }}"
      operatingSystem: "{{ operatingSystem }}"
      configurationData:
        saps: {{ saps }}
        cpu: {{ cpu }}
        cpuType: "{{ cpuType }}"
        cpuInMhz: {{ cpuInMhz }}
        ram: {{ ram }}
        hardwareManufacturer: "{{ hardwareManufacturer }}"
        model: "{{ model }}"
        totalDiskSizeGB: {{ totalDiskSizeGB }}
        totalDiskIops: {{ totalDiskIops }}
        databaseType: "{{ databaseType }}"
        targetHanaRamSizeGB: {{ targetHanaRamSizeGB }}
      performanceData:
        dataSource: "{{ dataSource }}"
      provisioningState: "{{ provisioningState }}"
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          recommendation: "{{ recommendation }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              recommendation: "{{ recommendation }}"
              details: "{{ details }}"

UPDATE examples

update

Updates the Server Instance resource. This operation on a resource by end user will return a Bad Request error.

UPDATE azure_extras.migration_discovery_sap.server_instances
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sap_discovery_site_name = '{{ sap_discovery_site_name }}' --required
AND sap_instance_name = '{{ sap_instance_name }}' --required
AND server_instance_name = '{{ server_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the Server Instance resource. ;This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the SAP Migration discovery site resource, using the delete operation on it.

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