Workspaces - Create Or Update

サービス:: Log Analytics

API バージョン:: 2025-02-01

ワークスペースを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	ワークスペースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
parameters	Workspace	ワークスペースを作成または更新するために必要なパラメーター。

応答

名前	型	説明
200 OK	Workspace	OK 応答の定義。
201 Created	Workspace	応答定義を作成しました。
202 Accepted		受け入れられる
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

WorkspacesCreate

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

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30
  },
  "___location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.OperationalInsights.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.OperationalInsights;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2025-02-01/examples/WorkspacesCreate.json
// this example is just showing the usage of "Workspaces_CreateOrUpdate" 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 = "00000000-0000-0000-0000-00000000000";
string resourceGroupName = "oiautorest6685";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this OperationalInsightsWorkspaceResource
OperationalInsightsWorkspaceCollection collection = resourceGroupResource.GetOperationalInsightsWorkspaces();

// invoke the operation
string workspaceName = "oiautorest6685";
OperationalInsightsWorkspaceData data = new OperationalInsightsWorkspaceData(new AzureLocation("australiasoutheast"))
{
    Sku = new OperationalInsightsWorkspaceSku(OperationalInsightsWorkspaceSkuName.PerGB2018),
    RetentionInDays = 30,
    Tags =
    {
    ["tag1"] = "val1"
    },
};
ArmOperation<OperationalInsightsWorkspaceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, workspaceName, data);
OperationalInsightsWorkspaceResource result = lro.Value;

// 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
OperationalInsightsWorkspaceData 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-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170",
  "name": "AzTest2170",
  "type": "Microsoft.OperationalInsights/workspaces",
  "___location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}

状態コード:: 201

{
  "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"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}

状態コード:: 202

定義

名前	説明
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	ワークスペースの機能。
WorkspaceReplicationProperties	ワークスペースレプリケーションのプロパティ。
WorkspaceReplicationState	レプリケーションのプロビジョニング状態。
WorkspaceSku	ワークスペースの SKU。
WorkspaceSkuNameEnum	SKU の名前。

CapacityReservationLevel

列挙

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

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

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

DataIngestionStatus

列挙

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

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

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 の種類。

値	説明
SystemAssigned
UserAssigned
None

PrivateLinkScopedResource

Object

リンクされたプライベートリンクスコープリソースの一覧。

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

PublicNetworkAccessType

列挙

Log Analytics インジェストにアクセスするためのネットワークアクセスの種類。

値	説明
Enabled	パブリック DNS を介した Log Analytics への接続を有効にします。
Disabled	パブリック 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

列挙

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

値	説明
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

WorkspaceFailoverProperties

Object

ワークスペースフェールオーバーのプロパティ。

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

WorkspaceFailoverState

列挙

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

値	説明
Inactive
Activating
Active
Deactivating
Failed

WorkspaceFeatures

Object

ワークスペースの機能。

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

WorkspaceReplicationProperties

Object

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

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

WorkspaceReplicationState

列挙

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

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

WorkspaceSku

Object

ワークスペースの SKU。

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

WorkspaceSkuNameEnum

列挙

SKU の名前。

値	説明
Free
Standard
Premium
PerNode
PerGB2018
Standalone
CapacityReservation
LACluster

次の方法で共有

Workspaces - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

WorkspacesCreate

要求のサンプル

応答のサンプル

定義

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum