Microsoft.OperationalInsights (preview:2015-11-01)

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

LinkedServices_CreateOrUpdate (new)
Description :  Create or update a linked service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that will contain the linkedServices resource ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linkedServices resource ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a linked service. ,
Required: True ,
}
{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
LinkedServices_Delete (new)
Description :  Deletes a linked service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the linkedServices resource ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linked service. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
LinkedServices_Get (new)
Description :  Gets a linked service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the linkedServices resource ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linked service. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
LinkedServices_ListByWorkspace (new)
Description :  Gets the linked services instances in a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the linked services. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of linked service instances. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
DataSources_CreateOrUpdate (new)
Description :  Create or update a data source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that will contain the datasource ,
Required: True ,
}
string ,
dataSourceName:
{
Description: The name of the datasource resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a datasource. ,
Required: True ,
}
{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
DataSources_Delete (new)
Description :  Deletes a data source instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the datasource. ,
Required: True ,
}
string ,
dataSourceName:
{
Description: Name of the datasource. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
DataSources_Get (new)
Description :  Gets a datasource instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the datasource. ,
Required: True ,
}
string ,
dataSourceName:
{
Description: Name of the datasource ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
DataSources_ListByWorkspace (new)
Description :  Gets the first page of data source instances in a workspace with the link to the next page.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The workspace that contains the data sources. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: Starting point of the collection of data source instances. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of datasources. ,
Required: False ,
}
[
{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of datasources. ,
Required: False ,
}
string ,
}
Workspaces_DisableIntelligencePack (new)
Description :  Disables an intelligence pack for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Disable
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
intelligencePackName:
{
Description: The name of the intelligence pack to be disabled. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Workspaces_EnableIntelligencePack (new)
Description :  Enables an intelligence pack for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Enable
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
intelligencePackName:
{
Description: The name of the intelligence pack to be enabled. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Workspaces_ListIntelligencePacks (new)
Description :  Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the intelligence pack. ,
Required: False ,
}
string ,
enabled:
{
Description: The enabled boolean for the intelligence pack. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the intelligence pack. ,
Required: False ,
}
string ,
}
Workspaces_GetSharedKeys (new)
Description :  Gets the shared keys for a workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/sharedKeys
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListUsages (new)
Description :  Gets a list of usage metrics for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/usages
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of usage metrics for a workspace. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
{
value:
{
Description: The system name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the metric. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The units used for the metric. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the metric. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: The quota limit for the metric. ,
Format: double ,
Required: False ,
}
number ,
nextResetTime:
{
Description: The time that the metric's value will reset. ,
Format: date-time ,
Required: False ,
}
string ,
quotaPeriod:
{
Description: The quota period that determines the length of time between value resets. ,
Required: False ,
}
string ,
}
,
]
,
}
Workspaces_ListManagementGroups (new)
Description :  Gets a list of management groups connected to a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/managementGroups
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of management groups attached to the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the management group. ,
Required: False ,
}
{
serverCount:
{
Description: The number of servers connected to the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
isGateway:
{
Description: Gets or sets a value indicating whether the management group is a gateway. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the management group. ,
Required: False ,
}
string ,
id:
{
Description: The unique ID of the management group. ,
Required: False ,
}
string ,
created:
{
Description: The datetime that the management group was created. ,
Format: date-time ,
Required: False ,
}
string ,
dataReceived:
{
Description: The last datetime that the management group received data. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: The version of System Center that is managing the management group. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of System Center that is managing the management group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
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 to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
Workspaces_List (new)
Description :  Gets the workspaces in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
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 resource group name of the workspace. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
Workspaces_Delete (new)
Description :  Deletes a workspace instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The resource group name of the workspace. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Workspaces_Get (new)
Description :  Gets a workspace instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The resource group name of the workspace. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
Workspaces_Update (new)
Description :  Updates a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The resource group name of the workspace. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
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: Client Api Version. ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
GetAsyncOperationsStatus (new)
Description :  Get the status of an azure asynchronous operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/locations/{location}/operationStatuses/{asyncOperationId}
{
location:
{
Description: The region name of operation. ,
Required: True ,
}
string ,
asyncOperationId:
{
Description: The operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LinkedServices_CreateOrUpdate (removed)
Description :  Create or update a linked service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that will contain the linkedServices resource ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linkedServices resource ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a linked service. ,
Required: True ,
}
{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
LinkedServices_Delete (removed)
Description :  Deletes a linked service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the linkedServices resource ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linked service. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
LinkedServices_Get (removed)
Description :  Gets a linked service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the linkedServices resource ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linked service. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
LinkedServices_ListByWorkspace (removed)
Description :  Gets the linked services instances in a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the linked services. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of linked service instances. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
DataSources_CreateOrUpdate (removed)
Description :  Create or update a data source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that will contain the datasource ,
Required: True ,
}
string ,
dataSourceName:
{
Description: The name of the datasource resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a datasource. ,
Required: True ,
}
{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
DataSources_Delete (removed)
Description :  Deletes a data source instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the datasource. ,
Required: True ,
}
string ,
dataSourceName:
{
Description: Name of the datasource. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
DataSources_Get (removed)
Description :  Gets a datasource instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that contains the datasource. ,
Required: True ,
}
string ,
dataSourceName:
{
Description: Name of the datasource ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
DataSources_ListByWorkspace (removed)
Description :  Gets the first page of data source instances in a workspace with the link to the next page.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The workspace that contains the data sources. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: Starting point of the collection of data source instances. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of datasources. ,
Required: False ,
}
[
{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
eTag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
AzureActivityLog: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingDefaultPath: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingCustomRegistry: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
GenericDataSource: No description available. ,
IISLogs: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of datasources. ,
Required: False ,
}
string ,
}
Workspaces_DisableIntelligencePack (removed)
Description :  Disables an intelligence pack for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Disable
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
intelligencePackName:
{
Description: The name of the intelligence pack to be disabled. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Workspaces_EnableIntelligencePack (removed)
Description :  Enables an intelligence pack for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Enable
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
intelligencePackName:
{
Description: The name of the intelligence pack to be enabled. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Workspaces_ListIntelligencePacks (removed)
Description :  Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the intelligence pack. ,
Required: False ,
}
string ,
enabled:
{
Description: The enabled boolean for the intelligence pack. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the intelligence pack. ,
Required: False ,
}
string ,
}
Workspaces_GetSharedKeys (removed)
Description :  Gets the shared keys for a workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/sharedKeys
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListUsages (removed)
Description :  Gets a list of usage metrics for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/usages
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of usage metrics for a workspace. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
{
value:
{
Description: The system name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the metric. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The units used for the metric. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the metric. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: The quota limit for the metric. ,
Format: double ,
Required: False ,
}
number ,
nextResetTime:
{
Description: The time that the metric's value will reset. ,
Format: date-time ,
Required: False ,
}
string ,
quotaPeriod:
{
Description: The quota period that determines the length of time between value resets. ,
Required: False ,
}
string ,
}
,
]
,
}
Workspaces_ListManagementGroups (removed)
Description :  Gets a list of management groups connected to a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/managementGroups
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of management groups attached to the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the management group. ,
Required: False ,
}
{
serverCount:
{
Description: The number of servers connected to the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
isGateway:
{
Description: Gets or sets a value indicating whether the management group is a gateway. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the management group. ,
Required: False ,
}
string ,
id:
{
Description: The unique ID of the management group. ,
Required: False ,
}
string ,
created:
{
Description: The datetime that the management group was created. ,
Format: date-time ,
Required: False ,
}
string ,
dataReceived:
{
Description: The last datetime that the management group received data. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: The version of System Center that is managing the management group. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of System Center that is managing the management group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
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 to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
Workspaces_List (removed)
Description :  Gets the workspaces in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
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 resource group name of the workspace. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
Workspaces_Delete (removed)
Description :  Deletes a workspace instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The resource group name of the workspace. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Workspaces_Get (removed)
Description :  Gets a workspace instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The resource group name of the workspace. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
Workspaces_Update (removed)
Description :  Updates a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The resource group name of the workspace. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. ,
Required: False ,
}
string ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
portalUrl:
{
Description: This is a legacy property and is not used anymore. Kept here for backward compatibility. ,
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. ,
}
,
Required: True ,
}
enum ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The ETag of the workspace. ,
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: Client Api Version. ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
GetAsyncOperationsStatus (removed)
Description :  Get the status of an azure asynchronous operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/locations/{location}/operationStatuses/{asyncOperationId}
{
location:
{
Description: The region name of operation. ,
Required: True ,
}
string ,
asyncOperationId:
{
Description: The operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}