monitors - Get

服务:

Workloads

API 版本:

2023-04-01

获取指定订阅、资源组和资源名称的 SAP 监视器的属性。

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

URI 参数

名称	在	必需	类型	说明
monitorName	path	True	string	SAP Monitor 资源的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	Monitor	还行
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

示例

Get properties of a SAP monitor

示例请求

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

示例响应

状态代码:

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

定义

名称	说明
createdByType	创建资源的标识的类型。
Error	标准错误对象。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Errors	定义 SAP 监视器错误。
InnerError	包含比当前对象有关错误的更具体信息的对象。
ManagedRGConfiguration	托管资源组配置
ManagedServiceIdentityType	托管服务标识的类型（仅允许 None、UserAssigned 类型）。
Monitor	Azure 上的 SAP 监视器信息（ARM 属性和 SAP Monitor 属性）
RoutingPreference	设置 SAP 监视器的路由首选项。 默认情况下，仅RFC1918流量路由到客户 VNET。
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentity	用户分配的标识属性
UserAssignedServiceIdentity	分配了适当角色的预先创建的用户分配标识。 若要详细了解所需的标识和角色，请访问 ACSS 操作指南。
WorkloadMonitorProvisioningState	预配 SAP 监视器的状态。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

Error

Object

标准错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innerError	InnerError	包含比当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Errors

Object

定义 SAP 监视器错误。

名称	类型	说明
code	string	服务器定义的错误代码集。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innerError	InnerError	包含比当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

InnerError

Object

包含比当前对象有关错误的更具体信息的对象。

名称	类型	说明
innerError	Error	标准错误对象。

ManagedRGConfiguration

Object

托管资源组配置

名称	类型	说明
name	string	托管资源组名称

ManagedServiceIdentityType

枚举

托管服务标识的类型（仅允许 None、UserAssigned 类型）。

值	说明
None
UserAssigned

Monitor

Object

Azure 上的 SAP 监视器信息（ARM 属性和 SAP Monitor 属性）

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	UserAssignedServiceIdentity	[当前未使用]托管服务标识（用户分配的标识）
location	string	资源所在的地理位置
name	string	资源的名称
properties.appLocation	string	SAP 监视资源将部署在 SAP 监视区域中。 子网区域应与 SAP 监视区域相同。
properties.errors	Errors	定义 SAP 监视器错误。
properties.logAnalyticsWorkspaceArmId	string	用于 SAP 监视的 Log Analytics 工作区的 ARM ID。
properties.managedResourceGroupConfiguration	ManagedRGConfiguration	托管资源组配置
properties.monitorSubnet	string	要在其中部署 SAP 监视器的子网
properties.msiArmId	string	用于 SAP 监视的 MSI 的 ARM ID。
properties.provisioningState	WorkloadMonitorProvisioningState	预配 SAP 监视器的状态。
properties.routingPreference	RoutingPreference	设置 SAP 监视器的路由首选项。 默认情况下，仅RFC1918流量路由到客户 VNET。
properties.storageAccountArmId	string	用于 SAP 监视的存储帐户的 ARM ID。
properties.zoneRedundancyPreference	string	设置针对为 SAP 监视器创建的资源的区域冗余的首选项。 默认情况下，将创建不支持区域冗余的资源。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

RoutingPreference

枚举

设置 SAP 监视器的路由首选项。 默认情况下，仅RFC1918流量路由到客户 VNET。

值	说明
Default
RouteAll

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentity

Object

用户分配的标识属性

名称	类型	说明
clientId	string (uuid)	分配的标识的客户端 ID。
principalId	string (uuid)	已分配标识的主体 ID。

UserAssignedServiceIdentity

Object

分配了适当角色的预先创建的用户分配标识。 若要详细了解所需的标识和角色，请访问 ACSS 操作指南。

名称	类型	说明
type	ManagedServiceIdentityType	管理标识的类型
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned 标识 用户分配的标识字典

WorkloadMonitorProvisioningState

枚举

预配 SAP 监视器的状态。

值	说明
Accepted
Creating
Deleting
Failed
Migrating
Succeeded
Updating