SAP Application Server Instances - Get

Servicio:

Workloads

Versión de la API:

2023-04-01

Obtiene la instancia del servidor de aplicaciones de SAP correspondiente al recurso de instancia virtual para soluciones de SAP.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
applicationInstanceName	path	True	string	Nombre del recurso de instancia del servidor de aplicaciones de SAP.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
sapVirtualInstanceName	path	True	string	Nombre del recurso Instancias virtuales para soluciones de SAP
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	SAPApplicationServerInstance	Describe la instancia del servidor de aplicaciones de SAP.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SAPApplicationServerInstances_Get

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for SapApplicationServerInstances Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/
     * SAPApplicationServerInstances_Get.json
     */
    /**
     * Sample code: SAPApplicationServerInstances_Get.
     * 
     * @param manager Entry point to WorkloadsManager.
     */
    public static void sAPApplicationServerInstancesGet(com.azure.resourcemanager.workloads.WorkloadsManager manager) {
        manager.sapApplicationServerInstances().getWithResponse("test-rg", "X00", "app01",
            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_get.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.get(
        resource_group_name="test-rg",
        sap_virtual_instance_name="X00",
        application_instance_name="app01",
    )
    print(response)


# x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPApplicationServerInstances_Get.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_Get.json
func ExampleSAPApplicationServerInstancesClient_Get() {
	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)
	}
	res, err := clientFactory.NewSAPApplicationServerInstancesClient().Get(ctx, "test-rg", "X00", "app01", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SAPApplicationServerInstance = 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"),
	// 		}},
	// 	},
	// }
}

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 the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.
 *
 * @summary Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.
 * x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPApplicationServerInstances_Get.json
 */
async function sapApplicationServerInstancesGet() {
  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 applicationInstanceName = "app01";
  const credential = new DefaultAzureCredential();
  const client = new WorkloadsClient(credential, subscriptionId);
  const result = await client.sAPApplicationServerInstances.get(
    resourceGroupName,
    sapVirtualInstanceName,
    applicationInstanceName
  );
  console.log(result);
}

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_Get.json
// this example is just showing the usage of "SAPApplicationServerInstances_Get" 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
string applicationInstanceName = "app01";
NullableResponse<SapApplicationServerInstanceResource> response = await collection.GetIfExistsAsync(applicationInstanceName);
SapApplicationServerInstanceResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Respuesta de muestra

status code:

200

{
  "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"
  }
}

Definiciones

Nombre	Description
ApplicationServerVirtualMachineType	Define el tipo de máquina virtual del servidor de aplicaciones.
ApplicationServerVmDetails	Detalles de la máquina virtual del servidor de aplicaciones.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDefinition	Definición de error.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LoadBalancerDetails	Detalles del equilibrador de carga, como el identificador de Load Balancer.
SAPApplicationServerInstance	Defina el recurso instancia del servidor de aplicaciones de SAP.
SAPHealthState	Define el estado de las instancias de SAP.
SAPVirtualInstanceError	Respuesta de error del servicio De carga de trabajo de Instancia virtual para SAP.
SapVirtualInstanceProvisioningState	Define los estados de aprovisionamiento.
SAPVirtualInstanceStatus	Define el estado de la instancia de SAP.
StorageInformation	Detalles de almacenamiento de todas las cuentas de almacenamiento asociadas a la máquina virtual. Por ejemplo, NFS en el almacenamiento compartido de AFS.
systemData	Metadatos relativos a la creación y última modificación del recurso.

ApplicationServerVirtualMachineType

Enumeración

Define el tipo de máquina virtual del servidor de aplicaciones.

Valor	Description
Active
Standby
Unknown

ApplicationServerVmDetails

Object

Detalles de la máquina virtual del servidor de aplicaciones.

Nombre	Tipo	Description
storageDetails	StorageInformation[]	Detalles de almacenamiento de todas las cuentas de almacenamiento asociadas a la máquina virtual de la aplicación. Por ejemplo, NFS en el almacenamiento compartido de AFS.
type	ApplicationServerVirtualMachineType	Define el tipo de máquina virtual del servidor de aplicaciones.
virtualMachineId	string

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDefinition

Object

Definición de error.

Nombre	Tipo	Description
code	string	Código de error específico del servicio que actúa como subestado para el código de error HTTP.
details	ErrorDefinition[]	Detalles internos del error.
message	string	Descripción del error.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

LoadBalancerDetails

Object

Detalles del equilibrador de carga, como el identificador de Load Balancer.

Nombre	Tipo	Description
id	string

SAPApplicationServerInstance

Object

Defina el recurso instancia del servidor de aplicaciones de SAP.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.errors	SAPVirtualInstanceError	Define los errores de instancia de aplicación.
properties.gatewayPort	integer (int64)	Puerto de puerta de enlace de instancia del servidor de aplicaciones.
properties.health	SAPHealthState	Define el estado de las instancias de SAP.
properties.hostname	string	Nombre de host de SAP de la instancia del servidor de aplicaciones.
properties.icmHttpPort	integer (int64)	Puerto HTTP de la instancia del servidor de aplicaciones ICM.
properties.icmHttpsPort	integer (int64)	Instancia del servidor de aplicaciones Puerto HTTPS de ICM.
properties.instanceNo	string	Número de instancia del servidor de aplicaciones.
properties.ipAddress	string	Dirección IP de SAP de la instancia del servidor de aplicaciones.
properties.kernelPatch	string	Nivel de revisión del kernel de SAP de la instancia del servidor de aplicaciones.
properties.kernelVersion	string	Versión del kernel de SAP de la instancia del servidor de aplicaciones.
properties.loadBalancerDetails	LoadBalancerDetails	Detalles del equilibrador de carga, como loadBalancer ID asociado a las máquinas virtuales del servidor de aplicaciones
properties.provisioningState	SapVirtualInstanceProvisioningState	Define los estados de aprovisionamiento.
properties.status	SAPVirtualInstanceStatus	Define el estado de la instancia de SAP.
properties.subnet	string	Subred del servidor de aplicaciones.
properties.vmDetails	ApplicationServerVmDetails[]	Lista de máquinas virtuales.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SAPHealthState

Enumeración

Define el estado de las instancias de SAP.

Valor	Description
Degraded
Healthy
Unhealthy
Unknown

SAPVirtualInstanceError

Object

Respuesta de error del servicio De carga de trabajo de Instancia virtual para SAP.

Nombre	Tipo	Description
properties	ErrorDefinition	Instancia virtual para el cuerpo del error de SAP.

SapVirtualInstanceProvisioningState

Enumeración

Define los estados de aprovisionamiento.

Valor	Description
Creating
Deleting
Failed
Succeeded
Updating

SAPVirtualInstanceStatus

Enumeración

Define el estado de la instancia de SAP.

Valor	Description
Offline
PartiallyRunning
Running
SoftShutdown
Starting
Stopping
Unavailable

StorageInformation

Object

Detalles de almacenamiento de todas las cuentas de almacenamiento asociadas a la máquina virtual. Por ejemplo, NFS en el almacenamiento compartido de AFS.

Nombre	Tipo	Description
id	string

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.