Operations - List
Lists all of the available OperationalInsights Rest API operations.
GET https://management.azure.com/providers/Microsoft.OperationalInsights/operations?api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK response definition. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get specific operation status
Sample request
GET https://management.azure.com/providers/Microsoft.OperationalInsights/operations?api-version=2023-09-01
Sample response
{
"value": [
{
"name": "Microsoft.OperationalInsights/workspaces/write",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Workspace",
"operation": "Create Workspace",
"description": "Creates a new workspace or links to an existing workspace by providing the customer id from the existing workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Workspace",
"operation": "Get Workspace",
"description": "Gets an existing workspace"
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/delete",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Workspace",
"operation": "Delete Workspace",
"description": "Deletes a workspace. If the workspace was linked to an existing workspace at creation time then the workspace it was linked to is not deleted."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/generateregistrationcertificate/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Registration Certificate",
"operation": "Generates Registration Certificate for Workspace.",
"description": "Generates Registration Certificate for the workspace. This Certificate is used to connect Microsoft System Center Operation Manager to the workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/storageinsightconfigs/write",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Storage Insight Configuration",
"operation": "Create Storage Configuration",
"description": "Creates a new storage configuration. These configurations are used to pull data from a location in an existing storage account."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/storageinsightconfigs/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Storage Insight Configuration",
"operation": "Get Storage Configuration",
"description": "Gets a storage configuration."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/storageinsightconfigs/delete",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Storage Insight Configuration",
"operation": "Delete Storage Configuration",
"description": "Deletes a storage configuration. This will stop Microsoft Operational Insights from reading data from the storage account."
}
},
{
"name": "Microsoft.OperationalInsights/register/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Register",
"operation": "Register a subscription to a resource provider.",
"description": "Register a subscription to a resource provider."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/sharedKeys/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Shared Keys",
"operation": "List Workspace Shared Keys",
"description": "Retrieves the shared keys for the workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/sharedKeys/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Shared Keys",
"operation": "List Workspace Shared Keys",
"description": "Retrieves the shared keys for the workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/listKeys/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "List Keys",
"operation": "List Workspace Keys",
"description": "Retrieves the list keys for the workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/listKeys/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "List Keys",
"operation": "List Workspace Keys",
"description": "Retrieves the list keys for the workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/managementGroups/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Management Group",
"operation": "Get Management Groups for Workspace",
"description": "Gets the names and metadata for System Center Operations Manager management groups connected to this workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/usages/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Usage Metric",
"operation": "Get Usage Data for Workspace",
"description": "Gets usage data for a workspace including the amount of data read by the workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/search/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Search",
"operation": "Search Workspace Data",
"description": "Executes a search query"
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/schema/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Search Schema",
"operation": "Get Search Schema",
"description": "Gets the search schema for the workspace. Search schema includes the exposed fields and their types."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/datasources/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Data Source",
"operation": "Get datasources under a workspace.",
"description": "Get datasources under a workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/datasources/write",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Data Source",
"operation": "Create/Update datasources under a workspace.",
"description": "Create/Update datasources under a workspace."
}
},
{},
{},
{},
{},
{
"name": "Microsoft.OperationalInsights/workspaces/notificationSettings/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Notification Settings",
"operation": "Get Notification Settings",
"description": "Get the user's notification settings for the workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/notificationSettings/write",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Notification Settings",
"operation": "Put Notification Settings",
"description": "Set the user's notification settings for the workspace."
}
},
{},
{},
{},
{
"name": "Microsoft.OperationalInsights/workspaces/configurationScopes/delete",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Configuration Scope",
"operation": "Delete Configuration Scope",
"description": "Delete Configuration Scope"
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/linkedServices/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Linked Services",
"operation": "Get linked services under given workspace.",
"description": "Get linked services under given workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/linkedServices/write",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Linked Services",
"operation": "Create/Update linked services under given workspace.",
"description": "Create/Update linked services under given workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/linkedServices/delete",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Linked Services",
"operation": "Delete linked services under given workspace.",
"description": "Delete linked services under given workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/intelligencepacks/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Intelligence Packs",
"operation": "List Intelligence Packs",
"description": "Lists all intelligence packs that are visible for a given worksapce and also lists whether the pack is enabled or disabled for that workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/intelligencepacks/enable/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Intelligence Packs",
"operation": "Enable Intelligence Pack",
"description": "Enables an intelligence pack for a given workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/intelligencepacks/disable/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Intelligence Packs",
"operation": "Disable Intelligence Pack",
"description": "Disables an intelligence pack for a given workspace."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/analytics/query/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "analytics",
"operation": "Search using new engine.",
"description": "Search using new engine."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/analytics/query/schema/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "analytics",
"operation": "Get search schema V2.",
"description": "Get search schema V2."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/api/query/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "analytics",
"operation": "Search using new engine.",
"description": "Search using new engine."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/api/query/schema/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "analytics",
"operation": "Get search schema V2.",
"description": "Get search schema V2."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/purge/action",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "analytics",
"operation": "Delete specified data from workspace",
"description": "Delete specified data from workspace"
}
},
{
"name": "Microsoft.OperationalInsights/linkTargets/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Unlinked Account",
"operation": "List Unlinked Accounts",
"description": "Lists existing accounts that are not associated with an Azure subscription. To link this Azure subscription to a workspace, use a customer id returned by this operation in the customer id property of the Create Workspace operation."
}
},
{
"name": "Microsoft.OperationalInsights/workspaces/metricDefinitions/read",
"display": {
"provider": "Microsoft Operational Insights",
"resource": "Metric Definitions",
"operation": "Metric Definition operation",
"description": "Get Metric Definitions under workspace"
}
}
],
"nextLink": ""
}
Definitions
Name | Description |
---|---|
Display |
Display metadata associated with the operation. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Operation |
Supported operation of OperationalInsights resource provider. |
Operation |
Result of the request to list solution operations. |
Display
Display metadata associated with the operation.
Name | Type | Description |
---|---|---|
description |
string |
Description of operation |
operation |
string |
Type of operation: get, read, delete, etc. |
provider |
string |
Service provider: Microsoft OperationsManagement. |
resource |
string |
Resource on which the operation is performed etc. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
Operation
Supported operation of OperationalInsights resource provider.
Name | Type | Description |
---|---|---|
display |
Display metadata associated with the operation. |
|
name |
string |
Operation name: {provider}/{resource}/{operation} |
OperationListResult
Result of the request to list solution operations.
Name | Type | Description |
---|---|---|
nextLink |
string |
URL to get the next set of operation list results if there are any. |
value |
List of solution operations supported by the OperationsManagement resource provider. |