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.workloadssapvirtualinstance.sap_application_server_instances`

Fields

The following fields are returned by SELECT queries:

get
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.
`dispatcherStatus`	`string`	Application server instance dispatcher status.
`errors`	`object`	Defines the Application Instance errors.
`gatewayPort`	`integer`	Application server instance gateway Port.
`health`	`string`	Defines the health of SAP Instances. Known values are: "Unknown", "Healthy", "Unhealthy", and "Degraded". (Unknown, Healthy, Unhealthy, Degraded)
`hostname`	`string`	Application server instance SAP hostname.
`icmHttpPort`	`integer`	Application server instance ICM HTTP Port.
`icmHttpsPort`	`integer`	Application server instance ICM HTTPS Port.
`instanceNo`	`string`	Application server Instance Number.
`ipAddress`	`string`	Application server instance SAP IP Address.
`kernelPatch`	`string`	Application server instance SAP Kernel Patch level.
`kernelVersion`	`string`	Application server instance SAP Kernel Version.
`loadBalancerDetails`	`object`	The Load Balancer details such as LoadBalancer ID attached to Application Server 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`	Application server 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.

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.
`dispatcherStatus`	`string`	Application server instance dispatcher status.
`errors`	`object`	Defines the Application Instance errors.
`gatewayPort`	`integer`	Application server instance gateway Port.
`health`	`string`	Defines the health of SAP Instances. Known values are: "Unknown", "Healthy", "Unhealthy", and "Degraded". (Unknown, Healthy, Unhealthy, Degraded)
`hostname`	`string`	Application server instance SAP hostname.
`icmHttpPort`	`integer`	Application server instance ICM HTTP Port.
`icmHttpsPort`	`integer`	Application server instance ICM HTTPS Port.
`instanceNo`	`string`	Application server Instance Number.
`ipAddress`	`string`	Application server instance SAP IP Address.
`kernelPatch`	`string`	Application server instance SAP Kernel Patch level.
`kernelVersion`	`string`	Application server instance SAP Kernel Version.
`loadBalancerDetails`	`object`	The Load Balancer details such as LoadBalancer ID attached to Application Server 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`	Application server 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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get`	`select`	`resource_group_name`, `sap_virtual_instance_name`, `application_instance_name`, `subscription_id`	Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.
`list`	`select`	`resource_group_name`, `sap_virtual_instance_name`, `subscription_id`	Lists the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource.
`create`	`insert`	`resource_group_name`, `sap_virtual_instance_name`, `application_instance_name`, `subscription_id`, `location`	Puts the SAP Application Server Instance 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`, `application_instance_name`, `subscription_id`	Puts the SAP Application Server Instance resource.
`delete`	`delete`	`resource_group_name`, `sap_virtual_instance_name`, `application_instance_name`, `subscription_id`	Deletes the SAP Application Server Instance resource. <br />``<br />This operation 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`, `application_instance_name`, `subscription_id`	Starts the SAP Application Server Instance.
`stop`	`exec`	`resource_group_name`, `sap_virtual_instance_name`, `application_instance_name`, `subscription_id`	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
`application_instance_name`	`string`	The name of SAP Application Server instance resource. 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
list

Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.

SELECT
id,
name,
dispatcherStatus,
errors,
gatewayPort,
health,
hostname,
icmHttpPort,
icmHttpsPort,
instanceNo,
ipAddress,
kernelPatch,
kernelVersion,
loadBalancerDetails,
location,
provisioningState,
status,
subnet,
systemData,
tags,
type,
vmDetails
FROM azure_isv.workloadssapvirtualinstance.sap_application_server_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_virtual_instance_name = '{{ sap_virtual_instance_name }}' -- required
AND application_instance_name = '{{ application_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

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

SELECT
id,
name,
dispatcherStatus,
errors,
gatewayPort,
health,
hostname,
icmHttpPort,
icmHttpsPort,
instanceNo,
ipAddress,
kernelPatch,
kernelVersion,
loadBalancerDetails,
location,
provisioningState,
status,
subnet,
systemData,
tags,
type,
vmDetails
FROM azure_isv.workloadssapvirtualinstance.sap_application_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
Manifest

Puts the SAP Application Server Instance 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_application_server_instances (
tags,
location,
properties,
resource_group_name,
sap_virtual_instance_name,
application_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sap_virtual_instance_name }}',
'{{ application_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

# Description fields are for documentation purposes
- name: sap_application_server_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_application_server_instances resource.
  - name: sap_virtual_instance_name
    value: "{{ sap_virtual_instance_name }}"
    description: Required parameter for the sap_application_server_instances resource.
  - name: application_instance_name
    value: "{{ application_instance_name }}"
    description: Required parameter for the sap_application_server_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_application_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 }}"
      hostname: "{{ hostname }}"
      kernelVersion: "{{ kernelVersion }}"
      kernelPatch: "{{ kernelPatch }}"
      ipAddress: "{{ ipAddress }}"
      gatewayPort: {{ gatewayPort }}
      icmHttpPort: {{ icmHttpPort }}
      icmHttpsPort: {{ icmHttpsPort }}
      dispatcherStatus: "{{ dispatcherStatus }}"
      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

Puts the SAP Application Server Instance resource.

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

`DELETE` examples

delete

Deletes the SAP Application Server Instance resource. <br />``<br />This operation will be used by service only. Delete by end user will return a Bad Request error.

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

Lifecycle Methods

start
stop

Starts the SAP Application Server Instance.

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

Stops the SAP Application Server Instance.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​