Definitions for @turbot/azure-loganalytics

logAnalytics

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Log Analytics"
},
"registrationState": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/logAnalyticsAka"
}
},
"title": {
"const": "Log Analytics"
},
"custom": {
"type": "object",
"properties": {
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"required": [
"name",
"turbot"
],
"additionalProperties": true,
"tests": [
{
"description": "Base - All Valid properties",
"input": {
"name": "Log Analytics",
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.OperationalInsights/services/logAnalytics"
],
"title": "Log Analytics",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
}
},
{
"description": "Invalid - sql",
"input": {
"name": "sql",
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.OperationalInsights/services/logAnalytics"
],
"title": "sql",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
},
"expected": false
},
{
"description": "Invalid - Service name missing",
"input": {
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.OperationalInsights/services/logAnalytics"
],
"title": "Operational Insights",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
},
"expected": false
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/azure-loganalytics#/definitions/logAnalytics",
"modUri": "tmod:@turbot/azure-loganalytics"
}
}

logAnalyticsAka

{
"type": "string",
"pattern": "^azure:///subscriptions/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/providers/Microsoft.OperationalInsights/services/logAnalytics$",
"tests": [
{
"description": "base",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.OperationalInsights/services/logAnalytics"
},
{
"description": "invalid service name",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.OperationalInsights1/services/logAnalytics",
"expected": false
},
{
"description": "invalid subscription id",
"input": "azure:///subscriptions/9e3548-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.OperationalInsights/services/logAnalytics",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-loganalytics#/definitions/logAnalyticsAka",
"modUri": "tmod:@turbot/azure-loganalytics"
}
}

logAnalyticsWorkspace

{
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/workspaceName"
},
"id": {
"$ref": "#/definitions/workspaceId"
},
"location": {
"$ref": "azure#/definitions/regionName"
},
"provisioningState": {
"type": "string"
},
"source": {
"type": "string"
},
"customerId": {
"type": "string"
},
"sku": {
"type": "object"
},
"retentionInDays": {
"type": "integer"
},
"tags": {
"type": "object"
},
"turbot": {
"type": "object",
"properties": {
"title": {
"$ref": "#/definitions/workspaceName"
},
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/workspaceAka"
}
},
"custom": {
"type": "object",
"properties": {
"azure": {
"$ref": "azure#/definitions/azureMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All Valid properties",
"input": {
"name": "DefaultWorkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-CIN",
"id": "/subscriptions/0a55cd76-e849-43b4-a2c2-23318da500e4/resourcegroups/defaultresourcegroup-cin/providers/microsoft.operationalinsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin",
"type": "Microsoft.OperationalInsights/workspaces",
"location": "centralindia",
"provisioningState": "Succeeded",
"source": "Azure",
"customerId": "bca57935-8c3a-4671-9c5a-bd26bd76acfc",
"sku": {
"name": "pergb2018"
},
"retentionInDays": 30,
"tags": {},
"turbot": {
"akas": [
"azure:///subscriptions/0a55cd76-e849-43b4-a2c2-23318da500e4/resourceGroups/defaultresourcegroup-cin/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin"
],
"title": "DefaultWorkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-CIN",
"custom": {
"azure": {
"subscriptionId": "0a55cd76-e849-43b4-a2c2-23318da500e4",
"resourceGroupName": "defaultresourcegroup-cin",
"regionName": "centralindia"
}
}
}
}
},
{
"description": "invalid - workspacename property is missing",
"input": {
"id": "/subscriptions/0a55cd76-e849-43b4-a2c2-23318da500e4/resourcegroups/defaultresourcegroup-cin/providers/microsoft.operationalinsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin",
"type": "Microsoft.OperationalInsights/workspaces",
"location": "centralindia",
"turbot": {
"akas": [
"azure:///subscriptions/0a55cd76-e849-43b4-a2c2-23318da500e4/resourceGroups/defaultresourcegroup-cin/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin"
],
"title": "DefaultWorkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-CIN",
"custom": {
"azure": {
"subscriptionId": "0a55cd76-e849-43b4-a2c2-23318da500e4",
"resourceGroupName": "defaultresourcegroup-cin",
"regionName": "centralindia"
}
}
}
}
},
{
"description": "invalid - turbot metadata property is missing",
"input": {
"id": "/subscriptions/0a55cd76-e849-43b4-a2c2-23318da500e4/resourcegroups/defaultresourcegroup-cin/providers/microsoft.operationalinsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin",
"type": "Microsoft.OperationalInsights/workspaces",
"location": "centralindia"
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-loganalytics#/definitions/logAnalyticsWorkspace",
"modUri": "tmod:@turbot/azure-loganalytics"
}
}

logAnalyticsWorkspaceServiceNow

{
"defaultColumns": {
"customer_id": {
"column": "enabled",
"label": "Customer ID",
"path": "data.customerId"
},
"id": {
"column": "enabled",
"label": "ID"
},
"log_analytics_workspace_location": {
"column": "enabled",
"label": "Location",
"path": "data.location"
},
"log_analytics_workspace_name": {
"column": "enabled",
"label": "Name",
"path": "data.name"
},
"provisioning_state": {
"column": "enabled",
"label": "Provisioning State"
},
"public_network_access_for_ingestion": {
"column": "enabled",
"label": "Public Network Access For Ingestion"
},
"public_network_access_for_query": {
"column": "enabled",
"label": "Public Network Access For Query"
},
"retention_days": {
"column": "enabled",
"path": "data.retentionInDays",
"label": "Retention Days"
},
"sku_name": {
"column": "enabled",
"label": "SKU Name",
"path": "data.sku.name"
},
"resource_group": {
"column": "enabled",
"label": "Resource Group",
"path": "metadata.azure.resourceGroupName"
},
"subscription_id": {
"column": "enabled",
"label": "Subscription ID",
"path": "metadata.azure.subscriptionId"
},
"tags": {
"column": "enabled",
"label": "Tags",
"type": "string",
"size": 1000
},
"daily_ingestion_quota": {
"column": "enabled",
"label": "Daily Ingestion Quota",
"path": "data.workspaceCapping.dailyQuotaGb"
},
"data_ingestion_status": {
"column": "enabled",
"label": "Data Ingestion Status",
"path": "data.workspaceCapping.dataIngestionStatus"
},
"ingestion_quota_next_reset_time": {
"column": "enabled",
"label": "Ingestion Quota Next Reset Time",
"path": "data.workspaceCapping.quotaNextResetTime"
}
},
".turbot": {
"uri": "tmod:@turbot/azure-loganalytics#/definitions/logAnalyticsWorkspaceServiceNow",
"modUri": "tmod:@turbot/azure-loganalytics"
}
}

workspaceAka

{
"type": "string",
"pattern": "^azure:///subscriptions/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/resourceGroups/[A-Za-z0-9-_().]*[A-Za-z0-9-_()]/providers/Microsoft.OperationalInsights/workspaces/[a-zA-Z0-9][a-zA-Z0-9-]{2,63}[a-zA-Z0-9]$",
"tests": [
{
"description": "base case",
"input": "azure:///subscriptions/0a55cd76-e849-43b4-a2c2-23318da500e4/resourceGroups/defaultresourcegroup-cin/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin"
},
{
"description": "invalid - subscription info missing",
"input": "providers/microsoft.operationalinsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-loganalytics#/definitions/workspaceAka",
"modUri": "tmod:@turbot/azure-loganalytics"
}
}

workspaceId

{
"type": "string",
"pattern": "^/subscriptions/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/resourcegroups/[A-Za-z0-9-_().]*[A-Za-z0-9-_()]/providers/microsoft.operationalinsights/workspaces/[a-zA-Z0-9][a-zA-Z0-9-]{2,63}[a-zA-Z0-9]$",
"tests": [
{
"description": "base case",
"input": "/subscriptions/0a55cd76-e849-43b4-a2c2-23318da500e4/resourcegroups/defaultresourcegroup-cin/providers/microsoft.operationalinsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin"
},
{
"description": "invalid - subscription info missing",
"input": "providers/microsoft.operationalinsights/workspaces/defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-loganalytics#/definitions/workspaceId",
"modUri": "tmod:@turbot/azure-loganalytics"
}
}

workspaceName

{
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,63}[a-zA-Z0-9]$",
"tests": [
{
"description": "base case",
"input": "defaultworkspace-0a55cd76-e849-43b4-a2c2-23318da500e4-cin"
},
{
"description": "invalid - should not end with a hyphen",
"input": "test01-",
"expected": false
},
{
"description": "max length",
"input": "a1234567890-a1234567890-a1234567890-a1234567890-a1234567890-a123"
},
{
"description": "invalid - too long",
"input": "a1234567890-a1234567890-a1234567890-a1234567890-a1234567890-a12345",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-loganalytics#/definitions/workspaceName",
"modUri": "tmod:@turbot/azure-loganalytics"
}
}