Policy types for @turbot/servicenow-azure-monitor

Azure > Monitor > Action Group > ServiceNow

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/actionGroupServiceNow
Targets

Azure > Monitor > Action Group > ServiceNow > Configuration Item

Synchronize the data for the Azure > Monitor > Action Group based on the policies Azure > Monitor > Action Group > ServiceNow > Configuration Item > *

The Configuration Item control is responsible for automatically synchronizing records in a designated ServiceNow table, maintaining an up-to-date reflection of the Azure > Monitor > Action Group information within the ServiceNow CMDB.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/actionGroupServiceNowConfigurationItem
Valid Value
[
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
],
"example": [
"Skip"
],
"default": "Skip"
}

Azure > Monitor > Action Group > ServiceNow > Configuration Item > Record

The policy facilitates the accurate representation of cloud resource within the ServiceNow environment, ensuring that critical data is effectively mapped and managed. Attribute of an Azure > Monitor > Action Group is systematically mapped to a specific column in a ServiceNow table.

The policy allows enabling organizations to select and map only those attributes that are most relevant to their operational needs. It significantly reduces the manual effort involved in data transfer and minimizes the risk of errors, thereby enhancing the overall efficiency of data management.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/actionGroupServiceNowConfigurationItemRecord
Default Template Input
"{\n resource: actionGroup{\n data\n metadata\n turbot {\n akas\n id\n tags\n title\n }\n }\n}\n"
Default Template
"action_group_location: {{ $.resource.data.location | dump | safe }}\naction_group_name: {{ $.resource.data.name | dump | safe }}\ngroup_short_name: {{ $.resource.data.groupShortName | dump | safe }}\nid: {{ $.resource.data.id | dump | safe }}\nlogic_app_receivers: {{ $.resource.data.logicAppReceivers | dump | safe }}\nresource_group: {{ $.resource.metadata.azure.resourceGroupName | dump | safe }}\nsubscription_id: {{ $.resource.metadata.azure.subscriptionId | dump | safe }}\ntags: {{ $.resource.turbot.tags | dump | safe }}\ntype: {{ $.resource.data.type | dump | safe }}\nvoice_receivers: {{ $.resource.data.voiceReceivers | dump | safe }}\nwebhook_receivers: {{ $.resource.data.webhookReceivers | dump | safe }}\n"
Schema
{
"type": "object"
}

Azure > Monitor > Action Group > ServiceNow > Configuration Item > Table Definition

This policy specifically allows users to define two key aspects: the name of the ServiceNow table where the Azure > Monitor > Action Group data will be stored, and the details of the columns used for archiving purposes.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/actionGroupServiceNowConfigurationItemTableDefinition
Default Template Input
[
"{\n serviceNowInstance: resources(filter: \"resourceTypeId:tmod:@turbot/servicenow#/resource/types/instance level:self limit:1\") {\n items {\n turbot {\n id\n }\n }\n }\n}\n",
"{\n tableDefinition: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow-azure-monitor#/policy/types/actionGroupServiceNowTableDefinition resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n applicationScope: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow#/policy/types/serviceNowApplicationScope resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n}\n"
]
Default Template
"tableName: "{%- if $.applicationScope.items | length == 0 or $.tableDefinition.items | length == 0 %} {%- else %}{{$.applicationScope.items[0].value}}_{{$.tableDefinition.items[0].value.table.name | lower}}{% endif %}"\n"
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"tableName"
],
"properties": {
"tableName": {
"type": "string"
},
"archiveColumns": {
"type": "object"
}
}
}

Azure > Monitor > Action Group > ServiceNow > Table

Configure a Table for Azure > Monitor > Action Group resource type in ServiceNow via the Azure > Monitor > Action Group > ServiceNow > Table > * policies.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/actionGroupServiceNowTable
Valid Value
[
"Skip",
"Check: Configured",
"Enforce: Configured"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Configured",
"Enforce: Configured"
],
"example": [
"Skip"
],
"default": "Skip"
}

Azure > Monitor > Action Group > ServiceNow > Table > Definition

