Microsoft.OperationalInsights (preview:2019-08-01)

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

Clusters_ListByResourceGroup (new)
Description :  Gets Log Analytics clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: A list of Log Analytics clusters. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_List (new)
Description :  Gets the Log Analytics clusters in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters
{
api-version:
{
Description: The 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)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: A list of Log Analytics clusters. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_CreateOrUpdate (new)
Description :  Create or update a Log Analytics cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the Log Analytics cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Log Analytics cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a Log Analytics cluster. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The 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 (202)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_Delete (new)
Description :  Deletes a cluster instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the Log Analytics cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the Log Analytics Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_Get (new)
Description :  Gets a Log Analytics cluster instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the Log Analytics cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the Log Analytics Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_Update (new)
Description :  Updates a Log Analytics cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a Log Analytics cluster. ,
Required: True ,
}
{
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The 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)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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: The 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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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: The 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: The 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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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: The 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: The 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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
DataExport_ListByWorkspace (new)
Description :  Lists the data export instances within a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of data export instances within a workspace.. ,
Required: False ,
}
[
{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
DataExport_CreateOrUpdate (new)
Description :  Create or update a data export.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a data export. ,
Required: True ,
}
{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
DataExport_Get (new)
Description :  Gets a data export instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
DataExport_Delete (new)
Description :  Deletes the specified data export in a given workspace..
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
LinkedStorageAccounts_CreateOrUpdate (new)
Description :  Create or Update a link relation between current workspace and a group of storage accounts of a specific data source type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
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 resource. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update linked storage accounts. ,
Required: True ,
}
{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
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: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LinkedStorageAccounts_Delete (new)
Description :  Deletes all linked storage accounts of a specific data source type associated with the specified workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
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 resource. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{}
LinkedStorageAccounts_Get (new)
Description :  Gets all linked storage account of a specific data source type associated with the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
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 resource. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LinkedStorageAccounts_ListByWorkspace (new)
Description :  Gets all linked storage accounts associated with the specified workspace, storage accounts will be sorted by their data source type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that will contain the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of linked storage accounts instances. ,
Required: False ,
}
[
{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
Clusters_ListByResourceGroup (removed)
Description :  Gets Log Analytics clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: A list of Log Analytics clusters. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_List (removed)
Description :  Gets the Log Analytics clusters in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters
{
api-version:
{
Description: The 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)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: A list of Log Analytics clusters. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_CreateOrUpdate (removed)
Description :  Create or update a Log Analytics cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the Log Analytics cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Log Analytics cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a Log Analytics cluster. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The 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 (202)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_Delete (removed)
Description :  Deletes a cluster instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the Log Analytics cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the Log Analytics Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_Get (removed)
Description :  Gets a Log Analytics cluster instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the Log Analytics cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the Log Analytics Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Clusters_Update (removed)
Description :  Updates a Log Analytics cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The resource group name of the cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a Log Analytics cluster. ,
Required: True ,
}
{
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The 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)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
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 ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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: The 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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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: The 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: The 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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
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: The 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: The 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. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
DataExport_ListByWorkspace (removed)
Description :  Lists the data export instances within a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of data export instances within a workspace.. ,
Required: False ,
}
[
{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
DataExport_CreateOrUpdate (removed)
Description :  Create or update a data export.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a data export. ,
Required: True ,
}
{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
DataExport_Get (removed)
Description :  Gets a data export instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
DataExport_Delete (removed)
Description :  Deletes the specified data export in a given workspace..
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The Log Analytics workspace name. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
LinkedStorageAccounts_CreateOrUpdate (removed)
Description :  Create or Update a link relation between current workspace and a group of storage accounts of a specific data source type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
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 resource. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update linked storage accounts. ,
Required: True ,
}
{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
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: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LinkedStorageAccounts_Delete (removed)
Description :  Deletes all linked storage accounts of a specific data source type associated with the specified workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
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 resource. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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)

{}
LinkedStorageAccounts_Get (removed)
Description :  Gets all linked storage account of a specific data source type associated with the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
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 resource. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
api-version:
{
Description: The 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: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LinkedStorageAccounts_ListByWorkspace (removed)
Description :  Gets all linked storage accounts associated with the specified workspace, storage accounts will be sorted by their data source type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts
{
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 ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Log Analytics Workspace that will contain the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of linked storage accounts instances. ,
Required: False ,
}
[
{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}