Azure Monitor Workspaces - Get

リファレンス

Service:: Monitor

API Version:: 2023-04-03

指定した Azure Monitor ワークスペースを返します

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}?api-version=2023-04-03

URI パラメーター

名前	/	必須	型	説明
azureMonitorWorkspaceName	path	True	string	Azure Monitor ワークスペースの名前。名前では大文字と小文字が区別されません Regex pattern: `^(?!-)[a-zA-Z0-9-]+[^-]$`
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AzureMonitorWorkspaceResource	要求が正常に完了しました
Other Status Codes	ErrorResponse	エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get Azure Monitor Workspace

Sample Request

GET https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAzureMonitorWorkspace?api-version=2023-04-03

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns the specified Azure Monitor Workspace
 *
 * @summary Returns the specified Azure Monitor Workspace
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/examples/AzureMonitorWorkspacesGet.json
 */
async function getAzureMonitorWorkspace() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "703362b3-f278-4e4b-9179-c76eaf41ffc2";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "myResourceGroup";
  const azureMonitorWorkspaceName = "myAzureMonitorWorkspace";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.azureMonitorWorkspaces.get(
    resourceGroupName,
    azureMonitorWorkspaceName,
  );
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/examples/AzureMonitorWorkspacesGet.json
// this example is just showing the usage of "AzureMonitorWorkspaces_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "703362b3-f278-4e4b-9179-c76eaf41ffc2";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this MonitorWorkspaceResource
MonitorWorkspaceResourceCollection collection = resourceGroupResource.GetMonitorWorkspaceResources();

// invoke the operation
string azureMonitorWorkspaceName = "myAzureMonitorWorkspace";
NullableResponse<MonitorWorkspaceResource> response = await collection.GetIfExistsAsync(azureMonitorWorkspaceName);
MonitorWorkspaceResource 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
    MonitorWorkspaceResourceData 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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAzureMonitorWorkspace",
  "name": "myAzureMonitorWorkspace",
  "type": "Microsoft.Monitor/accounts",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "accountId": "2df515bf-c3ce-4920-84d4-1d9d16542d9f",
    "metrics": {
      "prometheusQueryEndpoint": "https://myAzureMonitorWorkspace-v8hx.eastus.prometheus.monitor.azure.com",
      "internalId": "mac_2df515bf-c3ce-4920-84d4-1d9d16542d9f"
    },
    "provisioningState": "Succeeded",
    "defaultIngestionSettings": {
      "dataCollectionRuleResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/MA_myAzureMonitorWorkspace_eastus_managed/providers/Microsoft.Insights/dataCollectionRules/myAzureMonitorWorkspace",
      "dataCollectionEndpointResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/MA_myAzureMonitorWorkspace_eastus_managed/providers/Microsoft.Insights/dataCollectionEndpoints/myAzureMonitorWorkspace"
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAzureMonitorWorkspace/privateEndpointConnections/myPrivateEndpointConnection",
        "name": "myPrivateEndpointConnection",
        "type": "Microsoft.Monitor/accounts/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointConnection"
          },
          "groupIds": [
            "prometheusMetrics"
          ],
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "publicNetworkAccess": "Enabled"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

定義

名前	説明
AzureMonitorWorkspaceResource	Azure Monitor ワークスペースの定義
createdByType	リソースを作成した ID の種類。
DefaultIngestionSettings	既定では、インジェストに使用されるデータ収集ルールとエンドポイント。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Metrics	Azure Monitor ワークスペースのメトリックコンテナーに関連するプロパティ
PrivateEndpoint	プライベートエンドポイントリソース。
PrivateEndpointConnection	プライベートエンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
ProvisioningState	Azure Monitor ワークスペースのプロビジョニング状態。すべてが正常な場合は、[成功] に設定します。
PublicNetworkAccess	Azure Monitor ワークスペースへのパブリックネットワークアクセスを許可または禁止するを取得または設定します
systemData	リソースの作成と最後の変更に関連するメタデータ。

AzureMonitorWorkspaceResource

Azure Monitor ワークスペースの定義

名前	型	説明
etag	string	リソースエンティティタグ (ETag)
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.accountId	string	Azure Monitor ワークスペースの不変 ID。このプロパティは読み取り専用です。
properties.defaultIngestionSettings	DefaultIngestionSettings	既定では、インジェストに使用されるデータ収集ルールとエンドポイント。
properties.metrics	Metrics	Azure Monitor ワークスペースのメトリックコンテナーに関連するプロパティ
properties.privateEndpointConnections	PrivateEndpointConnection[]	プライベートエンドポイント接続の一覧
properties.provisioningState	ProvisioningState	Azure Monitor ワークスペースのプロビジョニング状態。すべてが正常な場合は、[成功] に設定します。
properties.publicNetworkAccess	PublicNetworkAccess	Azure Monitor ワークスペースへのパブリックネットワークアクセスを許可または禁止するを取得または設定します
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultIngestionSettings

既定では、インジェストに使用されるデータ収集ルールとエンドポイント。

名前	型	説明
dataCollectionEndpointResourceId	string	この Azure Monitor ワークスペースの既定のデータ収集エンドポイントの Azure リソース ID。
dataCollectionRuleResourceId	string	この Azure Monitor ワークスペースの既定のデータ収集規則の Azure リソース ID。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

Metrics

Azure Monitor ワークスペースのメトリックコンテナーに関連するプロパティ

名前	型	説明
internalId	string	メトリックコンテナーの内部識別子。システムで使用される場合のみ
prometheusQueryEndpoint	string	Azure Monitor ワークスペースの Prometheus クエリエンドポイント

PrivateEndpoint

プライベートエンドポイントリソース。

名前	型	説明
id	string	プライベートエンドポイントの ARM 識別子。

PrivateEndpointConnection

プライベートエンドポイント接続リソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.groupIds	string[]	プライベートエンドポイントリソースのグループ ID。
properties.privateEndpoint	PrivateEndpoint	プライベートエンドポイントリソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続リソースのプロビジョニング状態。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

プライベートエンドポイント接続の状態。

名前	型	説明
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービスプロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

ProvisioningState

Azure Monitor ワークスペースのプロビジョニング状態。すべてが正常な場合は、[成功] に設定します。

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string

PublicNetworkAccess

Azure Monitor ワークスペースへのパブリックネットワークアクセスを許可または禁止するを取得または設定します

名前	型	説明
Disabled	string
Enabled	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有