sap_virtual_instances

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

Overview

Name	sap_virtual_instances
Type	Resource
Id	azure_isv.workloadssapvirtualinstance.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". (NonProd, 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". (Unknown, Healthy, Unhealthy, Degraded)
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
managedResourcesNetworkAccessType	string	Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228 _. Known values are: "Public" and "Private". (Public, Private)
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", "Deleting", and "Canceled". (Succeeded, Updating, Creating, Failed, Deleting, Canceled)
sapProduct	string	Defines the SAP Product type. Required. Known values are: "ECC", "S4HANA", and "Other". (ECC, S4HANA, Other)
state	string	Defines the Virtual Instance for SAP state. Known values are: "InfrastructureDeploymentPending", "InfrastructureDeploymentInProgress", "InfrastructureDeploymentFailed", "SoftwareInstallationPending", "SoftwareInstallationInProgress", "SoftwareInstallationFailed", "SoftwareDetectionInProgress", "SoftwareDetectionFailed", "DiscoveryPending", "DiscoveryInProgress", "DiscoveryFailed", "RegistrationComplete", and "ACSSInstallationBlocked". (InfrastructureDeploymentPending, InfrastructureDeploymentInProgress, InfrastructureDeploymentFailed, SoftwareInstallationPending, SoftwareInstallationInProgress, SoftwareInstallationFailed, SoftwareDetectionInProgress, SoftwareDetectionFailed, DiscoveryPending, DiscoveryInProgress, DiscoveryFailed, RegistrationComplete, ACSSInstallationBlocked)
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)
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". (NonProd, 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". (Unknown, Healthy, Unhealthy, Degraded)
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
managedResourcesNetworkAccessType	string	Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228 _. Known values are: "Public" and "Private". (Public, Private)
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", "Deleting", and "Canceled". (Succeeded, Updating, Creating, Failed, Deleting, Canceled)
sapProduct	string	Defines the SAP Product type. Required. Known values are: "ECC", "S4HANA", and "Other". (ECC, S4HANA, Other)
state	string	Defines the Virtual Instance for SAP state. Known values are: "InfrastructureDeploymentPending", "InfrastructureDeploymentInProgress", "InfrastructureDeploymentFailed", "SoftwareInstallationPending", "SoftwareInstallationInProgress", "SoftwareInstallationFailed", "SoftwareDetectionInProgress", "SoftwareDetectionFailed", "DiscoveryPending", "DiscoveryInProgress", "DiscoveryFailed", "RegistrationComplete", and "ACSSInstallationBlocked". (InfrastructureDeploymentPending, InfrastructureDeploymentInProgress, InfrastructureDeploymentFailed, SoftwareInstallationPending, SoftwareInstallationInProgress, SoftwareInstallationFailed, SoftwareDetectionInProgress, SoftwareDetectionFailed, DiscoveryPending, DiscoveryInProgress, DiscoveryFailed, RegistrationComplete, ACSSInstallationBlocked)
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)
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". (NonProd, 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". (Unknown, Healthy, Unhealthy, Degraded)
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
managedResourcesNetworkAccessType	string	Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228 _. Known values are: "Public" and "Private". (Public, Private)
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", "Failed", "Deleting", and "Canceled". (Succeeded, Updating, Creating, Failed, Deleting, Canceled)
sapProduct	string	Defines the SAP Product type. Required. Known values are: "ECC", "S4HANA", and "Other". (ECC, S4HANA, Other)
state	string	Defines the Virtual Instance for SAP state. Known values are: "InfrastructureDeploymentPending", "InfrastructureDeploymentInProgress", "InfrastructureDeploymentFailed", "SoftwareInstallationPending", "SoftwareInstallationInProgress", "SoftwareInstallationFailed", "SoftwareDetectionInProgress", "SoftwareDetectionFailed", "DiscoveryPending", "DiscoveryInProgress", "DiscoveryFailed", "RegistrationComplete", and "ACSSInstallationBlocked". (InfrastructureDeploymentPending, InfrastructureDeploymentInProgress, InfrastructureDeploymentFailed, SoftwareInstallationPending, SoftwareInstallationInProgress, SoftwareInstallationFailed, SoftwareDetectionInProgress, SoftwareDetectionFailed, DiscoveryPending, DiscoveryInProgress, DiscoveryFailed, RegistrationComplete, ACSSInstallationBlocked)
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)
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		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.
get_sizing_recommendations	exec	location, subscription_id, appLocation, environment, sapProduct, deploymentType, saps, dbMemory, databaseType		Gets the sizing recommendations.
get_sap_supported_sku	exec	location, subscription_id, appLocation, environment, sapProduct, deploymentType, databaseType		Get a list of SAP supported SKUs for ASCS, Application and Database tier.
get_disk_configurations	exec	location, subscription_id, appLocation, environment, sapProduct, databaseType, deploymentType, dbVmSku		Get the SAP Disk Configuration Layout prod/non-prod SAP System.
get_availability_zone_details	exec	location, subscription_id, appLocation, sapProduct, databaseType		Get the recommended SAP Availability Zone Pair Details for your region.
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
location	string	The name of the Azure region. 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 a Virtual Instance for SAP solutions resource.

