Workspaces - Update
ワークスペースを更新します。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}?api-version=2025-07-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前は大文字と小文字が区別されます。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
workspace
|
path | True |
string minLength: 4maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ |
ワークスペースの名前。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| identity |
リソースの ID。 |
|
| properties.defaultDataCollectionRuleResourceId |
string |
このワークスペースに使用する既定のデータ収集ルールのリソース ID。 必要な形式は 、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName} です。 |
| properties.failover |
ワークスペースフェールオーバーのプロパティ。 |
|
| properties.features |
ワークスペースの機能。 |
|
| properties.forceCmkForQuery |
boolean |
クエリ管理にカスタマー マネージド ストレージが必須かどうかを示します。 |
| properties.publicNetworkAccessForIngestion |
Log Analytics インジェストにアクセスするためのネットワーク アクセスの種類。 |
|
| properties.publicNetworkAccessForQuery |
Log Analytics クエリにアクセスするためのネットワーク アクセスの種類。 |
|
| properties.replication |
ワークスペース レプリケーションのプロパティ。 |
|
| properties.retentionInDays |
integer (int32) |
ワークスペースのデータ保有期間 (日数)。 使用できる値は価格プランごとになります。 詳細については、価格レベル ドキュメントを参照してください。 |
| properties.sku |
ワークスペースの SKU。 |
|
| properties.workspaceCapping |
インジェストの 1 日あたりのボリューム上限。 |
|
| tags |
object |
リソース タグ。 Optional. |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azureの運用は無事に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
WorkspacesPatch
要求のサンプル
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685?api-version=2025-07-01
{
"properties": {
"retentionInDays": 30,
"sku": {
"name": "PerGB2018"
},
"workspaceCapping": {
"dailyQuotaGb": -1
}
}
}
応答のサンプル
{
"location": "australiasoutheast",
"properties": {
"publicNetworkAccessForIngestion": "Enabled",
"publicNetworkAccessForQuery": "Enabled",
"retentionInDays": 30,
"sku": {
"name": "PerGB2018"
},
"workspaceCapping": {
"dailyQuotaGb": -1,
"dataIngestionStatus": "RespectQuota",
"quotaNextResetTime": "Mon, 16 Nov 2020 15:00:00 GMT"
}
},
"tags": {
"tag1": "val1"
}
}
定義
| 名前 | 説明 |
|---|---|
|
created |
リソースを作成した ID の種類。 |
|
Data |
このワークスペースのデータ取り込みの状態。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
| Identity |
リソースの ID。 |
|
Identity |
マネージド サービス ID の種類。 |
|
Private |
プライベート リンク スコープのリソース参照。 |
|
Public |
Log Analytics インジェストにアクセスするためのネットワーク アクセスの種類。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
|
User |
ユーザー割り当て ID プロパティ。 |
| Workspace |
最上位のワークスペース・リソース・コンテナー。 |
|
Workspace |
インジェストの 1 日あたりのボリューム上限。 |
|
Workspace |
ワークスペースのプロビジョニング状態。 |
|
Workspace |
レプリケーションのフェールオーバー状態。 |
|
Workspace |
レプリケーションのフェールオーバー状態。 |
|
Workspace |
ワークスペースの機能。 |
|
Workspace |
最上位のワークスペース・リソース・コンテナー。 |
|
Workspace |
ワークスペースレプリケーションのプロパティ。 |
|
Workspace |
レプリケーションのプロビジョニング状態。 |
|
Workspace |
ワークスペースの SKU (層)。 |
|
Workspace |
SKU の名前。 |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DataIngestionStatus
このワークスペースのデータ取り込みの状態。
| 値 | 説明 |
|---|---|
| RespectQuota |
毎日の上限クォータのリセットまたはサブスクリプションの有効化後に取り込みが有効になります。 |
| ForceOn |
サービス設定の変更後にインジェストが開始されました。 |
| ForceOff |
サービス設定の変更後にインジェストが停止しました。 |
| OverQuota |
毎日の上限クォータに達し、取り込みが停止しました。 |
| SubscriptionSuspended |
サブスクリプションの中断後にインジェストが停止しました。 |
| ApproachingQuota |
1日の上限の80% に達しました。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細です。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
Identity
リソースの ID。
| 名前 | 型 | 説明 |
|---|---|---|
| principalId |
string |
リソース ID のプリンシパル ID。 |
| tenantId |
string |
リソースのテナント ID。 |
| type |
マネージド サービス ID の種類。 |
|
| userAssignedIdentities |
<string,
User |
リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 |
IdentityType
マネージド サービス ID の種類。
| 値 | 説明 |
|---|---|
| SystemAssigned |
SystemAssigned |
| UserAssigned |
UserAssigned |
| None |
None |
PrivateLinkScopedResource
プライベート リンク スコープのリソース参照。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
プライベート リンク スコープ リソースの完全なリソース ID。 |
| scopeId |
string |
プライベート リンク スコープの一意の識別子。 |
PublicNetworkAccessType
Log Analytics インジェストにアクセスするためのネットワーク アクセスの種類。
| 値 | 説明 |
|---|---|
| Enabled |
パブリック DNS を介した Log Analytics への接続を有効にします。 |
| Disabled |
パブリック DNS を介した Log Analytics へのパブリック接続を無効にします。 |
| SecuredByPerimeter |
リソースには、プライベート ネットワークからのみアクセスでき、このリソースに関連付けられているネットワーク セキュリティ境界によって承認されたアクセスです。 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |
UserIdentityProperties
ユーザー割り当て ID プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| clientId |
string |
ユーザー割り当て ID のクライアント ID。 |
| principalId |
string |
ユーザー割り当て ID のプリンシパル ID。 |
Workspace
最上位のワークスペース・リソース・コンテナー。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| etag |
string |
ワークスペースの etag。 |
|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
| 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 |
ワークスペースフェールオーバーのプロパティ。 |
||
| properties.features |
ワークスペースの機能。 |
||
| properties.forceCmkForQuery |
boolean |
クエリ管理にカスタマー マネージド ストレージが必須かどうかを示します。 |
|
| properties.modifiedDate |
string (date-time) |
ワークスペースの変更日。 |
|
| properties.privateLinkScopedResources |
リンクされたプライベート リンク スコープ リソースの一覧。 |
||
| properties.provisioningState |
ワークスペースのプロビジョニング状態。 |
||
| properties.publicNetworkAccessForIngestion | Enabled |
Log Analytics インジェストにアクセスするためのネットワーク アクセスの種類。 |
|
| properties.publicNetworkAccessForQuery | Enabled |
Log Analytics クエリにアクセスするためのネットワーク アクセスの種類。 |
|
| properties.replication |
ワークスペース レプリケーションのプロパティ。 |
||
| properties.retentionInDays |
integer (int32) |
ワークスペースのデータ保有期間 (日数)。 使用できる値は価格プランごとになります。 詳細については、価格レベル ドキュメントを参照してください。 |
|
| properties.sku |
ワークスペースの SKU。 |
||
| properties.workspaceCapping |
インジェストの 1 日あたりのボリューム上限。 |
||
| systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
||
| tags |
object |
リソース タグ。 |
|
| type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
WorkspaceCapping
インジェストの 1 日あたりのボリューム上限。
| 名前 | 型 | 説明 |
|---|---|---|
| dailyQuotaGb |
number (double) |
インジェストのワークスペースの 1 日あたりのクォータ。 |
| dataIngestionStatus |
このワークスペースのデータ取り込みの状態。 |
|
| quotaNextResetTime |
string |
クォータが休憩になる時間。 |
WorkspaceEntityStatus
ワークスペースのプロビジョニング状態。
| 値 | 説明 |
|---|---|
| Creating |
作成 |
| Succeeded |
成功しました |
| Failed |
失敗しました |
| Canceled |
取り消し済み |
| Deleting |
削除中 |
| ProvisioningAccount |
プロビジョニングアカウント |
| Updating |
更新中 |
WorkspaceFailoverProperties
レプリケーションのフェールオーバー状態。
| 名前 | 型 | 説明 |
|---|---|---|
| lastModifiedDate |
string (date-time) |
フェールオーバー状態が最後に更新された時刻。 |
| state |
レプリケーションのフェールオーバー状態。 |
WorkspaceFailoverState
レプリケーションのフェールオーバー状態。
| 値 | 説明 |
|---|---|
| Inactive |
非アクティブ |
| Activating |
起動中 |
| Active |
アクティブです |
| Deactivating |
非アクティブ化 |
| Failed |
失敗しました |
WorkspaceFeatures
ワークスペースの機能。
| 名前 | 型 | 説明 |
|---|---|---|
| associations |
string[] |
ワークスペースの関連付けのリスト。 ワークスペースが MDC、Sentinel、SentinelGraph などのエクスペリエンスのいずれかに関連付けられているかどうかを示します。 |
| clusterResourceId |
string |
ワークスペースにリンクされている専用 LA クラスター resourceId。 |
| disableLocalAuth |
boolean |
非 AAD ベースの認証を無効にします。 |
| enableDataExport |
boolean |
データをエクスポートするかどうかを示すフラグ。 |
| enableLogAccessUsingOnlyResourcePermissions |
boolean |
使用するアクセス許可 (リソースまたはワークスペース、またはその両方) を示すフラグ。 |
| immediatePurgeDataOn30Days |
boolean |
30 日後にデータを削除するかどうかを示すフラグ。 |
| unifiedSentinelBillingOnly |
boolean |
指定ワークスペースが Sentinel の統合課金モデルのみに制限されているかどうかを示します。 |
WorkspacePatch
最上位のワークスペース・リソース・コンテナー。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| etag |
string |
リソース Etag。 |
|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
| identity |
リソースの ID。 |
||
| 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 |
ワークスペースフェールオーバーのプロパティ。 |
||
| properties.features |
ワークスペースの機能。 |
||
| properties.forceCmkForQuery |
boolean |
クエリ管理にカスタマー マネージド ストレージが必須かどうかを示します。 |
|
| properties.modifiedDate |
string (date-time) |
ワークスペースの変更日。 |
|
| properties.privateLinkScopedResources |
リンクされたプライベート リンク スコープ リソースの一覧。 |
||
| properties.provisioningState |
ワークスペースのプロビジョニング状態。 |
||
| properties.publicNetworkAccessForIngestion | Enabled |
Log Analytics インジェストにアクセスするためのネットワーク アクセスの種類。 |
|
| properties.publicNetworkAccessForQuery | Enabled |
Log Analytics クエリにアクセスするためのネットワーク アクセスの種類。 |
|
| properties.replication |
ワークスペース レプリケーションのプロパティ。 |
||
| properties.retentionInDays |
integer (int32) |
ワークスペースのデータ保有期間 (日数)。 使用できる値は価格プランごとになります。 詳細については、価格レベル ドキュメントを参照してください。 |
|
| properties.sku |
ワークスペースの SKU。 |
||
| properties.workspaceCapping |
インジェストの 1 日あたりのボリューム上限。 |
||
| systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
||
| tags |
object |
リソース タグ。 Optional. |
|
| type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
WorkspaceReplicationProperties
ワークスペースレプリケーションのプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdDate |
string (date-time) |
レプリケーションが最後に有効になった時刻。 |
| enabled |
boolean |
レプリケーションが有効かどうかを指定します。 true の場合、ワークスペースの構成とデータは指定した場所にレプリケートされます。 レプリケーションが有効になっている場合は、場所を指定する必要があります。 |
| lastModifiedDate |
string (date-time) |
レプリケーションが最後に更新された時刻。 |
| location |
string |
レプリケーションの場所。 |
| provisioningState |
レプリケーションのプロビジョニング状態。 |
WorkspaceReplicationState
レプリケーションのプロビジョニング状態。
| 値 | 説明 |
|---|---|
| Succeeded |
成功しました |
| EnableRequested |
EnableRequested |
| Enabling |
有効化 |
| DisableRequested |
DisableRequested |
| Disabling |
無効化 |
| RollbackRequested |
ロールバックリクエストあり |
| RollingBack |
ロールバック |
| Failed |
失敗しました |
| Canceled |
取り消し済み |
WorkspaceSku
ワークスペースの SKU (層)。
| 名前 | 型 | 説明 |
|---|---|---|
| capacityReservationLevel |
integer (int32) |
CapacityReservation SKU が選択されている場合の、このワークスペースの容量予約レベル (GB)。 |
| lastSkuUpdate |
string (date-time) |
最後にSKUが更新されたとき。 |
| name |
SKU の名前。 |
WorkspaceSkuNameEnum
SKU の名前。
| 値 | 説明 |
|---|---|
| Free |
Free |
| Standard |
Standard |
| Premium |
Premium |
| PerNode |
PerNode |
| PerGB2018 |
PerGB2018 |
| Standalone |
スタンドアロン |
| CapacityReservation |
キャパシティリザベーション |
| LACluster |
ラクスター |