SAP Application Server Instances - List

Service:

Workloads

API Version:

2023-04-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances?api-version=2023-04-01

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.
sapVirtualInstanceName	path	True	string	The name of the Virtual Instances for SAP solutions resource
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	SAPApplicationServerInstanceList	List of SAP Application Server Instance 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

SAPApplicationServerInstances_List

Sample request

HTTP

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

Java

/**
 * Samples for SapApplicationServerInstances List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/
     * SAPApplicationServerInstances_List.json
     */
    /**
     * Sample code: SAPApplicationServerInstances_List.
     * 
     * @param manager Entry point to WorkloadsManager.
     */
    public static void sAPApplicationServerInstancesList(com.azure.resourcemanager.workloads.WorkloadsManager manager) {
        manager.sapApplicationServerInstances().list("test-rg", "X00", com.azure.core.util.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 WorkloadsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-workloads
# USAGE
    python sap_application_server_instances_list.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 = WorkloadsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="6d875e77-e412-4d7d-9af4-8895278b4443",
    )

    response = client.sap_application_server_instances.list(
        resource_group_name="test-rg",
        sap_virtual_instance_name="X00",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPApplicationServerInstances_List.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/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPApplicationServerInstances_List.json
func ExampleSAPApplicationServerInstancesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armworkloads.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSAPApplicationServerInstancesClient().NewListPager("test-rg", "X00", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SAPApplicationServerInstanceList = armworkloads.SAPApplicationServerInstanceList{
		// 	Value: []*armworkloads.SAPApplicationServerInstance{
		// 		{
		// 			Name: to.Ptr("app01"),
		// 			Type: to.Ptr("Microsoft.Workloads/sapVirtualInstances/applicationInstances"),
		// 			ID: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01"),
		// 			SystemData: &armworkloads.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
		// 				CreatedBy: to.Ptr("user@xyz.com"),
		// 				CreatedByType: to.Ptr(armworkloads.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user@xyz.com"),
		// 				LastModifiedByType: to.Ptr(armworkloads.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("westcentralus"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armworkloads.SAPApplicationServerProperties{
		// 				GatewayPort: to.Ptr[int64](3300),
		// 				Health: to.Ptr(armworkloads.SAPHealthStateUnknown),
		// 				Hostname: to.Ptr("vh-nw1"),
		// 				IcmHTTPPort: to.Ptr[int64](3312),
		// 				IcmHTTPSPort: to.Ptr[int64](3313),
		// 				InstanceNo: to.Ptr("00"),
		// 				IPAddress: to.Ptr("10.0.0.5"),
		// 				KernelPatch: to.Ptr("patch 300"),
		// 				KernelVersion: to.Ptr("777"),
		// 				ProvisioningState: to.Ptr(armworkloads.SapVirtualInstanceProvisioningStateSucceeded),
		// 				Status: to.Ptr(armworkloads.SAPVirtualInstanceStatus("Unknown")),
		// 				VMDetails: []*armworkloads.ApplicationServerVMDetails{
		// 					{
		// 						Type: to.Ptr(armworkloads.ApplicationServerVirtualMachineTypeActive),
		// 						VirtualMachineID: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm"),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("app02"),
		// 			Type: to.Ptr("Microsoft.Workloads/sapVirtualInstances/applicationInstances"),
		// 			ID: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app02"),
		// 			SystemData: &armworkloads.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
		// 				CreatedBy: to.Ptr("user@xyz.com"),
		// 				CreatedByType: to.Ptr(armworkloads.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user@xyz.com"),
		// 				LastModifiedByType: to.Ptr(armworkloads.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("westcentralus"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armworkloads.SAPApplicationServerProperties{
		// 				GatewayPort: to.Ptr[int64](3300),
		// 				Health: to.Ptr(armworkloads.SAPHealthStateUnknown),
		// 				Hostname: to.Ptr("vh-nw1"),
		// 				IcmHTTPPort: to.Ptr[int64](3312),
		// 				IcmHTTPSPort: to.Ptr[int64](3313),
		// 				InstanceNo: to.Ptr("01"),
		// 				IPAddress: to.Ptr("10.0.0.5"),
		// 				KernelPatch: to.Ptr("patch 300"),
		// 				KernelVersion: to.Ptr("777"),
		// 				ProvisioningState: to.Ptr(armworkloads.SapVirtualInstanceProvisioningStateSucceeded),
		// 				Status: to.Ptr(armworkloads.SAPVirtualInstanceStatus("Unknown")),
		// 				VMDetails: []*armworkloads.ApplicationServerVMDetails{
		// 					{
		// 						Type: to.Ptr(armworkloads.ApplicationServerVirtualMachineTypeActive),
		// 						VirtualMachineID: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

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 Lists the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource.
 *
 * @summary Lists the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource.
 * x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPApplicationServerInstances_List.json
 */
async function sapApplicationServerInstancesList() {
  const subscriptionId =
    process.env["WORKLOADS_SUBSCRIPTION_ID"] || "6d875e77-e412-4d7d-9af4-8895278b4443";
  const resourceGroupName = process.env["WORKLOADS_RESOURCE_GROUP"] || "test-rg";
  const sapVirtualInstanceName = "X00";
  const credential = new DefaultAzureCredential();
  const client = new WorkloadsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sAPApplicationServerInstances.list(
    resourceGroupName,
    sapVirtualInstanceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Workloads;

// Generated from example definition: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPApplicationServerInstances_List.json
// this example is just showing the usage of "SAPApplicationServerInstances_List" 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 SapVirtualInstanceResource created on azure
// for more information of creating SapVirtualInstanceResource, please refer to the document of SapVirtualInstanceResource
string subscriptionId = "6d875e77-e412-4d7d-9af4-8895278b4443";
string resourceGroupName = "test-rg";
string sapVirtualInstanceName = "X00";
ResourceIdentifier sapVirtualInstanceResourceId = SapVirtualInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, sapVirtualInstanceName);
SapVirtualInstanceResource sapVirtualInstance = client.GetSapVirtualInstanceResource(sapVirtualInstanceResourceId);

// get the collection of this SapApplicationServerInstanceResource
SapApplicationServerInstanceCollection collection = sapVirtualInstance.GetSapApplicationServerInstances();

// invoke the operation and iterate over the result
await foreach (SapApplicationServerInstanceResource 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
    SapApplicationServerInstanceData 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/applicationInstances/app01",
      "name": "app01",
      "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances",
      "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": {
        "instanceNo": "00",
        "subnet": null,
        "hostname": "vh-nw1",
        "kernelVersion": "777",
        "kernelPatch": "patch 300",
        "ipAddress": "10.0.0.5",
        "gatewayPort": 3300,
        "icmHttpPort": 3312,
        "icmHttpsPort": 3313,
        "vmDetails": [
          {
            "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm",
            "type": "Active"
          }
        ],
        "status": "Unknown",
        "health": "Unknown",
        "errors": null,
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app02",
      "name": "app02",
      "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances",
      "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": {
        "instanceNo": "01",
        "subnet": null,
        "hostname": "vh-nw1",
        "kernelVersion": "777",
        "kernelPatch": "patch 300",
        "ipAddress": "10.0.0.5",
        "gatewayPort": 3300,
        "icmHttpPort": 3312,
        "icmHttpsPort": 3313,
        "vmDetails": [
          {
            "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm",
            "type": "Active"
          }
        ],
        "status": "Unknown",
        "health": "Unknown",
        "errors": null,
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitions

Name	Description
ApplicationServerVirtualMachineType	Defines the type of application server VM.
ApplicationServerVmDetails	The Application Server VM Details.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDefinition	Error definition.
ErrorDetail	The error detail.
ErrorResponse	Error response
LoadBalancerDetails	The Load Balancer details such as Load Balancer ID.
SAPApplicationServerInstance	Define the SAP Application Server Instance resource.
SAPApplicationServerInstanceList	Defines the collection of SAP Application Server Instance resources.
SAPHealthState	Defines the health of SAP Instances.
SAPVirtualInstanceError	An error response from the Virtual Instance for SAP Workload service.
SapVirtualInstanceProvisioningState	Defines the provisioning states.
SAPVirtualInstanceStatus	Defines the SAP Instance status.
StorageInformation	Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage.
systemData	Metadata pertaining to creation and last modification of the resource.

ApplicationServerVirtualMachineType

Enumeration

Defines the type of application server VM.

Value	Description
Active
Standby
Unknown

ApplicationServerVmDetails

Object

The Application Server VM Details.

Name	Type	Description
storageDetails	StorageInformation[]	Storage details of all the Storage Accounts attached to the App Virtual Machine. For e.g. NFS on AFS Shared Storage.
type	ApplicationServerVirtualMachineType	Defines the type of application server VM.
virtualMachineId	string

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

LoadBalancerDetails

Object

The Load Balancer details such as Load Balancer ID.

Name	Type	Description
id	string

SAPApplicationServerInstance

Object

Define the SAP Application Server Instance resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.errors	SAPVirtualInstanceError	Defines the Application Instance errors.
properties.gatewayPort	integer (int64)	Application server instance gateway Port.
properties.health	SAPHealthState	Defines the health of SAP Instances.
properties.hostname	string	Application server instance SAP hostname.
properties.icmHttpPort	integer (int64)	Application server instance ICM HTTP Port.
properties.icmHttpsPort	integer (int64)	Application server instance ICM HTTPS Port.
properties.instanceNo	string	Application server Instance Number.
properties.ipAddress	string	Application server instance SAP IP Address.
properties.kernelPatch	string	Application server instance SAP Kernel Patch level.
properties.kernelVersion	string	Application server instance SAP Kernel Version.
properties.loadBalancerDetails	LoadBalancerDetails	The Load Balancer details such as LoadBalancer ID attached to Application Server Virtual Machines
properties.provisioningState	SapVirtualInstanceProvisioningState	Defines the provisioning states.
properties.status	SAPVirtualInstanceStatus	Defines the SAP Instance status.
properties.subnet	string	Application server Subnet.
properties.vmDetails	ApplicationServerVmDetails[]	The list of virtual machines.
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"

SAPApplicationServerInstanceList

Object

Defines the collection of SAP Application Server Instance resources.

Name	Type	Description
nextLink	string	Gets the value of next link.
value	SAPApplicationServerInstance[]	Gets the list of SAP Application Server instance resources.

SAPHealthState

Enumeration

Defines the health of SAP Instances.

Value	Description
Unknown
Healthy
Unhealthy
Degraded

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.

SapVirtualInstanceProvisioningState

Enumeration

Defines the provisioning states.

Value	Description
Succeeded
Updating
Creating
Failed
Deleting

SAPVirtualInstanceStatus

Enumeration

Defines the SAP Instance status.

Value	Description
Starting
Running
Stopping
Offline
PartiallyRunning
Unavailable
SoftShutdown

StorageInformation

Object

Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage.

Name	Type	Description
id	string

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.