monitors - Get

Servicio:

Workloads

Versión de la API:

2023-04-01

Obtiene las propiedades de un monitor de SAP para la suscripción, el grupo de recursos y el nombre de recurso especificados.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
monitorName	path	True	string	Nombre del recurso de supervisión de SAP.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
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	Monitor	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

Get properties of a SAP monitor

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Workloads/monitors/mySapMonitor?api-version=2023-04-01

Java

/**
 * Samples for Monitors GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/workloadmonitor/
     * monitors_Get.json
     */
    /**
     * Sample code: Get properties of a SAP monitor.
     * 
     * @param manager Entry point to WorkloadsManager.
     */
    public static void getPropertiesOfASAPMonitor(com.azure.resourcemanager.workloads.WorkloadsManager manager) {
        manager.monitors().getByResourceGroupWithResponse("myResourceGroup", "mySapMonitor",
            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 monitors_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="00000000-0000-0000-0000-000000000000",
    )

    response = client.monitors.get(
        resource_group_name="myResourceGroup",
        monitor_name="mySapMonitor",
    )
    print(response)


# x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/workloadmonitor/monitors_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/workloadmonitor/monitors_Get.json
func ExampleMonitorsClient_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.NewMonitorsClient().Get(ctx, "myResourceGroup", "mySapMonitor", 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.Monitor = armworkloads.Monitor{
	// 	Name: to.Ptr("mySapMonitor1"),
	// 	Type: to.Ptr("Microsoft.Workloads/monitors"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Workloads/monitors/mySapMonitor"),
	// 	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("westus"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armworkloads.MonitorProperties{
	// 		AppLocation: to.Ptr("eastus"),
	// 		Errors: &armworkloads.MonitorPropertiesErrors{
	// 		},
	// 		LogAnalyticsWorkspaceArmID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/myWorkspace"),
	// 		ManagedResourceGroupConfiguration: &armworkloads.ManagedRGConfiguration{
	// 			Name: to.Ptr("myManagedRg"),
	// 		},
	// 		MonitorSubnet: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"),
	// 		MsiArmID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myMsi"),
	// 		ProvisioningState: to.Ptr(armworkloads.WorkloadMonitorProvisioningStateSucceeded),
	// 		RoutingPreference: to.Ptr(armworkloads.RoutingPreferenceRouteAll),
	// 		StorageAccountArmID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount"),
	// 		ZoneRedundancyPreference: to.Ptr("ZoneRedundantApp"),
	// 	},
	// }
}

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 properties of a SAP monitor for the specified subscription, resource group, and resource name.
 *
 * @summary Gets properties of a SAP monitor for the specified subscription, resource group, and resource name.
 * x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/workloadmonitor/monitors_Get.json
 */
async function getPropertiesOfASapMonitor() {
  const subscriptionId =
    process.env["WORKLOADS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["WORKLOADS_RESOURCE_GROUP"] || "myResourceGroup";
  const monitorName = "mySapMonitor";
  const credential = new DefaultAzureCredential();
  const client = new WorkloadsClient(credential, subscriptionId);
  const result = await client.monitors.get(resourceGroupName, monitorName);
  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.Models;
using Azure.ResourceManager.Workloads;

// Generated from example definition: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/workloadmonitor/monitors_Get.json
// this example is just showing the usage of "monitors_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 SapMonitorResource created on azure
// for more information of creating SapMonitorResource, please refer to the document of SapMonitorResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myResourceGroup";
string monitorName = "mySapMonitor";
ResourceIdentifier sapMonitorResourceId = SapMonitorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, monitorName);
SapMonitorResource sapMonitor = client.GetSapMonitorResource(sapMonitorResourceId);

// invoke the operation
SapMonitorResource result = await sapMonitor.GetAsync();

// 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
SapMonitorData 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/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Workloads/monitors/mySapMonitor",
  "name": "mySapMonitor1",
  "type": "Microsoft.Workloads/monitors",
  "location": "westus",
  "tags": {
    "key": "value"
  },
  "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": {
    "provisioningState": "Succeeded",
    "errors": [
      {
        "code": "0000",
        "message": "Error message",
        "target": "",
        "details": "Error details",
        "innerError": "Error stack trace"
      }
    ],
    "appLocation": "eastus",
    "routingPreference": "RouteAll",
    "zoneRedundancyPreference": "ZoneRedundantApp",
    "managedResourceGroupConfiguration": {
      "name": "myManagedRg"
    },
    "logAnalyticsWorkspaceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/myWorkspace",
    "monitorSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet",
    "msiArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myMsi",
    "storageAccountArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
Error	Objeto de error estándar.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Errors	Define los errores del monitor de SAP.
InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
ManagedRGConfiguration	Configuración del grupo de recursos administrado
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (solo se permiten tipos None, UserAssigned).
Monitor	Información de supervisión de SAP en Azure (propiedades de ARM y propiedades de supervisión de SAP)
RoutingPreference	Establece la preferencia de enrutamiento del monitor de SAP. De forma predeterminada, solo se enruta el tráfico RFC1918 a la red virtual del cliente.
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
UserAssignedServiceIdentity	Una identidad asignada previamente por el usuario con los roles adecuados asignados. Para más información sobre la identidad y los roles necesarios, visite la guía paso a paso de ACSS.
WorkloadMonitorProvisioningState	Estado del aprovisionamiento del monitor de SAP.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

Error

Object

Objeto de error estándar.

Nombre	Tipo	Description
code	string	Conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innerError	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

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.

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.

Errors

Object

Define los errores del monitor de SAP.

Nombre	Tipo	Description
code	string	Conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innerError	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

InnerError

Object

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre	Tipo	Description
innerError	Error	Objeto de error estándar.

ManagedRGConfiguration

Object

Configuración del grupo de recursos administrado

Nombre	Tipo	Description
name	string	Nombre del grupo de recursos administrado

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (solo se permiten tipos None, UserAssigned).

Valor	Description
None
UserAssigned

Monitor

Object

Información de supervisión de SAP en Azure (propiedades de ARM y propiedades de supervisión de SAP)

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	UserAssignedServiceIdentity	[actualmente no está en uso] Identidades de servicio administradas (identidades asignadas por el usuario)
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.appLocation	string	Los recursos de supervisión de SAP se implementarán en la región de supervisión de SAP. La región de subred debe ser la misma que la región de supervisión de SAP.
properties.errors	Errors	Define los errores del monitor de SAP.
properties.logAnalyticsWorkspaceArmId	string	Identificador de ARM del área de trabajo de Log Analytics que se usa para la supervisión de SAP.
properties.managedResourceGroupConfiguration	ManagedRGConfiguration	Configuración del grupo de recursos administrado
properties.monitorSubnet	string	Subred en la que se implementará el monitor de SAP.
properties.msiArmId	string	El identificador de ARM de MSI que se usa para la supervisión de SAP.
properties.provisioningState	WorkloadMonitorProvisioningState	Estado del aprovisionamiento del monitor de SAP.
properties.routingPreference	RoutingPreference	Establece la preferencia de enrutamiento del monitor de SAP. De forma predeterminada, solo se enruta el tráfico RFC1918 a la red virtual del cliente.
properties.storageAccountArmId	string	Identificador de ARM de la cuenta de almacenamiento que se usa para la supervisión de SAP.
properties.zoneRedundancyPreference	string	Establece la preferencia de redundancia de zona en los recursos creados para el monitor de SAP. De forma predeterminada, se crearán recursos que no admiten redundancia de zona.
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"

RoutingPreference

Enumeración

Establece la preferencia de enrutamiento del monitor de SAP. De forma predeterminada, solo se enruta el tráfico RFC1918 a la red virtual del cliente.

Valor	Description
Default
RouteAll

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.

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

UserAssignedServiceIdentity

Object

Una identidad asignada previamente por el usuario con los roles adecuados asignados. Para más información sobre la identidad y los roles necesarios, visite la guía paso a paso de ACSS.

Nombre	Tipo	Description
type	ManagedServiceIdentityType	Tipo de identidad de administración
userAssignedIdentities	<string,  UserAssignedIdentity>	identidades de User-Assigned Diccionario de identidades asignadas por el usuario

WorkloadMonitorProvisioningState

Enumeración

Estado del aprovisionamiento del monitor de SAP.

Valor	Description
Accepted
Creating
Deleting
Failed
Migrating
Succeeded
Updating