sap_application_server_instances

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

Overview

Name	sap_application_server_instances
Type	Resource
Id	azure_isv.sap_workloads.sap_application_server_instances

Fields

The following fields are returned by SELECT queries:

get

Describes the SAP Application Server Instance.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Defines the SAP Application Server instance properties.
tags	object	Resource tags.

list

List of SAP Application Server Instance resources.

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

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
applicationInstanceName	string	The name of SAP Application Server instance resource.
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 Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.

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

list

Lists the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource.

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

INSERT examples

create

Puts the SAP Application Server Instance 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_application_server_instances (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
sapVirtualInstanceName,
applicationInstanceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sapVirtualInstanceName }}',
'{{ applicationInstanceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sap_application_server_instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sap_application_server_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sap_application_server_instances resource.
    - name: sapVirtualInstanceName
      value: string
      description: Required parameter for the sap_application_server_instances resource.
    - name: applicationInstanceName
      value: string
      description: Required parameter for the sap_application_server_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 SAP Application Server instance properties.

UPDATE examples

update

Puts the SAP Application Server Instance resource.

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

DELETE examples

delete

Deletes the SAP Application Server Instance resource.

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

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

Lifecycle Methods

start_instance

Starts the SAP Application Server Instance.

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

stop_instance

Stops the SAP Application Server Instance.

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