SELECT
id,
name,
configuration,
environment,
errors,
health,
identity,
location,
managedResourceGroupConfiguration,
managedResourcesNetworkAccessType,
provisioningState,
sapProduct,
state,
status,
systemData,
tags,
type
FROM azure_isv.workloadssapvirtualinstance.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,
managedResourcesNetworkAccessType,
provisioningState,
sapProduct,
state,
status,
systemData,
tags,
type
FROM azure_isv.workloadssapvirtualinstance.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,
managedResourcesNetworkAccessType,
provisioningState,
sapProduct,
state,
status,
systemData,
tags,
type
FROM azure_isv.workloadssapvirtualinstance.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.workloadssapvirtualinstance.sap_virtual_instances (
tags,
location,
properties,
identity,
resource_group_name,
sap_virtual_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ 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: properties
    description: |
      The resource-specific properties for this resource.
    value:
      environment: "{{ environment }}"
      sapProduct: "{{ sapProduct }}"
      managedResourcesNetworkAccessType: "{{ managedResourcesNetworkAccessType }}"
      configuration:
        configurationType: "{{ configurationType }}"
      managedResourceGroupConfiguration:
        name: "{{ name }}"
      status: "{{ status }}"
      health: "{{ health }}"
      state: "{{ state }}"
      provisioningState: "{{ provisioningState }}"
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              details: "{{ details }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates a Virtual Instance for SAP solutions resource.

UPDATE azure_isv.workloadssapvirtualinstance.sap_virtual_instances
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
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.workloadssapvirtualinstance.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

get_sizing_recommendations

Gets the sizing recommendations.

EXEC azure_isv.workloadssapvirtualinstance.sap_virtual_instances.get_sizing_recommendations 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"appLocation": "{{ appLocation }}", 
"environment": "{{ environment }}", 
"sapProduct": "{{ sapProduct }}", 
"deploymentType": "{{ deploymentType }}", 
"saps": {{ saps }}, 
"dbMemory": {{ dbMemory }}, 
"databaseType": "{{ databaseType }}", 
"dbScaleMethod": "{{ dbScaleMethod }}", 
"highAvailabilityType": "{{ highAvailabilityType }}"
}'
;

get_sap_supported_sku

Get a list of SAP supported SKUs for ASCS, Application and Database tier.

EXEC azure_isv.workloadssapvirtualinstance.sap_virtual_instances.get_sap_supported_sku 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"appLocation": "{{ appLocation }}", 
"environment": "{{ environment }}", 
"sapProduct": "{{ sapProduct }}", 
"deploymentType": "{{ deploymentType }}", 
"databaseType": "{{ databaseType }}", 
"highAvailabilityType": "{{ highAvailabilityType }}"
}'
;

get_disk_configurations

Get the SAP Disk Configuration Layout prod/non-prod SAP System.

EXEC azure_isv.workloadssapvirtualinstance.sap_virtual_instances.get_disk_configurations 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"appLocation": "{{ appLocation }}", 
"environment": "{{ environment }}", 
"sapProduct": "{{ sapProduct }}", 
"databaseType": "{{ databaseType }}", 
"deploymentType": "{{ deploymentType }}", 
"dbVmSku": "{{ dbVmSku }}"
}'
;

get_availability_zone_details

Get the recommended SAP Availability Zone Pair Details for your region.

EXEC azure_isv.workloadssapvirtualinstance.sap_virtual_instances.get_availability_zone_details 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"appLocation": "{{ appLocation }}", 
"sapProduct": "{{ sapProduct }}", 
"databaseType": "{{ databaseType }}"
}'
;

start

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

EXEC azure_isv.workloadssapvirtualinstance.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 
@@json=
'{
"startVm": {{ startVm }}
}'
;

stop

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

EXEC azure_isv.workloadssapvirtualinstance.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 }}, 
"deallocateVm": {{ deallocateVm }}
}'
;