The policy enables the definition of ServiceNow table properties, including its name and the base table from which it extends, and details the specific columns required for representing Azure > Monitor > Action Group data.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/actionGroupServiceNowTableDefinition
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"table",
"columns"
],
"properties": {
"table": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string"
},
"extendsTable": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
}
}
},
"columns": {
"type": "array",
"description": "An array of columns with their mappings to the CMDB.",
"default": [],
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the column in the table.",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string",
"description": "The label for the column."
},
"type": {
"description": "The data type of the column.",
"type": "string"
},
"size": {
"type": "integer",
"description": "The length for data type."
}
}
}
}
},
"default": {
"table": {
"name": "guardrails_azure_monitor_actiongroup",
"label": "Azure > Monitor > Action Group",
"extendsTable": "cmdb_ci"
},
"columns": [
{
"name": "action_group_location",
"label": "Location"
},
{
"name": "action_group_name",
"label": "Name"
},
{
"name": "group_short_name",
"label": "Group Short Name",
"type": "string"
},
{
"name": "id",
"label": "ID"
},
{
"name": "logic_app_receivers",
"label": "Logic App Receivers",
"type": "string",
"size": 1000
},
{
"name": "resource_group",
"label": "Resource Group",
"type": "string",
"size": 200
},
{
"name": "subscription_id",
"label": "Subscription ID"
},
{
"name": "tags",
"label": "Tags",
"type": "string",
"size": 1000
},
{
"name": "type",
"label": "Type"
},
{
"name": "voice_receivers",
"label": "Voice Receivers",
"type": "string",
"size": 1000
},
{
"name": "webhook_receivers",
"label": "Webhook Receivers",
"type": "string",
"size": 1000
}
]
}
}

Azure > Monitor > Alerts > ServiceNow

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/alertsServiceNow
Targets

Azure > Monitor > Alerts > ServiceNow > Configuration Item

Synchronize the data for the Azure > Monitor > Alerts based on the policies Azure > Monitor > Alerts > ServiceNow > Configuration Item > *

The Configuration Item control is responsible for automatically synchronizing records in a designated ServiceNow table, maintaining an up-to-date reflection of the Azure > Monitor > Alerts information within the ServiceNow CMDB.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/alertsServiceNowConfigurationItem
Valid Value
[
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
],
"example": [
"Skip"
],
"default": "Skip"
}

Azure > Monitor > Alerts > ServiceNow > Configuration Item > Record

The policy facilitates the accurate representation of cloud resource within the ServiceNow environment, ensuring that critical data is effectively mapped and managed. Attribute of an Azure > Monitor > Alerts is systematically mapped to a specific column in a ServiceNow table.

The policy allows enabling organizations to select and map only those attributes that are most relevant to their operational needs. It significantly reduces the manual effort involved in data transfer and minimizes the risk of errors, thereby enhancing the overall efficiency of data management.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/alertsServiceNowConfigurationItemRecord
Default Template Input
"{\n resource: alerts{\n data\n metadata\n turbot {\n akas\n id\n tags\n title\n }\n }\n}\n"
Default Template
"actions: {{ $.resource.data.actions | dump | safe }}\nalerts_location: {{ $.resource.data.location | dump | safe }}\nalerts_name: {{ $.resource.data.name | dump | safe }}\ncondition: {{ $.resource.data.condition | dump | safe }}\nid: {{ $.resource.data.id | dump | safe }}\nresource_group: {{ $.resource.metadata.azure.resourceGroupName | dump | safe }}\nsubscription_id: {{ $.resource.metadata.azure.subscriptionId | dump | safe }}\ntags: {{ $.resource.turbot.tags | dump | safe }}\ntype: {{ $.resource.data.type | dump | safe }}\n"
Schema
{
"type": "object"
}

Azure > Monitor > Alerts > ServiceNow > Configuration Item > Table Definition

