Workspaces - Update

リファレンス

サービス:: Log Analytics

API バージョン:: 2023-09-01

ワークスペースを更新します。

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

URI パラメーター

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

要求本文

名前	型	説明
identity	Identity	リソースの ID。
properties.defaultDataCollectionRuleResourceId	string	このワークスペースに使用する既定のデータ収集ルールのリソース ID。必要な形式は - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName} です。
properties.features	WorkspaceFeatures	ワークスペースの機能。
properties.forceCmkForQuery	boolean	クエリ管理にカスタマーマネージドストレージが必須かどうかを示します。
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Log Analytics インジェストにアクセスするためのネットワークアクセスの種類。
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Log Analytics クエリにアクセスするためのネットワークアクセスの種類。
properties.retentionInDays	integer	ワークスペースのデータ保有期間 (日数)。使用できる値は、価格プランごとに異なります。詳細については、価格レベルのドキュメントを参照してください。
properties.sku	WorkspaceSku	ワークスペースの SKU。
properties.workspaceCapping	WorkspaceCapping	インジェストの 1 日あたりのボリューム上限。
tags	object	リソースタグ。省略可能。

応答

名前	型	説明
200 OK	Workspace	既存のワークスペースが正常に更新されました。 provisioningStatus を確認して、詳細な状態を確認します。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

WorkspacesPatch

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685?api-version=2023-09-01

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "workspaceCapping": {
      "dailyQuotaGb": -1
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled",
    "workspaceCapping": {
      "dailyQuotaGb": -1,
      "quotaNextResetTime": "Mon, 16 Nov 2020 15:00:00 GMT",
      "dataIngestionStatus": "RespectQuota"
    }
  },
  "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	ワークスペースのプロビジョニング状態。
WorkspaceFeatures	ワークスペースの機能。
WorkspacePatch	最上位レベルのワークスペースリソースコンテナー。
WorkspaceSku	ワークスペースの SKU (レベル)。
WorkspaceSkuNameEnum	SKU の名前。

CapacityReservationLevel

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

名前	型	説明
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

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

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

DataIngestionStatus

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

Identity

リソースの 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	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

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

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

PublicNetworkAccessType

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

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

systemData

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

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

UserIdentityProperties

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

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

Workspace

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

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

WorkspaceCapping

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

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

WorkspaceEntityStatus

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

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

WorkspaceFeatures

ワークスペースの機能。

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

WorkspacePatch