Workspaces - List

サービス:

Log Analytics

API バージョン:

2025-02-01

サブスクリプション内のワークスペースを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces?api-version=2025-02-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	WorkspaceListResult	OK 応答の定義。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

WorkspacesSubscriptionList

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.OperationalInsights/workspaces?api-version=2025-02-01

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "properties": {
        "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
        "provisioningState": "Succeeded",
        "sku": {
          "name": "PerGB2018"
        },
        "retentionInDays": 30,
        "publicNetworkAccessForQuery": "Enabled",
        "publicNetworkAccessForIngestion": "Enabled"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170",
      "name": "AzTest2170",
      "type": "Microsoft.OperationalInsights/workspaces",
      "location": "australiasoutheast",
      "tags": {
        "tag1": "val1"
      }
    }
  ]
}

定義

名前	説明
CapacityReservationLevel	CapacityReservation SKU が選択されている場合の、このワークスペースの容量予約レベル (GB)。
createdByType	リソースを作成した ID の種類。
DataIngestionStatus	このワークスペースのデータ インジェストの状態。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Identity	リソースの ID。
IdentityType	マネージド サービス ID の種類。
PrivateLinkScopedResource	プライベート リンク スコープのリソース参照。
PublicNetworkAccessType	Log Analytics ワークスペースで動作するためのネットワーク アクセスの種類。 既定では有効です
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserIdentityProperties	ユーザー割り当て ID プロパティ。
Workspace	最上位レベルのワークスペース リソース コンテナー。
WorkspaceCapping	インジェストの 1 日あたりのボリューム上限。
WorkspaceEntityStatus	ワークスペースのプロビジョニング状態。
WorkspaceFailoverProperties	レプリケーションのフェールオーバー状態。
WorkspaceFailoverState	レプリケーションのフェールオーバー状態。
WorkspaceFeatures	ワークスペースの機能。
WorkspaceListResult	ワークスペースの一覧操作の応答。
WorkspaceReplicationProperties	ワークスペース レプリケーションのプロパティ。
WorkspaceReplicationState	レプリケーションのプロビジョニング状態。
WorkspaceSku	ワークスペースの SKU (層)。
WorkspaceSkuNameEnum	SKU の名前。

CapacityReservationLevel

列挙

CapacityReservation SKU が選択されている場合の、このワークスペースの容量予約レベル (GB)。

値	説明
100
1000
10000
200
2000
25000
300
400
500
5000
50000

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

DataIngestionStatus

列挙

このワークスペースのデータ インジェストの状態。

値	説明
ApproachingQuota	日次上限クォータの 80% に達しました。
ForceOff	サービス設定の変更後、インジェストが停止しました。
ForceOn	サービス設定の変更後にインジェストが開始されました。
OverQuota	日次上限クォータに達し、インジェストが停止しました。
RespectQuota	日次上限クォータのリセット、またはサブスクリプションの有効化後にインジェストが有効になりました。
SubscriptionSuspended	中断されたサブスクリプションの後、インジェストが停止しました。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

Identity

Object

リソースの ID。

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。
tenantId	string	リソースのテナント ID。
type	IdentityType	マネージド サービス ID の種類。
userAssignedIdentities	<string,  UserIdentityProperties>	リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

IdentityType

列挙

マネージド サービス ID の種類。

値	説明
None
SystemAssigned
UserAssigned

PrivateLinkScopedResource

Object

プライベート リンク スコープのリソース参照。

名前	型	説明
resourceId	string	プライベート リンク スコープ リソースの完全なリソース ID。
scopeId	string	プライベート リンク スコープの一意識別子。

PublicNetworkAccessType

列挙

Log Analytics ワークスペースで動作するためのネットワーク アクセスの種類。 既定では有効です

値	説明
Disabled	パブリック DNS を介した Log Analytics へのパブリック接続を無効にします。
Enabled	パブリック DNS を介した Log Analytics への接続を有効にします。

systemData

Object

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

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

UserIdentityProperties

Object

ユーザー割り当て ID プロパティ。

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル ID。

Workspace

Object

最上位レベルのワークスペース リソース コンテナー。

