monitors - Get

Szolgáltatás:

Workloads

API-verzió:

2023-04-01

Lekéri egy SAP-monitor tulajdonságait a megadott előfizetéshez, erőforráscsoporthoz és erőforrásnévhez.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
monitorName	path	True	string	Az SAP monitorozási erőforrásának neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	Monitor	OKÉ
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

Get properties of a SAP monitor

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
Error	Standard hibaobjektum.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Errors	Meghatározza az SAP monitorozási hibáit.
InnerError	Az objektum az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
ManagedRGConfiguration	Felügyelt erőforráscsoport konfigurálása
ManagedServiceIdentityType	A felügyelt szolgáltatás identitásának típusa (csak a Nincs, a UserAssigned típusok engedélyezettek).
Monitor	SAP monitorozási információk az Azure-ról (ARM-tulajdonságok és SAP monitorozási tulajdonságok)
RoutingPreference	Beállítja az SAP monitor útválasztási beállításait. Alapértelmezés szerint csak RFC1918 forgalom lesz átirányítva az ügyfél virtuális hálózatára.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentity	Felhasználó által hozzárendelt identitástulajdonságok
UserAssignedServiceIdentity	Egy előre létrehozott felhasználó által hozzárendelt identitás, amelyhez megfelelő szerepkörök vannak hozzárendelve. Ha többet szeretne megtudni az identitásról és a szükséges szerepkörökről, látogasson el az ACSS útmutatójára.
WorkloadMonitorProvisioningState	Az SAP-monitor üzembe helyezésének állapota.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

Error

Objektum

Standard hibaobjektum.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innerError	InnerError	Az objektum az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

Errors

Objektum

Meghatározza az SAP monitorozási hibáit.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innerError	InnerError	Az objektum az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

InnerError

Objektum

Az objektum az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

Name	Típus	Description
innerError	Error	Standard hibaobjektum.

ManagedRGConfiguration

Objektum

Felügyelt erőforráscsoport konfigurálása

Name	Típus	Description
name	string	Felügyelt erőforráscsoport neve

ManagedServiceIdentityType

Enumerálás

A felügyelt szolgáltatás identitásának típusa (csak a Nincs, a UserAssigned típusok engedélyezettek).

Érték	Description
None
UserAssigned

Monitor

Objektum

SAP monitorozási információk az Azure-ról (ARM-tulajdonságok és SAP monitorozási tulajdonságok)

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	UserAssignedServiceIdentity	[jelenleg nincs használatban] Felügyeltszolgáltatás-identitás (felhasználó által hozzárendelt identitások)
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.appLocation	string	Az SAP monitorozási erőforrásai az SAP monitorozási régiójában lesznek üzembe helyezve. Az alhálózati régiónak meg kell egyeznie az SAP monitorozási régiójával.
properties.errors	Errors	Meghatározza az SAP monitorozási hibáit.
properties.logAnalyticsWorkspaceArmId	string	Az SAP monitorozásához használt Log Analytics-munkaterület ARM-azonosítója.
properties.managedResourceGroupConfiguration	ManagedRGConfiguration	Felügyelt erőforráscsoport konfigurálása
properties.monitorSubnet	string	Az az alhálózat, amelyben az SAP-monitor üzembe lesz helyezve
properties.msiArmId	string	Az SAP monitorozásához használt MSI ARM-azonosítója.
properties.provisioningState	WorkloadMonitorProvisioningState	Az SAP-monitor üzembe helyezésének állapota.
properties.routingPreference	RoutingPreference	Beállítja az SAP monitor útválasztási beállításait. Alapértelmezés szerint csak RFC1918 forgalom lesz átirányítva az ügyfél virtuális hálózatára.
properties.storageAccountArmId	string	Az SAP monitorozásához használt Storage-fiók ARM-azonosítója.
properties.zoneRedundancyPreference	string	Beállítja a zónaredundancia beállítását az SAP-monitorhoz létrehozott erőforrásokon. Alapértelmezés szerint olyan erőforrások jönnek létre, amelyek nem támogatják a zónaredundanciát.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

RoutingPreference

Enumerálás

Beállítja az SAP monitor útválasztási beállításait. Alapértelmezés szerint csak RFC1918 forgalom lesz átirányítva az ügyfél virtuális hálózatára.

Érték	Description
Default
RouteAll

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

Objektum

Felhasználó által hozzárendelt identitástulajdonságok

Name	Típus	Description
clientId	string (uuid)	A hozzárendelt identitás ügyfélazonosítója.
principalId	string (uuid)	A hozzárendelt identitás egyszerű azonosítója.

UserAssignedServiceIdentity

Objektum

Egy előre létrehozott felhasználó által hozzárendelt identitás, amelyhez megfelelő szerepkörök vannak hozzárendelve. Ha többet szeretne megtudni az identitásról és a szükséges szerepkörökről, látogasson el az ACSS útmutatójára.

Name	Típus	Description
type	ManagedServiceIdentityType	Identitáskezelés típusa
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned identitások Felhasználó által hozzárendelt identitások szótára

WorkloadMonitorProvisioningState

Enumerálás

Az SAP-monitor üzembe helyezésének állapota.

Érték	Description
Accepted
Creating
Deleting
Failed
Migrating
Succeeded
Updating