Connectors Reference
Connect to your Azure Log Analytics workspace to run and visualize various Analytics queries.
|
Status: Preview |
Tier: Premium |
Version: 1.0.3 |
|
Name |
Summary |
|
List subscriptions |
|
|
List resource groups |
|
|
ListWorkspaceNames (string subscriptions, string resourcegroups) |
List workspaces |
|
RunOmsQuery (string subscriptions, string resourcegroups, string workspaces, string query) |
Run query and list results |
|
Get query schema |
|
|
Run query and visualize results |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List subscriptions
Description: Gets a list of all the subscriptions to which the principal has access.
Syntax:
AzureLogAnalytics.ListSubscriptions ()
Returns:
Description: Subscription list operation response.
Summary: List resource groups
Description: Lists all the resource groups within the subscription.
Syntax:
AzureLogAnalytics.ListResourceGroups (string subscriptions)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptions |
string (Subscription) |
Select subscription |
True |
Returns:
Description: List of resource groups.
Summary: List workspaces
Description: Lists all the resource groups within the resource group.
Syntax:
AzureLogAnalytics.ListWorkspaceNames (string subscriptions, string resourcegroups)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptions |
string (Subscription) |
Select subscription |
True |
|
|
resourcegroups |
string (Resource Group) |
Select resource group |
True |
Returns:
Description: List of resource groups.
Summary: Run query and list results
Description: Runs the query and returns the result as a set of lines which can be iterated over in the following connectors.
Syntax:
AzureLogAnalytics.RunOmsQuery (string subscriptions, string resourcegroups, string workspaces, string query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptions |
string (Subscription) |
Select subscription |
True |
|
|
resourcegroups |
string (Resource Group) |
Select resource group |
True |
|
|
workspaces |
string (Workspaces Name) |
Select workspace |
True |
|
|
query |
string
|
|
True |
Returns:
Type:Table
Summary: Get query schema
Description: Gets the schema for a specific query.
Syntax:
AzureLogAnalytics.ListArmQueryResultsSchema (string subscriptions, string resourcegroups, string workspaces, string query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptions |
string (Subscription) |
Select subscription |
True |
|
|
resourcegroups |
string (Resource Group) |
Select resource group |
True |
|
|
workspaces |
string (Workspaces Name) |
Select workspace |
True |
|
|
query |
string
|
|
True |
Returns:
Type:Object
Summary: Run query and visualize results
Description: Returns the OMS query results as a chart of your choice.
Syntax:
AzureLogAnalytics.VisualizeOmsQuery (string subscriptions, string resourcegroups, string workspaces, string query, string visType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptions |
string (Subscription) |
Select subscription |
True |
|
|
resourcegroups |
string (Resource Group) |
Select resource group |
True |
|
|
workspaces |
string (Workspaces Name) |
Select workspace |
True |
|
|
query |
string
|
|
True |
|
|
visType |
string (Chart Type)Values: [Html Table, Pie Chart, Time Chart, Bar Chart] |
Specify the resulting chart type |
True |
Returns:
Type:VisualizeResults
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Resource group information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY). |
|
name |
string Name |
The Name of the resource group. |
|
managedBy |
string Managed By |
Id of the resource that manages this resource group. |
|
tags |
Tags |
The tags attached to the resource group. |
Summary: Tags
Description: The tags attached to the resource group.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: List of resource groups.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ResourceGroup)
|
The list of resource groups. |
|
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Subscription information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. |
|
subscriptionId |
string Subscription Id |
The subscription Id. |
|
tenantId |
string Tenant Id |
The tenant Id. |
|
displayName |
string Display Name |
The subscription display name. |
|
state |
string State |
The subscription state. Values: [Enabled, Warned, PastDue, Disabled, Deleted] |
|
authorizationSource |
string Authorization Source |
The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'. |
Summary:
Description: Subscription list operation response.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Subscription)
|
The subscriptions. |
|
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Row)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
body |
string(byte) Body |
|
|
attachmentContent |
string(byte) Attachment Content |
|
|
attachmentName |
string Attachment Name |
|