sap_central_server_instances

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

Overview

Name	sap_central_server_instances
Type	Resource
Id	azure_isv.workloadssapvirtualinstance.sap_central_server_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.
enqueueReplicationServerProperties	object	Defines the SAP Enqueue Replication Server (ERS) properties.
enqueueServerProperties	object	Defines the SAP Enqueue Server properties.
errors	object	Defines the errors related to SAP Central Services Instance resource.
gatewayServerProperties	object	Defines the SAP Gateway Server properties.
health	string	Defines the health of SAP Instances. Known values are: "Unknown", "Healthy", "Unhealthy", and "Degraded". (Unknown, Healthy, Unhealthy, Degraded)
instanceNo	string	The central services instance number.
kernelPatch	string	The central services instance Kernel Patch level.
kernelVersion	string	The central services instance Kernel Version.
loadBalancerDetails	object	The Load Balancer details such as LoadBalancer ID attached to ASCS Virtual Machines.
location	string	The geo-location where the resource lives. Required.
messageServerProperties	object	Defines the SAP message server properties.
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	The central services instance 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 Central Services instance.

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.
enqueueReplicationServerProperties	object	Defines the SAP Enqueue Replication Server (ERS) properties.
enqueueServerProperties	object	Defines the SAP Enqueue Server properties.
errors	object	Defines the errors related to SAP Central Services Instance resource.
gatewayServerProperties	object	Defines the SAP Gateway Server properties.
health	string	Defines the health of SAP Instances. Known values are: "Unknown", "Healthy", "Unhealthy", and "Degraded". (Unknown, Healthy, Unhealthy, Degraded)
instanceNo	string	The central services instance number.
kernelPatch	string	The central services instance Kernel Patch level.
kernelVersion	string	The central services instance Kernel Version.
loadBalancerDetails	object	The Load Balancer details such as LoadBalancer ID attached to ASCS Virtual Machines.
location	string	The geo-location where the resource lives. Required.
messageServerProperties	object	Defines the SAP message server properties.
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	The central services instance 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 Central Services instance.

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, central_instance_name, subscription_id		Gets the SAP Central Services Instance resource.
list	select	resource_group_name, sap_virtual_instance_name, subscription_id		Lists the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.
create	insert	resource_group_name, sap_virtual_instance_name, central_instance_name, subscription_id, location		Creates the SAP Central Services Instance resource. <br />``<br />This will be used by service only. PUT operation on this resource by end user will return a Bad Request error.
update	update	resource_group_name, sap_virtual_instance_name, central_instance_name, subscription_id		Updates the SAP Central Services Instance resource. <br />``<br />This can be used to update tags on the resource.
delete	delete	resource_group_name, sap_virtual_instance_name, central_instance_name, subscription_id		Deletes the SAP Central Services Instance resource. <br />``<br />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	exec	resource_group_name, sap_virtual_instance_name, central_instance_name, subscription_id		Starts the SAP Central Services Instance.
stop	exec	resource_group_name, sap_virtual_instance_name, central_instance_name, subscription_id		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
central_instance_name	string	Central Services Instance 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 Central Services Instance resource.

SELECT
id,
name,
enqueueReplicationServerProperties,
enqueueServerProperties,
errors,
gatewayServerProperties,
health,
instanceNo,
kernelPatch,
kernelVersion,
loadBalancerDetails,
location,
messageServerProperties,
provisioningState,
status,
subnet,
systemData,
tags,
type,
vmDetails
FROM azure_isv.workloadssapvirtualinstance.sap_central_server_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_virtual_instance_name = '{{ sap_virtual_instance_name }}' -- required
AND central_instance_name = '{{ central_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
enqueueReplicationServerProperties,
enqueueServerProperties,
errors,
gatewayServerProperties,
health,
instanceNo,
kernelPatch,
kernelVersion,
loadBalancerDetails,
location,
messageServerProperties,
provisioningState,
status,
subnet,
systemData,
tags,
type,
vmDetails
FROM azure_isv.workloadssapvirtualinstance.sap_central_server_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 SAP Central Services Instance resource. <br />``<br />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.workloadssapvirtualinstance.sap_central_server_instances (
tags,
location,
properties,
resource_group_name,
sap_virtual_instance_name,
central_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sap_virtual_instance_name }}',
'{{ central_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sap_central_server_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_central_server_instances resource.
  - name: sap_virtual_instance_name
    value: "{{ sap_virtual_instance_name }}"
    description: Required parameter for the sap_central_server_instances resource.
  - name: central_instance_name
    value: "{{ central_instance_name }}"
    description: Required parameter for the sap_central_server_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_central_server_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:
      instanceNo: "{{ instanceNo }}"
      subnet: "{{ subnet }}"
      messageServerProperties:
        msPort: {{ msPort }}
        internalMsPort: {{ internalMsPort }}
        httpPort: {{ httpPort }}
        httpsPort: {{ httpsPort }}
        hostname: "{{ hostname }}"
        ipAddress: "{{ ipAddress }}"
        health: "{{ health }}"
      enqueueServerProperties:
        hostname: "{{ hostname }}"
        ipAddress: "{{ ipAddress }}"
        port: {{ port }}
        health: "{{ health }}"
      gatewayServerProperties:
        port: {{ port }}
        health: "{{ health }}"
      enqueueReplicationServerProperties:
        ersVersion: "{{ ersVersion }}"
        instanceNo: "{{ instanceNo }}"
        hostname: "{{ hostname }}"
        kernelVersion: "{{ kernelVersion }}"
        kernelPatch: "{{ kernelPatch }}"
        ipAddress: "{{ ipAddress }}"
        health: "{{ health }}"
      kernelVersion: "{{ kernelVersion }}"
      kernelPatch: "{{ kernelPatch }}"
      loadBalancerDetails:
        id: "{{ id }}"
      vmDetails:
        - type: "{{ type }}"
          virtualMachineId: "{{ virtualMachineId }}"
          storageDetails: "{{ storageDetails }}"
      status: "{{ status }}"
      health: "{{ health }}"
      provisioningState: "{{ provisioningState }}"
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              details: "{{ details }}"

UPDATE examples

update

Updates the SAP Central Services Instance resource. <br />``<br />This can be used to update tags on the resource.

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

DELETE examples

delete

Deletes the SAP Central Services Instance resource. <br />``<br />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.workloadssapvirtualinstance.sap_central_server_instances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sap_virtual_instance_name = '{{ sap_virtual_instance_name }}' --required
AND central_instance_name = '{{ central_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts the SAP Central Services Instance.

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

stop

Stops the SAP Central Services Instance.

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