名前	型	規定値	説明
etag	string		ワークスペースの etag。
id	string		リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		リソースの ID。
location	string		リソースが存在する地理的な場所
name	string		リソースの名前
properties.createdDate	string (date-time)		ワークスペースの作成日。
properties.customerId	string		これは読み取り専用プロパティです。 ワークスペースに関連付けられている ID を表します。
properties.defaultDataCollectionRuleResourceId	string		このワークスペースに使用する既定のデータ収集ルールのリソース ID。 必要な形式は 、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName} です。
properties.failover	WorkspaceFailoverProperties		ワークスペースフェールオーバーのプロパティ。
properties.features	WorkspaceFeatures		ワークスペースの機能。
properties.forceCmkForQuery	boolean		クエリ管理にカスタマー マネージド ストレージが必須かどうかを示します。
properties.modifiedDate	string (date-time)		ワークスペースの変更日。
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		リンクされたプライベート リンク スコープ リソースの一覧。
properties.provisioningState	WorkspaceEntityStatus		ワークスペースのプロビジョニング状態。
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Log Analytics インジェストにアクセスするためのネットワーク アクセスの種類。
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Log Analytics クエリにアクセスするためのネットワーク アクセスの種類。
properties.replication	WorkspaceReplicationProperties		ワークスペース レプリケーションのプロパティ。
properties.retentionInDays	integer (int32)		ワークスペースのデータ保有期間 (日数)。 使用できる値は、価格プランごとに指定します。 詳細については、価格レベルのドキュメントを参照してください。
properties.sku	WorkspaceSku		ワークスペースの SKU。
properties.workspaceCapping	WorkspaceCapping		インジェストの 1 日あたりのボリューム上限。
systemData	systemData		リソースの作成と最後の変更に関連するメタデータ。
tags	object		リソース タグ。
type	string		リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Object

インジェストの 1 日あたりのボリューム上限。

名前	型	説明
dailyQuotaGb	number (double)	インジェストのワークスペースの 1 日あたりのクォータ。
dataIngestionStatus	DataIngestionStatus	このワークスペースのデータ インジェストの状態。
quotaNextResetTime	string	クォータが保存される時刻。

WorkspaceEntityStatus

列挙

ワークスペースのプロビジョニング状態。

値	説明
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

WorkspaceFailoverProperties

Object

レプリケーションのフェールオーバー状態。

名前	型	説明
lastModifiedDate	string (date-time)	フェールオーバー状態が最後に更新された時刻。
state	WorkspaceFailoverState	レプリケーションのフェールオーバー状態。

WorkspaceFailoverState

列挙

レプリケーションのフェールオーバー状態。

値	説明
Activating
Active
Deactivating
Failed
Inactive

WorkspaceFeatures

Object

ワークスペースの機能。

名前	型	説明
clusterResourceId	string	ワークスペースにリンクされている専用 LA クラスター resourceId。
disableLocalAuth	boolean	非 AAD ベースの認証を無効にします。
enableDataExport	boolean	データをエクスポートするかどうかを示すフラグ。
enableLogAccessUsingOnlyResourcePermissions	boolean	使用するアクセス許可 (リソースまたはワークスペース、またはその両方) を示すフラグ。
immediatePurgeDataOn30Days	boolean	30 日後にデータを削除するかどうかを示すフラグ。
unifiedSentinelBillingOnly	boolean	指定ワークスペースが Sentinel の統合課金モデルのみに制限されているかどうかを示します。

WorkspaceListResult

Object

ワークスペースの一覧操作の応答。

名前	型	説明
value	Workspace[]	ワークスペースの一覧。

WorkspaceReplicationProperties

Object

ワークスペース レプリケーションのプロパティ。

名前	型	説明
createdDate	string (date-time)	レプリケーションが最後に有効になった時刻。
enabled	boolean	レプリケーションが有効かどうかを指定します。 true の場合、ワークスペースの構成とデータは指定した場所にレプリケートされます。 レプリケーションが有効になっている場合は、場所を指定する必要があります。
lastModifiedDate	string (date-time)	レプリケーションが最後に更新された時刻。
location	string	レプリケーションの場所。
provisioningState	WorkspaceReplicationState	レプリケーションのプロビジョニング状態。

WorkspaceReplicationState

列挙

レプリケーションのプロビジョニング状態。

値	説明
Canceled
DisableRequested
Disabling
EnableRequested
Enabling
Failed
RollbackRequested
RollingBack
Succeeded

WorkspaceSku

Object

ワークスペースの SKU (層)。

名前	型	説明
capacityReservationLevel	CapacityReservationLevel (int32)	CapacityReservation SKU が選択されている場合の、このワークスペースの容量予約レベル (GB)。
lastSkuUpdate	string (date-time)	SKU が最後に更新された時刻。
name	WorkspaceSkuNameEnum	SKU の名前。

WorkspaceSkuNameEnum

列挙

SKU の名前。

値	説明
CapacityReservation
Free
LACluster
PerGB2018
PerNode
Premium
Standalone
Standard