sap_central_instances

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

Overview

Name	sap_central_instances
Type	Resource
Id	azure_isv.sap_workloads.sap_central_instances

Fields

The following fields are returned by SELECT queries:

get

Describes the SAP Central Services Instance resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Defines the SAP Central Services Instance properties.
tags	object	Resource tags.

list

Describes the SAP Central Services Instance resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Defines the SAP Central Services 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, centralInstanceName		Gets the SAP Central Services Instance resource.
list	select	subscriptionId, resourceGroupName, sapVirtualInstanceName		Lists the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.
create	insert	subscriptionId, resourceGroupName, sapVirtualInstanceName, centralInstanceName		Creates the SAP Central Services 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	subscriptionId, resourceGroupName, sapVirtualInstanceName, centralInstanceName		Updates the SAP Central Services Instance resource. This can be used to update tags on the resource.
delete	delete	subscriptionId, resourceGroupName, sapVirtualInstanceName, centralInstanceName		Deletes the SAP Central Services 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 Virtual Instance for SAP solutions resource, using the delete operation on it.
start_instance	exec	subscriptionId, resourceGroupName, sapVirtualInstanceName, centralInstanceName		Starts the SAP Central Services Instance.
stop_instance	exec	subscriptionId, resourceGroupName, sapVirtualInstanceName, centralInstanceName		Stops the SAP 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
centralInstanceName	string	Central Services Instance 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 Central Services Instance resource.

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

list

Lists the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.

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

INSERT examples

create

Creates the SAP Central Services 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_isv.sap_workloads.sap_central_instances (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
sapVirtualInstanceName,
centralInstanceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sapVirtualInstanceName }}',
'{{ centralInstanceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sap_central_instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sap_central_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sap_central_instances resource.
    - name: sapVirtualInstanceName
      value: string
      description: Required parameter for the sap_central_instances resource.
    - name: centralInstanceName
      value: string
      description: Required parameter for the sap_central_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 Central Services Instance properties.

UPDATE examples

update

Updates the SAP Central Services Instance resource.

This can be used to update tags on the resource.

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

DELETE examples

delete

Deletes the SAP Central Services 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 Virtual Instance for SAP solutions resource, using the delete operation on it.

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

Lifecycle Methods

start_instance

Starts the SAP Central Services Instance.

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

stop_instance

Stops the SAP Central Services Instance.

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