sap_database_instances

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

Overview

Name	sap_database_instances
Type	Resource
Id	azure_isv.sap_workloads.sap_database_instances

Fields

The following fields are returned by SELECT queries:

get

Describes the Database resource associated with the SAP system.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Defines the Database properties.
tags	object	Resource tags.

list

Describes the Database resource corresponding to a Virtual Instance for SAP solutions resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Defines the Database properties.
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, sapVirtualInstanceName, databaseInstanceName		Gets the SAP Database Instance resource.
list	select	subscriptionId, resourceGroupName, sapVirtualInstanceName		Lists the Database resources associated with a Virtual Instance for SAP solutions resource.
create	insert	subscriptionId, resourceGroupName, sapVirtualInstanceName, databaseInstanceName		Creates the Database resource corresponding to the Virtual Instance for SAP solutions resource. This will be used by service only. PUT by end user will return a Bad Request error.
update	update	subscriptionId, resourceGroupName, sapVirtualInstanceName, databaseInstanceName		Updates the Database resource.
delete	delete	subscriptionId, resourceGroupName, sapVirtualInstanceName, databaseInstanceName		Deletes the Database resource corresponding to a Virtual Instance for SAP solutions resource. This will be used by service only. Delete by end user will return a Bad Request error.
start_instance	exec	subscriptionId, resourceGroupName, sapVirtualInstanceName, databaseInstanceName		Starts the database instance of the SAP system.
stop_instance	exec	subscriptionId, resourceGroupName, sapVirtualInstanceName, databaseInstanceName		Stops the database instance of the SAP system.

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
databaseInstanceName	string	Database resource name string modeled as parameter for auto generation to work correctly.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sapVirtualInstanceName	string	The name of the Virtual Instances for SAP solutions resource
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the SAP Database Instance resource.

SELECT
location,
properties,
tags
FROM azure_isv.sap_workloads.sap_database_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sapVirtualInstanceName = '{{ sapVirtualInstanceName }}' -- required
AND databaseInstanceName = '{{ databaseInstanceName }}' -- required
;

list

Lists the Database resources associated with a Virtual Instance for SAP solutions resource.

SELECT
location,
properties,
tags
FROM azure_isv.sap_workloads.sap_database_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sapVirtualInstanceName = '{{ sapVirtualInstanceName }}' -- required
;

INSERT examples

create

Creates the Database resource corresponding to the Virtual Instance for SAP solutions resource.

This will be used by service only. PUT by end user will return a Bad Request error.

INSERT INTO azure_isv.sap_workloads.sap_database_instances (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
sapVirtualInstanceName,
databaseInstanceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sapVirtualInstanceName }}',
'{{ databaseInstanceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sap_database_instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sap_database_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sap_database_instances resource.
    - name: sapVirtualInstanceName
      value: string
      description: Required parameter for the sap_database_instances resource.
    - name: databaseInstanceName
      value: string
      description: Required parameter for the sap_database_instances resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Defines the Database properties.

UPDATE examples

update

Updates the Database resource.

UPDATE azure_isv.sap_workloads.sap_database_instances
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sapVirtualInstanceName = '{{ sapVirtualInstanceName }}' --required
AND databaseInstanceName = '{{ databaseInstanceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes the Database resource corresponding to a Virtual Instance for SAP solutions resource.

This will be used by service only. Delete by end user will return a Bad Request error.

DELETE FROM azure_isv.sap_workloads.sap_database_instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sapVirtualInstanceName = '{{ sapVirtualInstanceName }}' --required
AND databaseInstanceName = '{{ databaseInstanceName }}' --required
;

Lifecycle Methods

start_instance

Starts the database instance of the SAP system.

EXEC azure_isv.sap_workloads.sap_database_instances.start_instance 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sapVirtualInstanceName='{{ sapVirtualInstanceName }}' --required, 
@databaseInstanceName='{{ databaseInstanceName }}' --required
;

stop_instance

Stops the database instance of the SAP system.

EXEC azure_isv.sap_workloads.sap_database_instances.stop_instance 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sapVirtualInstanceName='{{ sapVirtualInstanceName }}' --required, 
@databaseInstanceName='{{ databaseInstanceName }}' --required 
@@json=
'{
"softStopTimeoutSeconds": {{ softStopTimeoutSeconds }}
}'
;