Microsoft.OperationalInsights (preview:2021-12-01)

2025/10/23 • 15 new, 15 deleted methods

Operations_List (new)
Description :  Lists all of the available OperationalInsights Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.OperationalInsights/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution operations supported by the OperationsManagement resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft OperationsManagement. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_ListByWorkspace (new)
Description :  Gets all the tables for the specified Log Analytics workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of data tables. ,
Required: False ,
}
[
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_CreateOrUpdate (new)
Description :  Update or Create a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to update table properties. ,
Required: True ,
}
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Update (new)
Description :  Update a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to update table properties. ,
Required: True ,
}
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Get (new)
Description :  Gets a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Delete (new)
Description :  Delete a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Migrate (new)
Description :  Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}/migrate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_List (new)
Description :  Gets the workspaces in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (new)
Description :  Gets workspaces in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (new)
Description :  Create or update a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a workspace. ,
Required: True ,
}
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Delete (new)
Description :  Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
force:
{
Description: Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Get (new)
Description :  Gets a workspace instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Update (new)
Description :  Updates a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a workspace. ,
Required: True ,
}
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. Optional. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedWorkspaces_List (new)
Description :  Gets recently deleted workspaces in a subscription, available for recovery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedWorkspaces_ListByResourceGroup (new)
Description :  Gets recently deleted workspaces in a resource group, available for recovery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available OperationalInsights Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.OperationalInsights/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution operations supported by the OperationsManagement resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft OperationsManagement. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_ListByWorkspace (removed)
Description :  Gets all the tables for the specified Log Analytics workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of data tables. ,
Required: False ,
}
[
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_CreateOrUpdate (removed)
Description :  Update or Create a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to update table properties. ,
Required: True ,
}
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Update (removed)
Description :  Update a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to update table properties. ,
Required: True ,
}
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Get (removed)
Description :  Gets a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Delete (removed)
Description :  Delete a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tables_Migrate (removed)
Description :  Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}/migrate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_List (removed)
Description :  Gets the workspaces in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (removed)
Description :  Gets workspaces in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (removed)
Description :  Create or update a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a workspace. ,
Required: True ,
}
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Delete (removed)
Description :  Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
force:
{
Description: Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Get (removed)
Description :  Gets a workspace instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Update (removed)
Description :  Updates a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a workspace. ,
Required: True ,
}
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. Optional. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedWorkspaces_List (removed)
Description :  Gets recently deleted workspaces in a subscription, available for recovery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedWorkspaces_ListByResourceGroup (removed)
Description :  Gets recently deleted workspaces in a resource group, available for recovery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}