sap_virtual_instances

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

Overview

Name	sap_virtual_instances
Type	Resource
Id	azure_isv.workloads.sap_virtual_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.
configuration	object	Defines if the SAP system is being created using Azure Center for SAP solutions (ACSS) or if an existing SAP system is being registered with ACSS. Required.
environment	string	Defines the environment type - Production/Non Production. Required. Known values are: "NonProd" and "Prod".
errors	object	Indicates any errors on the Virtual Instance for SAP solutions resource.
health	string	Defines the health of SAP Instances. Known values are: "Unknown", "Healthy", "Unhealthy", and "Degraded".
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. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", and "Deleting".
sapProduct	string	Defines the SAP Product type. Required. Known values are: "ECC", "S4HANA", and "Other".
state	string	Defines the Virtual Instance for SAP state. Known values are: "InfrastructureDeploymentPending", "InfrastructureDeploymentInProgress", "InfrastructureDeploymentFailed", "SoftwareInstallationPending", "SoftwareInstallationInProgress", "SoftwareInstallationFailed", "SoftwareDetectionInProgress", "SoftwareDetectionFailed", "DiscoveryPending", "DiscoveryInProgress", "DiscoveryFailed", and "RegistrationComplete".
status	string	Defines the SAP Instance status. Known values are: "Starting", "Running", "Stopping", "Offline", "PartiallyRunning", "Unavailable", and "SoftShutdown".
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".

list_by_resource_group

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.
configuration	object	Defines if the SAP system is being created using Azure Center for SAP solutions (ACSS) or if an existing SAP system is being registered with ACSS. Required.
environment	string	Defines the environment type - Production/Non Production. Required. Known values are: "NonProd" and "Prod".
errors	object	Indicates any errors on the Virtual Instance for SAP solutions resource.
health	string	Defines the health of SAP Instances. Known values are: "Unknown", "Healthy", "Unhealthy", and "Degraded".
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. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", and "Deleting".
sapProduct	string	Defines the SAP Product type. Required. Known values are: "ECC", "S4HANA", and "Other".
state	string	Defines the Virtual Instance for SAP state. Known values are: "InfrastructureDeploymentPending", "InfrastructureDeploymentInProgress", "InfrastructureDeploymentFailed", "SoftwareInstallationPending", "SoftwareInstallationInProgress", "SoftwareInstallationFailed", "SoftwareDetectionInProgress", "SoftwareDetectionFailed", "DiscoveryPending", "DiscoveryInProgress", "DiscoveryFailed", and "RegistrationComplete".
status	string	Defines the SAP Instance status. Known values are: "Starting", "Running", "Stopping", "Offline", "PartiallyRunning", "Unavailable", and "SoftShutdown".
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".

list_by_subscription

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.
configuration	object	Defines if the SAP system is being created using Azure Center for SAP solutions (ACSS) or if an existing SAP system is being registered with ACSS. Required.
environment	string	Defines the environment type - Production/Non Production. Required. Known values are: "NonProd" and "Prod".
errors	object	Indicates any errors on the Virtual Instance for SAP solutions resource.
health	string	Defines the health of SAP Instances. Known values are: "Unknown", "Healthy", "Unhealthy", and "Degraded".
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. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", and "Deleting".
sapProduct	string	Defines the SAP Product type. Required. Known values are: "ECC", "S4HANA", and "Other".
state	string	Defines the Virtual Instance for SAP state. Known values are: "InfrastructureDeploymentPending", "InfrastructureDeploymentInProgress", "InfrastructureDeploymentFailed", "SoftwareInstallationPending", "SoftwareInstallationInProgress", "SoftwareInstallationFailed", "SoftwareDetectionInProgress", "SoftwareDetectionFailed", "DiscoveryPending", "DiscoveryInProgress", "DiscoveryFailed", and "RegistrationComplete".
status	string	Defines the SAP Instance status. Known values are: "Starting", "Running", "Stopping", "Offline", "PartiallyRunning", "Unavailable", and "SoftShutdown".
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".

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, subscription_id		Gets a Virtual Instance for SAP solutions resource.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all Virtual Instances for SAP solutions resources in a Resource Group.
list_by_subscription	select	subscription_id		Gets all Virtual Instances for SAP solutions resources in a Subscription.
create	insert	resource_group_name, sap_virtual_instance_name, subscription_id, location, properties		Creates a Virtual Instance for SAP solutions (VIS) resource.
update	update	resource_group_name, sap_virtual_instance_name, subscription_id		Updates a Virtual Instance for SAP solutions resource.
delete	delete	resource_group_name, sap_virtual_instance_name, subscription_id		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	resource_group_name, sap_virtual_instance_name, subscription_id		Starts the SAP application, that is the Central Services instance and Application server instances.
stop	exec	resource_group_name, sap_virtual_instance_name, subscription_id		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
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 a Virtual Instance for SAP solutions resource.

SELECT
id,
name,
configuration,
environment,
errors,
health,
identity,
location,
managedResourceGroupConfiguration,
provisioningState,
sapProduct,
state,
status,
systemData,
tags,
type
FROM azure_isv.workloads.sap_virtual_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
;

list_by_resource_group

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

SELECT
id,
name,
configuration,
environment,
errors,
health,
identity,
location,
managedResourceGroupConfiguration,
provisioningState,
sapProduct,
state,
status,
systemData,
tags,
type
FROM azure_isv.workloads.sap_virtual_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
configuration,
environment,
errors,
health,
identity,
location,
managedResourceGroupConfiguration,
provisioningState,
sapProduct,
state,
status,
systemData,
tags,
type
FROM azure_isv.workloads.sap_virtual_instances
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a Virtual Instance for SAP solutions (VIS) resource.

INSERT INTO azure_isv.workloads.sap_virtual_instances (
tags,
location,
identity,
properties,
resource_group_name,
sap_virtual_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ sap_virtual_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sap_virtual_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_virtual_instances resource.
  - name: sap_virtual_instance_name
    value: "{{ sap_virtual_instance_name }}"
    description: Required parameter for the sap_virtual_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_virtual_instances resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    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.
    value:
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      environment: "{{ environment }}"
      sapProduct: "{{ sapProduct }}"
      configuration:
        configurationType: "{{ configurationType }}"
      managedResourceGroupConfiguration:
        name: "{{ name }}"

UPDATE examples

update

Updates a Virtual Instance for SAP solutions resource.

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

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.workloads.sap_virtual_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
;

Lifecycle Methods

start

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

EXEC azure_isv.workloads.sap_virtual_instances.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@sap_virtual_instance_name='{{ sap_virtual_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

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

EXEC azure_isv.workloads.sap_virtual_instances.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@sap_virtual_instance_name='{{ sap_virtual_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"softStopTimeoutSeconds": {{ softStopTimeoutSeconds }}
}'
;