SAP Virtual Instances - List By Resource Group

Service:

Workloads

API Version:

2021-12-01-preview

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances?api-version=2021-12-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	SAPVirtualInstanceList	The list of all Virtual Instances for SAP solutions resources.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

SAPVirtualInstances_ListByResourceGroup

Sample request

HTTP

GET https://management.azure.com/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances?api-version=2021-12-01-preview

Java

import com.azure.core.util.Context;

/** Samples for SapVirtualInstances ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/preview/2021-12-01-preview/examples/sapvirtualinstances/SAPVirtualInstances_ListByResourceGroup.json
     */
    /**
     * Sample code: SAPVirtualInstances_ListByResourceGroup.
     *
     * @param manager Entry point to WorkloadsManager.
     */
    public static void sAPVirtualInstancesListByResourceGroup(
        com.azure.resourcemanager.workloads.WorkloadsManager manager) {
        manager.sapVirtualInstances().listByResourceGroup("test-rg", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.workloads import WorkloadsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-workloads
# USAGE
    python sap_virtual_instances_list_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WorkloadsClient(
        credential=DefaultAzureCredential(),
        subscription_id="6d875e77-e412-4d7d-9af4-8895278b4443",
    )

    response = client.sap_virtual_instances.list_by_resource_group(
        resource_group_name="test-rg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/preview/2021-12-01-preview/examples/sapvirtualinstances/SAPVirtualInstances_ListByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armworkloads_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/workloads/armworkloads"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/workloads/resource-manager/Microsoft.Workloads/preview/2021-12-01-preview/examples/sapvirtualinstances/SAPVirtualInstances_ListByResourceGroup.json
func ExampleSAPVirtualInstancesClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armworkloads.NewSAPVirtualInstancesClient("6d875e77-e412-4d7d-9af4-8895278b4443", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("test-rg",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WorkloadsClient } = require("@azure/arm-workloads");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all Virtual Instances for SAP in a resource group.
 *
 * @summary Gets all Virtual Instances for SAP in a resource group.
 * x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/preview/2021-12-01-preview/examples/sapvirtualinstances/SAPVirtualInstances_ListByResourceGroup.json
 */
async function sapVirtualInstancesListByResourceGroup() {
  const subscriptionId = "6d875e77-e412-4d7d-9af4-8895278b4443";
  const resourceGroupName = "test-rg";
  const credential = new DefaultAzureCredential();
  const client = new WorkloadsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sAPVirtualInstances.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

sapVirtualInstancesListByResourceGroup().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Workloads;
using Azure.ResourceManager.Workloads.Models;

// Generated from example definition: specification/workloads/resource-manager/Microsoft.Workloads/preview/2021-12-01-preview/examples/sapvirtualinstances/SAPVirtualInstances_ListByResourceGroup.json
// this example is just showing the usage of "SAPVirtualInstances_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "6d875e77-e412-4d7d-9af4-8895278b4443";
string resourceGroupName = "test-rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SapVirtualInstanceResource
SapVirtualInstanceCollection collection = resourceGroupResource.GetSapVirtualInstances();

// invoke the operation and iterate over the result
await foreach (SapVirtualInstanceResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SapVirtualInstanceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00",
      "name": "X00",
      "type": "Microsoft.Workloads/sapVirtualInstances",
      "tags": {},
      "location": "westcentralus",
      "systemData": {
        "createdBy": "user@xyz.com",
        "createdByType": "User",
        "createdAt": "2021-08-19T15:10:46.196Z",
        "lastModifiedBy": "user@xyz.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-19T15:10:46.196Z"
      },
      "properties": {
        "environment": "Prod",
        "sapProduct": "S4HANA",
        "configuration": {
          "configurationType": "Deployment",
          "appLocation": "eastus",
          "infrastructureConfiguration": {
            "deploymentType": "ThreeTier",
            "appResourceGroup": "X00-RG",
            "centralServer": {
              "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1",
              "virtualMachineConfiguration": {
                "vmSize": "Standard_D8s_v3",
                "imageReference": {
                  "sku": "84sapha-gen2",
                  "publisher": "RedHat",
                  "version": "8.4.2021091202",
                  "offer": "RHEL-SAP-HA"
                },
                "osProfile": {
                  "adminUsername": "{your-username}",
                  "osConfiguration": {
                    "osType": "Linux",
                    "disablePasswordAuthentication": true,
                    "ssh": {
                      "publicKeys": [
                        {
                          "keyData": "ssh-rsa public key"
                        }
                      ]
                    }
                  }
                }
              },
              "instanceCount": 1
            },
            "applicationServer": {
              "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3",
              "virtualMachineConfiguration": {
                "vmSize": "Standard_D8s_v3",
                "imageReference": {
                  "sku": "84sapha-gen2",
                  "publisher": "RedHat",
                  "version": "8.4.2021091202",
                  "offer": "RHEL-SAP-HA"
                },
                "osProfile": {
                  "adminUsername": "{your-username}",
                  "osConfiguration": {
                    "osType": "Linux",
                    "disablePasswordAuthentication": true,
                    "ssh": {
                      "publicKeys": [
                        {
                          "keyData": "ssh-rsa public key"
                        }
                      ]
                    }
                  }
                }
              },
              "instanceCount": 10
            },
            "databaseServer": {
              "databaseType": "HANA",
              "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2",
              "virtualMachineConfiguration": {
                "vmSize": "Standard_D8s_v3",
                "imageReference": {
                  "sku": "84sapha-gen2",
                  "publisher": "RedHat",
                  "version": "8.4.2021091202",
                  "offer": "RHEL-SAP-HA"
                },
                "osProfile": {
                  "adminUsername": "{your-username}",
                  "osConfiguration": {
                    "osType": "Linux",
                    "disablePasswordAuthentication": true,
                    "ssh": {
                      "publicKeys": [
                        {
                          "keyData": "ssh-rsa public key"
                        }
                      ]
                    }
                  }
                }
              },
              "instanceCount": 1
            }
          },
          "softwareConfiguration": {
            "softwareInstallationType": "ServiceInitiated",
            "sapFqdn": "sapsystem.contoso.net",
            "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet",
            "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob",
            "softwareVersion": "SAP S/4HANA 2020 FPS01"
          }
        },
        "managedResourceGroupConfiguration": {
          "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443"
        },
        "status": "Running",
        "health": "Healthy",
        "state": "RegistrationComplete",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X01",
      "name": "X01",
      "type": "Microsoft.Workloads/sapVirtualInstances",
      "tags": {},
      "location": "westcentralus",
      "systemData": {
        "createdBy": "user@xyz.com",
        "createdByType": "User",
        "createdAt": "2021-08-19T15:10:46.196Z",
        "lastModifiedBy": "user@xyz.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-19T15:10:46.196Z"
      },
      "properties": {
        "environment": "Prod",
        "sapProduct": "S4HANA",
        "configuration": {
          "configurationType": "Deployment",
          "appLocation": "eastus",
          "infrastructureConfiguration": {
            "deploymentType": "ThreeTier",
            "appResourceGroup": "X00-RG",
            "centralServer": {
              "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1",
              "virtualMachineConfiguration": {
                "vmSize": "Standard_D8s_v3",
                "imageReference": {
                  "sku": "84sapha-gen2",
                  "publisher": "RedHat",
                  "version": "8.4.2021091202",
                  "offer": "RHEL-SAP-HA"
                },
                "osProfile": {
                  "adminUsername": "{your-username}",
                  "osConfiguration": {
                    "osType": "Linux",
                    "disablePasswordAuthentication": true,
                    "ssh": {
                      "publicKeys": [
                        {
                          "keyData": "ssh-rsa public key"
                        }
                      ]
                    }
                  }
                }
              },
              "instanceCount": 1
            },
            "applicationServer": {
              "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3",
              "virtualMachineConfiguration": {
                "vmSize": "Standard_D8s_v3",
                "imageReference": {
                  "sku": "84sapha-gen2",
                  "publisher": "RedHat",
                  "version": "8.4.2021091202",
                  "offer": "RHEL-SAP-HA"
                },
                "osProfile": {
                  "adminUsername": "{your-username}",
                  "osConfiguration": {
                    "osType": "Linux",
                    "disablePasswordAuthentication": true,
                    "ssh": {
                      "publicKeys": [
                        {
                          "keyData": "ssh-rsa public key"
                        }
                      ]
                    }
                  }
                }
              },
              "instanceCount": 10
            },
            "databaseServer": {
              "databaseType": "HANA",
              "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2",
              "virtualMachineConfiguration": {
                "vmSize": "Standard_D8s_v3",
                "imageReference": {
                  "sku": "84sapha-gen2",
                  "publisher": "RedHat",
                  "version": "8.4.2021091202",
                  "offer": "RHEL-SAP-HA"
                },
                "osProfile": {
                  "adminUsername": "{your-username}",
                  "osConfiguration": {
                    "osType": "Linux",
                    "disablePasswordAuthentication": true,
                    "ssh": {
                      "publicKeys": [
                        {
                          "keyData": "ssh-rsa public key"
                        }
                      ]
                    }
                  }
                }
              },
              "instanceCount": 1
            }
          },
          "softwareConfiguration": {
            "softwareInstallationType": "ServiceInitiated",
            "sapFqdn": "sapsystem.contoso.net",
            "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet",
            "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob",
            "softwareVersion": "SAP S/4HANA 2020 FPS01"
          }
        },
        "status": "Running",
        "health": "Healthy",
        "state": "RegistrationComplete",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitions

Name	Description
ApplicationServerConfiguration	Gets or sets the application server configuration.
CentralServerConfiguration	Gets or sets the central server configuration.
CreateAndMountFileShareConfiguration	Gets or sets the file share configuration where the transport directory fileshare is created and mounted as a part of the create infra flow.
createdByType	The type of identity that created the resource.
DatabaseConfiguration	Gets or sets the database configuration.
DeployerVmPackages	Defines the url and storage account ID where deployer VM packages are uploaded
DeploymentConfiguration	Deployment Configuration.
DeploymentWithOSConfiguration	Deployment along with OS Configuration.
DiscoveryConfiguration	Discovery Details.
DiskConfiguration	The Disk Configuration Details.
DiskSku	The disk sku.
DiskSkuName	Defines the disk sku name.
DiskVolumeConfiguration	The disk configuration required for the selected volume.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDefinition	Error definition.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExternalInstallationSoftwareConfiguration	The SAP Software configuration Input when the software is installed externally outside the service.
HighAvailabilityConfiguration	Gets or sets the high availability configuration.
HighAvailabilitySoftwareConfiguration	Gets or sets the HA software configuration.
ImageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.
LinuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
ManagedRGConfiguration	Managed resource group configuration
ManagedServiceIdentityType	Type of managed service identity (only None, UserAssigned types are allowed).
MountFileShareConfiguration	Gets or sets the file share configuration where the transport directory fileshare already exists, and user wishes to mount the fileshare as a part of the create infra flow.
NetworkConfiguration	Defines the network configuration type for SAP system infrastructure that is being deployed
OSProfile	Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.
OsSapConfiguration	Defines the OS and SAP Configurations for Deployment
SAPDatabaseType	Defines the supported SAP Database types.
SAPDeploymentType	The deployment type. Eg: SingleServer/ThreeTier
SAPEnvironmentType	Defines the environment type - Production/Non Production.
SAPHealthState	Defines the health of SAP Instances.
SAPHighAvailabilityType	The high availability type.
SAPInstallWithoutOSConfigSoftwareConfiguration	The SAP Software configuration Input when the software is to be installed by service without OS Configurations
SAPProductType	Defines the SAP Product type.
SAPSoftwareInstallationType	The SAP software installation Type.
SAPVirtualInstance	Define the Virtual Instance for SAP solutions resource.
SAPVirtualInstanceError	An error response from the Virtual Instance for SAP Workload service.
SAPVirtualInstanceList	Defines the collection of Virtual Instance for SAP solutions resources.
SapVirtualInstanceProvisioningState	Defines the provisioning states.
SAPVirtualInstanceState	Defines the Virtual Instance for SAP state.
SAPVirtualInstanceStatus	Defines the SAP Instance status.
ServiceInitiatedSoftwareConfiguration	The SAP Software configuration Input when the software is to be installed by service.
SingleServerConfiguration	Gets or sets the single server configuration.
SkipFileShareConfiguration	Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required.
SshConfiguration	SSH configuration for Linux based VMs running on Azure
SshKeyPair	The SSH Key-pair used to authenticate with the VM. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.
SshPublicKey	Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
StorageConfiguration	Gets or sets the storage configuration.
systemData	Metadata pertaining to creation and last modification of the resource.
ThreeTierConfiguration	Gets or sets the three tier SAP configuration.
UserAssignedIdentity	User assigned identity properties
UserAssignedServiceIdentity	Managed service identity (user assigned identities)
VirtualMachineConfiguration	Defines the virtual machine configuration.
WindowsConfiguration	Specifies Windows operating system settings on the virtual machine.

ApplicationServerConfiguration

Object

Gets or sets the application server configuration.

Name	Type	Description
instanceCount	integer (int64)	The number of app server instances.
subnetId	string	The subnet id.
virtualMachineConfiguration	VirtualMachineConfiguration	Gets or sets the virtual machine configuration.

CentralServerConfiguration

Object

Gets or sets the central server configuration.

Name	Type	Description
instanceCount	integer (int64)	The number of central server VMs.
subnetId	string	The subnet id.
virtualMachineConfiguration	VirtualMachineConfiguration	Gets or sets the virtual machine configuration.

CreateAndMountFileShareConfiguration

Object

Gets or sets the file share configuration where the transport directory fileshare is created and mounted as a part of the create infra flow.

Name	Type	Description
configurationType	string: CreateAndMount	The type of file share config.
resourceGroup	string	The name of file share resource group. The app rg is used in case of missing input.
storageAccountName	string	The name of file share storage account name . A custom name is used in case of missing input.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DatabaseConfiguration

Object

Gets or sets the database configuration.

Name	Type	Description
databaseType	SAPDatabaseType	The database type.
diskConfiguration	DiskConfiguration	Gets or sets the disk configuration.
instanceCount	integer (int64)	The number of database VMs.
subnetId	string	The subnet id.
virtualMachineConfiguration	VirtualMachineConfiguration	Gets or sets the virtual machine configuration.

DeployerVmPackages

Object

Defines the url and storage account ID where deployer VM packages are uploaded

Name	Type	Description
storageAccountId	string	The deployer VM packages storage account id
url	string	The URL to the deployer VM packages file.

DeploymentConfiguration

Object

Deployment Configuration.

Name	Type	Description
appLocation	string	The geo-location where the SAP system is to be created.
configurationType	string: Deployment	The configuration Type.
infrastructureConfiguration	InfrastructureConfiguration: SingleServerConfiguration ThreeTierConfiguration	The infrastructure configuration.
softwareConfiguration	SoftwareConfiguration: ExternalInstallationSoftwareConfiguration SAPInstallWithoutOSConfigSoftwareConfiguration ServiceInitiatedSoftwareConfiguration	The software configuration.

DeploymentWithOSConfiguration

Object

Deployment along with OS Configuration.

Name	Type	Description
appLocation	string	The geo-location where the SAP system is to be created.
configurationType	string: DeploymentWithOSConfig	The configuration Type.
infrastructureConfiguration	InfrastructureConfiguration: SingleServerConfiguration ThreeTierConfiguration	The infrastructure configuration.
osSapConfiguration	OsSapConfiguration	The OS and SAP configuration.
softwareConfiguration	SoftwareConfiguration: ExternalInstallationSoftwareConfiguration SAPInstallWithoutOSConfigSoftwareConfiguration ServiceInitiatedSoftwareConfiguration	The software configuration.

DiscoveryConfiguration

Object

Discovery Details.

Name	Type	Description
appLocation	string	The geo-location where the SAP system exists.
centralServerVmId	string	The virtual machine ID of the Central Server.
configurationType	string: Discovery	The configuration Type.

DiskConfiguration

Object

The Disk Configuration Details.

Name	Type	Description
diskVolumeConfigurations	<string,  DiskVolumeConfiguration>	The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup'].

DiskSku

Object

The disk sku.

Name	Type	Description
name	DiskSkuName	Defines the disk sku name.

DiskSkuName

Enumeration

Defines the disk sku name.

Value	Description
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

DiskVolumeConfiguration

Object

The disk configuration required for the selected volume.

Name	Type	Description
count	integer (int64)	The total number of disks required for the concerned volume.
sizeGB	integer (int64)	The disk size in GB.
sku	DiskSku	The disk SKU details.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDefinition

Object

Error definition.

Name	Type	Description
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	ErrorDefinition[]	Internal error details.
message	string	Description of the error.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExternalInstallationSoftwareConfiguration

Object

The SAP Software configuration Input when the software is installed externally outside the service.

Name	Type	Description
centralServerVmId	string	The resource ID of the virtual machine containing the central server instance.
softwareInstallationType	string: External	The SAP software installation Type.

HighAvailabilityConfiguration

Object

Gets or sets the high availability configuration.

Name	Type	Description
highAvailabilityType	SAPHighAvailabilityType	The high availability type.

HighAvailabilitySoftwareConfiguration

Object

Gets or sets the HA software configuration.

Name	Type	Description
fencingClientId	string	The fencing client id.
fencingClientPassword	string	The fencing client id secret/password. The secret should never expire. This will be used pacemaker to start/stop the cluster VMs.

ImageReference

Object

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Name	Type	Description
exactVersion	string	Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.
offer	string	Specifies the offer of the platform image or marketplace image used to create the virtual machine.
publisher	string	The image publisher.
sharedGalleryImageId	string	Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
sku	string	The image SKU.
version	string	Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available.

LinuxConfiguration

Object

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Name	Type	Description
disablePasswordAuthentication	boolean	Specifies whether password authentication should be disabled.
osType	string: Linux	The OS Type
ssh	SshConfiguration	Specifies the ssh key configuration for a Linux OS. (This property is deprecated, please use 'sshKeyPair' instead)
sshKeyPair	SshKeyPair	The SSH Key-pair used to authenticate with the VM's.

ManagedRGConfiguration

Object

Managed resource group configuration

Name	Type	Description
name	string	Managed resource group name

ManagedServiceIdentityType

Enumeration

Type of managed service identity (only None, UserAssigned types are allowed).

Value	Description
None
UserAssigned

MountFileShareConfiguration

Object

Gets or sets the file share configuration where the transport directory fileshare already exists, and user wishes to mount the fileshare as a part of the create infra flow.

Name	Type	Description
configurationType	string: Mount	The type of file share config.
id	string	The fileshare resource ID
privateEndpointId	string	The private endpoint resource ID

NetworkConfiguration

Object

Defines the network configuration type for SAP system infrastructure that is being deployed

Name	Type	Default value	Description
isSecondaryIpEnabled	boolean	False	Specifies whether a secondary IP address should be added to the network interface on all VMs of the SAP system being deployed

OSProfile

Object

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Name	Type	Description
adminPassword	string	Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
adminUsername	string	Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.
osConfiguration	OSConfiguration: LinuxConfiguration WindowsConfiguration	Specifies Windows operating system settings on the virtual machine.

OsSapConfiguration

Object

Defines the OS and SAP Configurations for Deployment

Name	Type	Description
deployerVmPackages	DeployerVmPackages	The url and storage account ID where deployer VM packages are uploaded
sapFqdn	string	The FQDN to set for the SAP system

SAPDatabaseType

Enumeration

Defines the supported SAP Database types.

Value	Description
HANA
DB2

SAPDeploymentType

Enumeration

The deployment type. Eg: SingleServer/ThreeTier

Value	Description
SingleServer
ThreeTier

SAPEnvironmentType

Enumeration

Defines the environment type - Production/Non Production.

Value	Description
NonProd
Prod

SAPHealthState

Enumeration

Defines the health of SAP Instances.

Value	Description
Unknown
Healthy
Unhealthy
Degraded

SAPHighAvailabilityType

Enumeration

The high availability type.

Value	Description
AvailabilitySet
AvailabilityZone

SAPInstallWithoutOSConfigSoftwareConfiguration

Object

The SAP Software configuration Input when the software is to be installed by service without OS Configurations

Name	Type	Description
bomUrl	string	The URL to the SAP Build of Materials(BOM) file.
highAvailabilitySoftwareConfiguration	HighAvailabilitySoftwareConfiguration	Gets or sets the HA software configuration.
sapBitsStorageAccountId	string	The SAP bits storage account id.
softwareInstallationType	string: SAPInstallWithoutOSConfig	The SAP software installation Type.
softwareVersion	string	The software version to install.

SAPProductType

Enumeration

Defines the SAP Product type.

Value	Description
ECC
S4HANA
Other

SAPSoftwareInstallationType

Enumeration

The SAP software installation Type.

Value	Description
ServiceInitiated
SAPInstallWithoutOSConfig
External

SAPVirtualInstance

Object

Define the Virtual Instance for SAP solutions resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	UserAssignedServiceIdentity	Managed service identity (user assigned identities)
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.configuration	SAPConfiguration: DeploymentConfiguration DeploymentWithOSConfiguration DiscoveryConfiguration	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
properties.environment	SAPEnvironmentType	Defines the environment type - Production/Non Production.
properties.errors	SAPVirtualInstanceError	Indicates any errors on the Virtual Instance for SAP solutions resource.
properties.health	SAPHealthState	Defines the health of SAP Instances.
properties.managedResourceGroupConfiguration	ManagedRGConfiguration	Managed resource group configuration
properties.provisioningState	SapVirtualInstanceProvisioningState	Defines the provisioning states.
properties.sapProduct	SAPProductType	Defines the SAP Product type.
properties.state	SAPVirtualInstanceState	Defines the Virtual Instance for SAP state.
properties.status	SAPVirtualInstanceStatus	Defines the SAP Instance status.
systemData	systemData	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"

SAPVirtualInstanceError

Object

An error response from the Virtual Instance for SAP Workload service.

Name	Type	Description
properties	ErrorDefinition	The Virtual Instance for SAP error body.

SAPVirtualInstanceList

Object

Defines the collection of Virtual Instance for SAP solutions resources.

Name	Type	Description
nextLink	string	Gets the value of next link.
value	SAPVirtualInstance[]	Gets the list of Virtual Instances for SAP solutions resources.

SapVirtualInstanceProvisioningState

Enumeration

Defines the provisioning states.

Value	Description
Succeeded
Updating
Creating
Failed
Deleting

SAPVirtualInstanceState

Enumeration

Defines the Virtual Instance for SAP state.

Value	Description
InfrastructureDeploymentPending
InfrastructureDeploymentInProgress
InfrastructureDeploymentFailed
SoftwareInstallationPending
SoftwareInstallationInProgress
SoftwareInstallationFailed
SoftwareDetectionInProgress
SoftwareDetectionFailed
DiscoveryPending
DiscoveryInProgress
DiscoveryFailed
RegistrationComplete

SAPVirtualInstanceStatus

Enumeration

Defines the SAP Instance status.

Value	Description
Starting
Running
Stopping
Offline
PartiallyRunning
Unavailable

ServiceInitiatedSoftwareConfiguration

Object

The SAP Software configuration Input when the software is to be installed by service.

Name	Type	Description
bomUrl	string	The URL to the SAP Build of Materials(BOM) file.
highAvailabilitySoftwareConfiguration	HighAvailabilitySoftwareConfiguration	Gets or sets the HA software configuration.
sapBitsStorageAccountId	string	The SAP bits storage account id.
sapFqdn	string	The FQDN to set for the SAP system during install.
softwareInstallationType	string: ServiceInitiated	The SAP software installation Type.
softwareVersion	string	The software version to install.
sshPrivateKey	string	The SSH private key.

SingleServerConfiguration

Object

Gets or sets the single server configuration.

Name	Type	Description
appResourceGroup	string	The application resource group where SAP system resources will be deployed.
databaseType	SAPDatabaseType	The database type.
dbDiskConfiguration	DiskConfiguration	Gets or sets the disk configuration.
deploymentType	string: SingleServer	The type of SAP deployment, single server or Three tier.
networkConfiguration	NetworkConfiguration	Network configuration for the server
subnetId	string	The subnet id.
virtualMachineConfiguration	VirtualMachineConfiguration	Gets or sets the virtual machine configuration.

SkipFileShareConfiguration

Object

Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required.

Name	Type	Description
configurationType	string: Skip	The type of file share config.

SshConfiguration

Object

SSH configuration for Linux based VMs running on Azure

Name	Type	Description
publicKeys	SshPublicKey[]	The list of SSH public keys used to authenticate with linux based VMs.

SshKeyPair

Object

The SSH Key-pair used to authenticate with the VM. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.

Name	Type	Description
privateKey	string	SSH private key.
publicKey	string	SSH public key

SshPublicKey

Object

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Name	Type	Description
keyData	string	SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.

StorageConfiguration

Object

Gets or sets the storage configuration.

Name	Type	Description
transportFileShareConfiguration	FileShareConfiguration: CreateAndMountFileShareConfiguration MountFileShareConfiguration SkipFileShareConfiguration	The properties of the transport directory attached to the VIS. The default for transportFileShareConfiguration is the createAndMount flow if storage configuration is missing.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

ThreeTierConfiguration

Object

Gets or sets the three tier SAP configuration.

Name	Type	Description
appResourceGroup	string	The application resource group where SAP system resources will be deployed.
applicationServer	ApplicationServerConfiguration	The application server configuration.
centralServer	CentralServerConfiguration	The central server configuration.
databaseServer	DatabaseConfiguration	The database configuration.
deploymentType	string: ThreeTier	The type of SAP deployment, single server or Three tier.
highAvailabilityConfig	HighAvailabilityConfiguration	The high availability configuration.
networkConfiguration	NetworkConfiguration	Network configuration common to all servers
storageConfiguration	StorageConfiguration	The storage configuration.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

UserAssignedServiceIdentity

Object

Managed service identity (user assigned identities)

Name	Type	Description
type	ManagedServiceIdentityType	Type of manage identity
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities User assigned identities dictionary

VirtualMachineConfiguration

Object

Defines the virtual machine configuration.

Name	Type	Description
imageReference	ImageReference	The image reference.
osProfile	OSProfile	The OS profile.
vmSize	string	The virtual machine size.

WindowsConfiguration

Object

Specifies Windows operating system settings on the virtual machine.

Name	Type	Description
osType	string: Windows	The OS Type