Microsoft.OperationalInsights (stable:2015-03-20)

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

StorageInsights_CreateOrUpdate (new)
Description :  Create or update a storage insight.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a storage insight. ,
Required: True ,
}
{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
StorageInsights_Get (new)
Description :  Gets a storage insight instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
StorageInsights_Delete (new)
Description :  Deletes a storageInsightsConfigs resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
StorageInsights_ListByWorkspace (new)
Description :  Lists the storage insight instances within a workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of storage insight items. ,
Required: False ,
}
[
{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
,
]
,
@odata.nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Workspaces_ListLinkTargets (new)
Description :  Get a list of workspaces which the current user has administrator privileges and are not associated with an Azure Subscription. The subscriptionId parameter in the Url is ignored.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/linkTargets
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
customerId:
{
Description: The GUID that uniquely identifies the workspace. ,
Required: False ,
}
string ,
accountName:
{
Description: The display name of the workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The DNS valid workspace name. ,
Required: False ,
}
string ,
location:
{
Description: The location of the workspace. ,
Required: False ,
}
string ,
}
SavedSearches_Delete (new)
Description :  Deletes the specified saved search in a given workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
SavedSearches_CreateOrUpdate (new)
Description :  Creates or updates a saved search for a given workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to save a search. ,
Required: True ,
}
{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SavedSearches_Get (new)
Description :  Gets the specified saved search for a given workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SavedSearches_ListByWorkspace (new)
Description :  Gets the saved searches for a given Log Analytics Workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
__metadata:
{
Description: Unused legacy property, kept here for backward compatibility. ,
Required: False ,
}
{
requestId:
{
Description: The request id of the search. ,
Required: False ,
}
string ,
resultType:
{
Description: The search result type. ,
Required: False ,
}
string ,
total:
{
Description: The total number of search results. ,
Format: int64 ,
Required: False ,
}
integer ,
top:
{
Description: The number of top search results. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The id of the search results request. ,
Required: False ,
}
string ,
coreSummaries:
{
Description: The core summaries. ,
Required: False ,
}
[
{
status:
{
Description: The status of a core summary. ,
Required: False ,
}
string ,
numberOfDocuments:
{
Description: The number of documents of a core summary. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
status:
{
Description: The status of the search results. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time for the search. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the search results. ,
Required: False ,
}
string ,
sort:
{
Description: How the results are sorted. ,
Required: False ,
}
[
{
name:
{
Description: The name of the field the search query is sorted on. ,
Required: False ,
}
string ,
order:
{
Description: The sort order of the search. ,
Enum:
{
asc: No description available. ,
desc: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestTime:
{
Description: The request time. ,
Format: int64 ,
Required: False ,
}
integer ,
aggregatedValueField:
{
Description: The aggregated value field. ,
Required: False ,
}
string ,
aggregatedGroupingFields:
{
Description: The aggregated grouping fields. ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
max:
{
Description: The max of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
schema:
{
Description: The schema. ,
Required: False ,
}
{
name:
{
Description: The name of the metadata schema. ,
Required: False ,
}
string ,
version:
{
Description: The version of the metadata schema. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
value:
{
Description: The array of result values. ,
Required: False ,
}
[
{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
Workspaces_GetSchema (new)
Description :  Gets the schema for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metadata:
{
Description: The metadata from search results. ,
Required: False ,
}
{
requestId:
{
Description: The request id of the search. ,
Required: False ,
}
string ,
resultType:
{
Description: The search result type. ,
Required: False ,
}
string ,
total:
{
Description: The total number of search results. ,
Format: int64 ,
Required: False ,
}
integer ,
top:
{
Description: The number of top search results. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The id of the search results request. ,
Required: False ,
}
string ,
coreSummaries:
{
Description: The core summaries. ,
Required: False ,
}
[
{
status:
{
Description: The status of a core summary. ,
Required: False ,
}
string ,
numberOfDocuments:
{
Description: The number of documents of a core summary. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
status:
{
Description: The status of the search results. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time for the search. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the search results. ,
Required: False ,
}
string ,
sort:
{
Description: How the results are sorted. ,
Required: False ,
}
[
{
name:
{
Description: The name of the field the search query is sorted on. ,
Required: False ,
}
string ,
order:
{
Description: The sort order of the search. ,
Enum:
{
asc: No description available. ,
desc: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestTime:
{
Description: The request time. ,
Format: int64 ,
Required: False ,
}
integer ,
aggregatedValueField:
{
Description: The aggregated value field. ,
Required: False ,
}
string ,
aggregatedGroupingFields:
{
Description: The aggregated grouping fields. ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
max:
{
Description: The max of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
schema:
{
Description: The schema. ,
Required: False ,
}
{
name:
{
Description: The name of the metadata schema. ,
Required: False ,
}
string ,
version:
{
Description: The version of the metadata schema. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
value:
{
Description: The array of result values. ,
Required: False ,
}
[
{
name:
{
Description: The name of the schema. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the schema. ,
Required: False ,
}
string ,
type:
{
Description: The type. ,
Required: False ,
}
string ,
indexed:
{
Description: The boolean that indicates the field is searchable as free text. ,
Required: True ,
}
boolean ,
stored:
{
Description: The boolean that indicates whether or not the field is stored. ,
Required: True ,
}
boolean ,
facet:
{
Description: The boolean that indicates whether or not the field is a facet. ,
Required: True ,
}
boolean ,
ownerType:
{
Description: The array of workflows containing the field. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
Workspaces_Purge (new)
Description :  Purges data in an Log Analytics workspace by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
body:
{
Description: Describes the body of a request to purge data in a single table of an Log Analytics Workspace ,
Required: True ,
}
{
table:
{
Description: Table from which to purge data. ,
Required: True ,
}
string ,
filters:
{
Description: The set of columns and filters (queries) to run over them to purge the resulting data. ,
Required: True ,
}
[
{
column:
{
Description: The column of the table over which the given query should run ,
Required: False ,
}
string ,
operator:
{
Description: A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query. ,
Required: False ,
}
string ,
value:
{
Description: the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values. ,
Required: False ,
}
string ,
key:
{
Description: When filtering over custom dimensions, this key will be used as the name of the custom dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
x-ms-status-location:
{
Description: The location from which to request the operation status. ,
}
string ,
}
,
$schema:
{
Description: Response containing operationId for a specific purge action. ,
}
{
operationId:
{
Description: Id to use when querying for status for a particular purge operation. ,
Required: True ,
}
string ,
}
,
}
Workspaces_GetPurgeStatus (new)
Description :  Gets status of an ongoing purge operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
purgeId:
{
Description: In a purge status request, this is the Id of the operation the status of which is returned. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the operation represented by the requested Id. ,
Enum:
{
pending: No description available. ,
completed: No description available. ,
}
,
Required: True ,
}
enum ,
}
Workspaces_ListKeys (new)
Description :  Gets the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/listKeys
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primarySharedKey:
{
Description: The primary shared key of a workspace. ,
Required: False ,
}
string ,
secondarySharedKey:
{
Description: The secondary shared key of a workspace. ,
Required: False ,
}
string ,
}
Workspaces_RegenerateSharedKeys (new)
Description :  Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/regenerateSharedKey
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primarySharedKey:
{
Description: The primary shared key of a workspace. ,
Required: False ,
}
string ,
secondarySharedKey:
{
Description: The secondary shared key of a workspace. ,
Required: False ,
}
string ,
}
Workspaces_DeleteGateways (new)
Description :  Delete a Log Analytics gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
gatewayId:
{
Description: The Log Analytics gateway Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Workspaces_AvailableServiceTiers (new)
Description :  Gets the available service tiers for the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/availableServiceTiers
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ServiceTier:
{
Description: The name of the Service Tier. ,
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. ,
}
,
Required: False ,
}
enum ,
Enabled:
{
Description: True if the Service Tier is enabled for the workspace. ,
Required: False ,
}
boolean ,
MinimumRetention:
{
Description: The minimum retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
MaximumRetention:
{
Description: The maximum retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
DefaultRetention:
{
Description: The default retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
CapacityReservationLevel:
{
Description: The capacity reservation level in GB per day. Returned for the Capacity Reservation Service Tier. ,
Format: int64 ,
Required: False ,
}
integer ,
LastSkuUpdate:
{
Description: Time when the sku was last updated for the workspace. Returned for the Capacity Reservation Service Tier. ,
Format: date-time ,
Required: False ,
}
string ,
}
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 client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the OperationalInsights 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: OperationalInsights. ,
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 ,
}
,
}
,
]
,
}
StorageInsights_CreateOrUpdate (removed)
Description :  Create or update a storage insight.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a storage insight. ,
Required: True ,
}
{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
StorageInsights_Get (removed)
Description :  Gets a storage insight instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
StorageInsights_Delete (removed)
Description :  Deletes a storageInsightsConfigs resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
StorageInsights_ListByWorkspace (removed)
Description :  Lists the storage insight instances within a workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of storage insight items. ,
Required: False ,
}
[
{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
}
,
]
,
@odata.nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Workspaces_ListLinkTargets (removed)
Description :  Get a list of workspaces which the current user has administrator privileges and are not associated with an Azure Subscription. The subscriptionId parameter in the Url is ignored.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/linkTargets
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
customerId:
{
Description: The GUID that uniquely identifies the workspace. ,
Required: False ,
}
string ,
accountName:
{
Description: The display name of the workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The DNS valid workspace name. ,
Required: False ,
}
string ,
location:
{
Description: The location of the workspace. ,
Required: False ,
}
string ,
}
SavedSearches_Delete (removed)
Description :  Deletes the specified saved search in a given workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
SavedSearches_CreateOrUpdate (removed)
Description :  Creates or updates a saved search for a given workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to save a search. ,
Required: True ,
}
{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SavedSearches_Get (removed)
Description :  Gets the specified saved search for a given workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SavedSearches_ListByWorkspace (removed)
Description :  Gets the saved searches for a given Log Analytics Workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
__metadata:
{
Description: Unused legacy property, kept here for backward compatibility. ,
Required: False ,
}
{
requestId:
{
Description: The request id of the search. ,
Required: False ,
}
string ,
resultType:
{
Description: The search result type. ,
Required: False ,
}
string ,
total:
{
Description: The total number of search results. ,
Format: int64 ,
Required: False ,
}
integer ,
top:
{
Description: The number of top search results. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The id of the search results request. ,
Required: False ,
}
string ,
coreSummaries:
{
Description: The core summaries. ,
Required: False ,
}
[
{
status:
{
Description: The status of a core summary. ,
Required: False ,
}
string ,
numberOfDocuments:
{
Description: The number of documents of a core summary. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
status:
{
Description: The status of the search results. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time for the search. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the search results. ,
Required: False ,
}
string ,
sort:
{
Description: How the results are sorted. ,
Required: False ,
}
[
{
name:
{
Description: The name of the field the search query is sorted on. ,
Required: False ,
}
string ,
order:
{
Description: The sort order of the search. ,
Enum:
{
asc: No description available. ,
desc: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestTime:
{
Description: The request time. ,
Format: int64 ,
Required: False ,
}
integer ,
aggregatedValueField:
{
Description: The aggregated value field. ,
Required: False ,
}
string ,
aggregatedGroupingFields:
{
Description: The aggregated grouping fields. ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
max:
{
Description: The max of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
schema:
{
Description: The schema. ,
Required: False ,
}
{
name:
{
Description: The name of the metadata schema. ,
Required: False ,
}
string ,
version:
{
Description: The version of the metadata schema. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
value:
{
Description: The array of result values. ,
Required: False ,
}
[
{
id:
{
Description: The id of the saved search. ,
Required: False ,
}
string ,
name:
{
Description: The name of the saved search. ,
Required: False ,
}
string ,
type:
{
Description: The type of the saved search. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the saved search. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference. ,
Required: True ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
Workspaces_GetSchema (removed)
Description :  Gets the schema for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metadata:
{
Description: The metadata from search results. ,
Required: False ,
}
{
requestId:
{
Description: The request id of the search. ,
Required: False ,
}
string ,
resultType:
{
Description: The search result type. ,
Required: False ,
}
string ,
total:
{
Description: The total number of search results. ,
Format: int64 ,
Required: False ,
}
integer ,
top:
{
Description: The number of top search results. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The id of the search results request. ,
Required: False ,
}
string ,
coreSummaries:
{
Description: The core summaries. ,
Required: False ,
}
[
{
status:
{
Description: The status of a core summary. ,
Required: False ,
}
string ,
numberOfDocuments:
{
Description: The number of documents of a core summary. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
status:
{
Description: The status of the search results. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time for the search. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the search results. ,
Required: False ,
}
string ,
sort:
{
Description: How the results are sorted. ,
Required: False ,
}
[
{
name:
{
Description: The name of the field the search query is sorted on. ,
Required: False ,
}
string ,
order:
{
Description: The sort order of the search. ,
Enum:
{
asc: No description available. ,
desc: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestTime:
{
Description: The request time. ,
Format: int64 ,
Required: False ,
}
integer ,
aggregatedValueField:
{
Description: The aggregated value field. ,
Required: False ,
}
string ,
aggregatedGroupingFields:
{
Description: The aggregated grouping fields. ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
max:
{
Description: The max of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
schema:
{
Description: The schema. ,
Required: False ,
}
{
name:
{
Description: The name of the metadata schema. ,
Required: False ,
}
string ,
version:
{
Description: The version of the metadata schema. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
value:
{
Description: The array of result values. ,
Required: False ,
}
[
{
name:
{
Description: The name of the schema. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the schema. ,
Required: False ,
}
string ,
type:
{
Description: The type. ,
Required: False ,
}
string ,
indexed:
{
Description: The boolean that indicates the field is searchable as free text. ,
Required: True ,
}
boolean ,
stored:
{
Description: The boolean that indicates whether or not the field is stored. ,
Required: True ,
}
boolean ,
facet:
{
Description: The boolean that indicates whether or not the field is a facet. ,
Required: True ,
}
boolean ,
ownerType:
{
Description: The array of workflows containing the field. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
Workspaces_Purge (removed)
Description :  Purges data in an Log Analytics workspace by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
body:
{
Description: Describes the body of a request to purge data in a single table of an Log Analytics Workspace ,
Required: True ,
}
{
table:
{
Description: Table from which to purge data. ,
Required: True ,
}
string ,
filters:
{
Description: The set of columns and filters (queries) to run over them to purge the resulting data. ,
Required: True ,
}
[
{
column:
{
Description: The column of the table over which the given query should run ,
Required: False ,
}
string ,
operator:
{
Description: A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query. ,
Required: False ,
}
string ,
value:
{
Description: the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values. ,
Required: False ,
}
string ,
key:
{
Description: When filtering over custom dimensions, this key will be used as the name of the custom dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
x-ms-status-location:
{
Description: The location from which to request the operation status. ,
}
string ,
}
,
$schema:
{
Description: Response containing operationId for a specific purge action. ,
}
{
operationId:
{
Description: Id to use when querying for status for a particular purge operation. ,
Required: True ,
}
string ,
}
,
}
Workspaces_GetPurgeStatus (removed)
Description :  Gets status of an ongoing purge operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}
{
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
purgeId:
{
Description: In a purge status request, this is the Id of the operation the status of which is returned. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the operation represented by the requested Id. ,
Enum:
{
pending: No description available. ,
completed: No description available. ,
}
,
Required: True ,
}
enum ,
}
Workspaces_ListKeys (removed)
Description :  Gets the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/listKeys
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primarySharedKey:
{
Description: The primary shared key of a workspace. ,
Required: False ,
}
string ,
secondarySharedKey:
{
Description: The secondary shared key of a workspace. ,
Required: False ,
}
string ,
}
Workspaces_RegenerateSharedKeys (removed)
Description :  Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/regenerateSharedKey
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primarySharedKey:
{
Description: The primary shared key of a workspace. ,
Required: False ,
}
string ,
secondarySharedKey:
{
Description: The secondary shared key of a workspace. ,
Required: False ,
}
string ,
}
Workspaces_DeleteGateways (removed)
Description :  Delete a Log Analytics gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
gatewayId:
{
Description: The Log Analytics gateway Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Workspaces_AvailableServiceTiers (removed)
Description :  Gets the available service tiers for the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/availableServiceTiers
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics Workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ServiceTier:
{
Description: The name of the Service Tier. ,
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. ,
}
,
Required: False ,
}
enum ,
Enabled:
{
Description: True if the Service Tier is enabled for the workspace. ,
Required: False ,
}
boolean ,
MinimumRetention:
{
Description: The minimum retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
MaximumRetention:
{
Description: The maximum retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
DefaultRetention:
{
Description: The default retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
CapacityReservationLevel:
{
Description: The capacity reservation level in GB per day. Returned for the Capacity Reservation Service Tier. ,
Format: int64 ,
Required: False ,
}
integer ,
LastSkuUpdate:
{
Description: Time when the sku was last updated for the workspace. Returned for the Capacity Reservation Service Tier. ,
Format: date-time ,
Required: False ,
}
string ,
}
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 client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the OperationalInsights 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: OperationalInsights. ,
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 ,
}
,
}
,
]
,
}