sap_database_instances

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

Overview

Name	sap_database_instances
Type	Resource
Id	azure_isv.workloadssapvirtualinstance.sap_database_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.
databaseSid	string	Database SID name.
databaseType	string	Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
errors	object	Defines the errors related to Database resource.
ipAddress	string	Database IP Address.
loadBalancerDetails	object	The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", "Deleting", and "Canceled". (Succeeded, Updating, Creating, Failed, Deleting, Canceled)
status	string	Defines the SAP Instance status. Known values are: "Starting", "Running", "Stopping", "Offline", "PartiallyRunning", "Unavailable", and "SoftShutdown". (Starting, Running, Stopping, Offline, PartiallyRunning, Unavailable, SoftShutdown)
subnet	string	Database subnet.
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".
vmDetails	array	The list of virtual machines corresponding to the Database resource.

list

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.
databaseSid	string	Database SID name.
databaseType	string	Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
errors	object	Defines the errors related to Database resource.
ipAddress	string	Database IP Address.
loadBalancerDetails	object	The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", "Deleting", and "Canceled". (Succeeded, Updating, Creating, Failed, Deleting, Canceled)
status	string	Defines the SAP Instance status. Known values are: "Starting", "Running", "Stopping", "Offline", "PartiallyRunning", "Unavailable", and "SoftShutdown". (Starting, Running, Stopping, Offline, PartiallyRunning, Unavailable, SoftShutdown)
subnet	string	Database subnet.
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".
vmDetails	array	The list of virtual machines corresponding to the Database resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, sap_virtual_instance_name, database_instance_name, subscription_id		Gets the SAP Database Instance resource.
list	select	resource_group_name, sap_virtual_instance_name, subscription_id		Lists the Database resources associated with a Virtual Instance for SAP solutions resource.
create	insert	resource_group_name, sap_virtual_instance_name, database_instance_name, subscription_id, location		Creates the Database resource corresponding to the Virtual Instance for SAP solutions resource. <br />``<br />This will be used by service only. PUT by end user will return a Bad Request error.
update	update	resource_group_name, sap_virtual_instance_name, database_instance_name, subscription_id		Updates the Database resource.
delete	delete	resource_group_name, sap_virtual_instance_name, database_instance_name, subscription_id		Deletes the Database resource corresponding to a Virtual Instance for SAP solutions resource. <br />``<br />This will be used by service only. Delete by end user will return a Bad Request error.
start	exec	resource_group_name, sap_virtual_instance_name, database_instance_name, subscription_id		Starts the database instance of the SAP system.
stop	exec	resource_group_name, sap_virtual_instance_name, database_instance_name, subscription_id		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
database_instance_name	string	Database resource name string modeled as parameter for auto generation to work correctly. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sap_virtual_instance_name	string	The name of the Virtual Instances for SAP solutions resource. Required.
subscription_id	string

SELECT examples

get

Gets the SAP Database Instance resource.

SELECT
id,
name,
databaseSid,
databaseType,
errors,
ipAddress,
loadBalancerDetails,
location,
provisioningState,
status,
subnet,
systemData,
tags,
type,
vmDetails
FROM azure_isv.workloadssapvirtualinstance.sap_database_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_virtual_instance_name = '{{ sap_virtual_instance_name }}' -- required
AND database_instance_name = '{{ database_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
databaseSid,
databaseType,
errors,
ipAddress,
loadBalancerDetails,
location,
provisioningState,
status,
subnet,
systemData,
tags,
type,
vmDetails
FROM azure_isv.workloadssapvirtualinstance.sap_database_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_virtual_instance_name = '{{ sap_virtual_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the Database resource corresponding to the Virtual Instance for SAP solutions resource. <br />``<br />This will be used by service only. PUT by end user will return a Bad Request error.

INSERT INTO azure_isv.workloadssapvirtualinstance.sap_database_instances (
tags,
location,
properties,
resource_group_name,
sap_virtual_instance_name,
database_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sap_virtual_instance_name }}',
'{{ database_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sap_database_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_database_instances resource.
  - name: sap_virtual_instance_name
    value: "{{ sap_virtual_instance_name }}"
    description: Required parameter for the sap_database_instances resource.
  - name: database_instance_name
    value: "{{ database_instance_name }}"
    description: Required parameter for the sap_database_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_database_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:
      subnet: "{{ subnet }}"
      databaseSid: "{{ databaseSid }}"
      databaseType: "{{ databaseType }}"
      ipAddress: "{{ ipAddress }}"
      loadBalancerDetails:
        id: "{{ id }}"
      vmDetails:
        - virtualMachineId: "{{ virtualMachineId }}"
          status: "{{ status }}"
          storageDetails: "{{ storageDetails }}"
      status: "{{ status }}"
      provisioningState: "{{ provisioningState }}"
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              details: "{{ details }}"

UPDATE examples

update

Updates the Database resource.

UPDATE azure_isv.workloadssapvirtualinstance.sap_database_instances
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sap_virtual_instance_name = '{{ sap_virtual_instance_name }}' --required
AND database_instance_name = '{{ database_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the Database resource corresponding to a Virtual Instance for SAP solutions resource. <br />``<br />This will be used by service only. Delete by end user will return a Bad Request error.

DELETE FROM azure_isv.workloadssapvirtualinstance.sap_database_instances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sap_virtual_instance_name = '{{ sap_virtual_instance_name }}' --required
AND database_instance_name = '{{ database_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts the database instance of the SAP system.

EXEC azure_isv.workloadssapvirtualinstance.sap_database_instances.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@sap_virtual_instance_name='{{ sap_virtual_instance_name }}' --required, 
@database_instance_name='{{ database_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"startVm": {{ startVm }}
}'
;

stop

Stops the database instance of the SAP system.

EXEC azure_isv.workloadssapvirtualinstance.sap_database_instances.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@sap_virtual_instance_name='{{ sap_virtual_instance_name }}' --required, 
@database_instance_name='{{ database_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"softStopTimeoutSeconds": {{ softStopTimeoutSeconds }}, 
"deallocateVm": {{ deallocateVm }}
}'
;