sap_virtual_instances

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

Overview

Name	sap_virtual_instances
Type	Resource
Id	azure_isv.sap_workloads.sap_virtual_instances

Fields

The following fields are returned by SELECT queries:

get

Describes the Virtual Instance for SAP solutions resource

Name	Datatype	Description
identity	object	A pre-created user assigned identity with appropriate roles assigned. To learn more on identity and roles required, visit the ACSS how-to-guide.
location	string	The geo-location where the resource lives
properties	object	Defines the Virtual Instance for SAP solutions resource properties.
tags	object	Resource tags.

list_by_resource_group

The list of all Virtual Instances for SAP solutions resources.

Name	Datatype	Description
identity	object	A pre-created user assigned identity with appropriate roles assigned. To learn more on identity and roles required, visit the ACSS how-to-guide.
location	string	The geo-location where the resource lives
properties	object	Defines the Virtual Instance for SAP solutions resource properties.
tags	object	Resource tags.

list_by_subscription

The list of all Virtual Instances for SAP solutions resources in the Subscription.

Name	Datatype	Description
identity	object	A pre-created user assigned identity with appropriate roles assigned. To learn more on identity and roles required, visit the ACSS how-to-guide.
location	string	The geo-location where the resource lives
properties	object	Defines the Virtual Instance for SAP solutions resource 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		Gets a Virtual Instance for SAP solutions resource
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets all Virtual Instances for SAP solutions resources in a Resource Group.
list_by_subscription	select	subscriptionId		Gets all Virtual Instances for SAP solutions resources in a Subscription.
create	insert	subscriptionId, resourceGroupName, sapVirtualInstanceName, data__properties		Creates a Virtual Instance for SAP solutions (VIS) resource
update	update	subscriptionId, resourceGroupName, sapVirtualInstanceName		Updates a Virtual Instance for SAP solutions resource
delete	delete	subscriptionId, resourceGroupName, sapVirtualInstanceName		Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.
start	exec	subscriptionId, resourceGroupName, sapVirtualInstanceName		Starts the SAP application, that is the Central Services instance and Application server instances.
stop	exec	subscriptionId, resourceGroupName, sapVirtualInstanceName		Stops the SAP Application, that is the Application server instances and Central Services 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
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 a Virtual Instance for SAP solutions resource

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

list_by_resource_group

Gets all Virtual Instances for SAP solutions resources in a Resource Group.

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

list_by_subscription

Gets all Virtual Instances for SAP solutions resources in a Subscription.

SELECT
identity,
location,
properties,
tags
FROM azure_isv.sap_workloads.sap_virtual_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a Virtual Instance for SAP solutions (VIS) resource

INSERT INTO azure_isv.sap_workloads.sap_virtual_instances (
data__tags,
data__location,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
sapVirtualInstanceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sapVirtualInstanceName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sap_virtual_instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sap_virtual_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sap_virtual_instances resource.
    - name: sapVirtualInstanceName
      value: string
      description: Required parameter for the sap_virtual_instances resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        A pre-created user assigned identity with appropriate roles assigned. To learn more on identity and roles required, visit the ACSS how-to-guide.
    - name: properties
      value: object
      description: |
        Defines the Virtual Instance for SAP solutions resource properties.

UPDATE examples

update

Updates a Virtual Instance for SAP solutions resource

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

DELETE examples

delete

Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.

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

Lifecycle Methods

start

Starts the SAP application, that is the Central Services instance and Application server instances.

EXEC azure_isv.sap_workloads.sap_virtual_instances.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sapVirtualInstanceName='{{ sapVirtualInstanceName }}' --required
;

stop

Stops the SAP Application, that is the Application server instances and Central Services instance.

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