This policy specifically allows users to define two key aspects: the name of the ServiceNow table where the Azure > Monitor > Alerts data will be stored, and the details of the columns used for archiving purposes.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/alertsServiceNowConfigurationItemTableDefinition
Default Template Input
[
"{\n serviceNowInstance: resources(filter: \"resourceTypeId:tmod:@turbot/servicenow#/resource/types/instance level:self limit:1\") {\n items {\n turbot {\n id\n }\n }\n }\n}\n",
"{\n tableDefinition: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow-azure-monitor#/policy/types/alertsServiceNowTableDefinition resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n applicationScope: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow#/policy/types/serviceNowApplicationScope resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n}\n"
]
Default Template
"tableName: "{%- if $.applicationScope.items | length == 0 or $.tableDefinition.items | length == 0 %} {%- else %}{{$.applicationScope.items[0].value}}_{{$.tableDefinition.items[0].value.table.name | lower}}{% endif %}"\n"
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"tableName"
],
"properties": {
"tableName": {
"type": "string"
},
"archiveColumns": {
"type": "object"
}
}
}

Azure > Monitor > Alerts > ServiceNow > Table

Configure a Table for Azure > Monitor > Alerts resource type in ServiceNow via the Azure > Monitor > Alerts > ServiceNow > Table > * policies.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/alertsServiceNowTable
Valid Value
[
"Skip",
"Check: Configured",
"Enforce: Configured"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Configured",
"Enforce: Configured"
],
"example": [
"Skip"
],
"default": "Skip"
}

Azure > Monitor > Alerts > ServiceNow > Table > Definition

The policy enables the definition of ServiceNow table properties, including its name and the base table from which it extends, and details the specific columns required for representing Azure > Monitor > Alerts data.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/alertsServiceNowTableDefinition
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"table",
"columns"
],
"properties": {
"table": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string"
},
"extendsTable": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
}
}
},
"columns": {
"type": "array",
"description": "An array of columns with their mappings to the CMDB.",
"default": [],
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the column in the table.",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string",
"description": "The label for the column."
},
"type": {
"description": "The data type of the column.",
"type": "string"
},
"size": {
"type": "integer",
"description": "The length for data type."
}
}
}
}
},
"default": {
"table": {
"name": "guardrails_azure_monitor_alerts",
"label": "Azure > Monitor > Alerts",
"extendsTable": "cmdb_ci"
},
"columns": [
{
"name": "actions",
"label": "Actions"
},
{
"name": "alerts_location",
"label": "Location"
},
{
"name": "alerts_name",
"label": "Name"
},
{
"name": "condition",
"label": "Condition"
},
{
"name": "id",
"label": "ID"
},
{
"name": "resource_group",
"label": "Resource Group",
"type": "string",
"size": 200
},
{
"name": "subscription_id",
"label": "Subscription ID"
},
{
"name": "tags",
"label": "Tags",
"type": "string",
"size": 1000
},
{
"name": "type",
"label": "Type"
}
]
}
}

Azure > Monitor > Log Profile > ServiceNow

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/logProfileServiceNow
Targets

Azure > Monitor > Log Profile > ServiceNow > Configuration Item

Synchronize the data for the Azure > Monitor > Log Profile based on the policies Azure > Monitor > Log Profile > ServiceNow > Configuration Item > *

The Configuration Item control is responsible for automatically synchronizing records in a designated ServiceNow table, maintaining an up-to-date reflection of the Azure > Monitor > Log Profile information within the ServiceNow CMDB.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/logProfileServiceNowConfigurationItem
Valid Value
[
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
],
"example": [
"Skip"
],
"default": "Skip"
}

Azure > Monitor > Log Profile > ServiceNow > Configuration Item > Record

The policy facilitates the accurate representation of cloud resource within the ServiceNow environment, ensuring that critical data is effectively mapped and managed. Attribute of an Azure > Monitor > Log Profile is systematically mapped to a specific column in a ServiceNow table.

