sap_instances

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

Overview

Name	sap_instances
Type	Resource
Id	azure_extras.migration_discovery_sap.sap_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.
application	string	Enter a business function/department identifier to group multiple SIDs.
environment	string	The Environment; PRD, QA, DEV, etc to which SAP system belongs to. Select from the list of available dropdown values. Known values are: "Production", "PreProduction", "Test", "QualityAssurance", "Development", "Sandbox", "DisasterRecovery", and "Training".
errors	object	Defines the errors related to SAP Instance resource.
landscapeSid	string	This is the SID of the production system in a landscape. An SAP system could itself be a production SID or a part of a landscape with a different Production SID. This field can be used to relate non-prod SIDs, other components, SID (WEBDISP) to the prod SID. Enter the value of Production SID.
location	string	The geo-location where the resource lives. Required.
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.
systemSid	string	This is the SID of SAP System. Keeping this not equal to ID as different landscapes can have repeated System SID IDs.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_sap_discovery_site

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.
application	string	Enter a business function/department identifier to group multiple SIDs.
environment	string	The Environment; PRD, QA, DEV, etc to which SAP system belongs to. Select from the list of available dropdown values. Known values are: "Production", "PreProduction", "Test", "QualityAssurance", "Development", "Sandbox", "DisasterRecovery", and "Training".
errors	object	Defines the errors related to SAP Instance resource.
landscapeSid	string	This is the SID of the production system in a landscape. An SAP system could itself be a production SID or a part of a landscape with a different Production SID. This field can be used to relate non-prod SIDs, other components, SID (WEBDISP) to the prod SID. Enter the value of Production SID.
location	string	The geo-location where the resource lives. Required.
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.
systemSid	string	This is the SID of SAP System. Keeping this not equal to ID as different landscapes can have repeated System SID IDs.
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, sap_instance_name, subscription_id		Gets the SAP Instance resource.
list_by_sap_discovery_site	select	resource_group_name, sap_discovery_site_name, subscription_id		Lists the SAP Instance resources for the given SAP Migration discovery site resource.
create	insert	resource_group_name, sap_discovery_site_name, sap_instance_name, subscription_id, location		Creates the SAP 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, subscription_id		Updates the SAP Instance resource.
delete	delete	resource_group_name, sap_discovery_site_name, sap_instance_name, subscription_id		Deletes the SAP 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.
subscription_id	string

SELECT examples

get

Gets the SAP Instance resource.

SELECT
id,
name,
application,
environment,
errors,
landscapeSid,
location,
provisioningState,
systemData,
systemSid,
tags,
type
FROM azure_extras.migration_discovery_sap.sap_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
;

list_by_sap_discovery_site

Lists the SAP Instance resources for the given SAP Migration discovery site resource.

SELECT
id,
name,
application,
environment,
errors,
landscapeSid,
location,
provisioningState,
systemData,
systemSid,
tags,
type
FROM azure_extras.migration_discovery_sap.sap_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_discovery_site_name = '{{ sap_discovery_site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the SAP 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.sap_instances (
tags,
location,
properties,
resource_group_name,
sap_discovery_site_name,
sap_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sap_discovery_site_name }}',
'{{ sap_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sap_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_instances resource.
  - name: sap_discovery_site_name
    value: "{{ sap_discovery_site_name }}"
    description: Required parameter for the sap_instances resource.
  - name: sap_instance_name
    value: "{{ sap_instance_name }}"
    description: Required parameter for the sap_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_instances 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:
      systemSid: "{{ systemSid }}"
      environment: "{{ environment }}"
      landscapeSid: "{{ landscapeSid }}"
      application: "{{ application }}"
      provisioningState: "{{ provisioningState }}"
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          recommendation: "{{ recommendation }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              recommendation: "{{ recommendation }}"
              details: "{{ details }}"

UPDATE examples

update

Updates the SAP Instance resource.

UPDATE azure_extras.migration_discovery_sap.sap_instances
SET 
tags = '{{ tags }}'
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
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the SAP 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.sap_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
;