The policy allows enabling organizations to select and map only those attributes that are most relevant to their operational needs. It significantly reduces the manual effort involved in data transfer and minimizes the risk of errors, thereby enhancing the overall efficiency of data management.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/logProfileServiceNowConfigurationItemRecord
Default Template Input
"{\n resource: logProfile{\n data\n metadata\n turbot {\n akas\n id\n tags\n title\n }\n }\n}\n"
Default Template
"categories: {{ $.resource.data.categories | dump | safe }}\nid: {{ $.resource.data.id | dump | safe }}\nlog_profile_locations: {{ $.resource.data.locations | dump | safe }}\nlog_profile_name: {{ $.resource.data.name | dump | safe }}\nretention_policy: {{ $.resource.data.retentionPolicy | dump | safe }}\nstorage_account_id: {{ $.resource.data.storageAccountId | dump | safe }}\nsubscription_id: {{ $.resource.metadata.azure.subscriptionId | dump | safe }}\ntags: {{ $.resource.turbot.tags | dump | safe }}\n"
Schema
{
"type": "object"
}

Azure > Monitor > Log Profile > ServiceNow > Configuration Item > Table Definition

This policy specifically allows users to define two key aspects: the name of the ServiceNow table where the Azure > Monitor > Log Profile data will be stored, and the details of the columns used for archiving purposes.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/logProfileServiceNowConfigurationItemTableDefinition
Default Template Input
[
"{\n serviceNowInstance: resources(filter: \"resourceTypeId:tmod:@turbot/servicenow#/resource/types/instance level:self limit:1\") {\n items {\n turbot {\n id\n }\n }\n }\n}\n",
"{\n tableDefinition: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow-azure-monitor#/policy/types/logProfileServiceNowTableDefinition resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n applicationScope: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow#/policy/types/serviceNowApplicationScope resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n}\n"
]
Default Template
"tableName: "{%- if $.applicationScope.items | length == 0 or $.tableDefinition.items | length == 0 %} {%- else %}{{$.applicationScope.items[0].value}}_{{$.tableDefinition.items[0].value.table.name | lower}}{% endif %}"\n"
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"tableName"
],
"properties": {
"tableName": {
"type": "string"
},
"archiveColumns": {
"type": "object"
}
}
}

Azure > Monitor > Log Profile > ServiceNow > Table

Configure a Table for Azure > Monitor > Log Profile resource type in ServiceNow via the Azure > Monitor > Log Profile > ServiceNow > Table > * policies.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/logProfileServiceNowTable
Valid Value
[
"Skip",
"Check: Configured",
"Enforce: Configured"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Configured",
"Enforce: Configured"
],
"example": [
"Skip"
],
"default": "Skip"
}

Azure > Monitor > Log Profile > ServiceNow > Table > Definition

The policy enables the definition of ServiceNow table properties, including its name and the base table from which it extends, and details the specific columns required for representing Azure > Monitor > Log Profile data.

URI
tmod:@turbot/servicenow-azure-monitor#/policy/types/logProfileServiceNowTableDefinition
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"table",
"columns"
],
"properties": {
"table": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string"
},
"extendsTable": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
}
}
},
"columns": {
"type": "array",
"description": "An array of columns with their mappings to the CMDB.",
"default": [],
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the column in the table.",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string",
"description": "The label for the column."
},
"type": {
"description": "The data type of the column.",
"type": "string"
},
"size": {
"type": "integer",
"description": "The length for data type."
}
}
}
}
},
"default": {
"table": {
"name": "guardrails_azure_monitor_logprofile",
"label": "Azure > Monitor > Log Profile",
"extendsTable": "cmdb_ci"
},
"columns": [
{
"name": "categories",
"label": "Categories"
},
{
"name": "id",
"label": "ID"
},
{
"name": "log_profile_locations",
"label": "Location"
},
{
"name": "log_profile_name",
"label": "Name"
},
{
"name": "retention_policy",
"label": "Retention Policy",
"type": "string",
"size": 1000
},
{
"name": "storage_account_id",
"label": "Storage Account ID",
"type": "string"
},
{
"name": "subscription_id",
"label": "Subscription ID"
},
{
"name": "tags",
"label": "Tags",
"type": "string",
"size": 1000
}
]
}
}