Product logo
DocsBlogPricing

Policy types for @turbot/servicenow-azure-searchmanagement

Azure > Search Management > Search Service > ServiceNow

URI
tmod:@turbot/servicenow-azure-searchmanagement#/policy/types/searchServiceServiceNow
Category
Parent
Targets

Azure > Search Management > Search Service > ServiceNow > Configuration Item

Synchronize the data for the Azure > Search Management > Search Service based on the policies Azure > Search Management > Search Service > 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 > Search Management > Search Service information within the ServiceNow CMDB.

URI
tmod:@turbot/servicenow-azure-searchmanagement#/policy/types/searchServiceServiceNowConfigurationItem
Category
Parent
Targets
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 > Search Management > Search Service > 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 > Search Management > Search Service 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-searchmanagement#/policy/types/searchServiceServiceNowConfigurationItemRecord
Category
Parent
Targets
Default Template Input
"{\n  resource: searchService{\n    data\n    metadata\n    turbot {\n      akas\n      id\n      tags\n      title\n    }\n  }\n}\n"
Default Template
"diagnostic_settings: {{ $.resource.data.diagnosticSettings | dump | safe }}\nhosting_mode: {{ $.resource.data.hostingMode | dump | safe }}\nid: {{ $.resource.data.id | dump | safe }}\nidentity: {{ $.resource.data.identity | dump | safe }}\nnetwork_rule_set: {{ $.resource.data.networkRuleSet | dump | safe }}\npartition_count: {{ $.resource.data.partitionCount | dump | safe }}\nprivate_endpoint_connections: {{ $.resource.data.privateEndpointConnections | dump | safe }}\nprovisioning_state: {{ $.resource.data.provisioningState | dump | safe }}\npublic_network_access: {{ $.resource.data.publicNetworkAccess | dump | safe }}\nregion: {{ $.resource.data.region | dump | safe }}\nreplica_count: {{ $.resource.data.replicaCount | dump | safe }}\nresource_group: {{ $.resource.metadata.azure.resourceGroupName | dump | safe }}\nsearch_service_name: {{ $.resource.data.name | dump | safe }}\nshared_private_link_resources: {{ $.resource.data.sharedPrivateLinkResources | dump | safe }}\nsku_name: {{ $.resource.data.skuName | dump | safe }}\nstatus: {{ $.resource.data.status | dump | safe }}\nstatus_details: {{ $.resource.data.statusDetails | 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 > Search Management > Search Service > ServiceNow > Configuration Item > Table Definition

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

URI
tmod:@turbot/servicenow-azure-searchmanagement#/policy/types/searchServiceServiceNowConfigurationItemTableDefinition
Category
Parent
Targets
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-searchmanagement#/policy/types/searchServiceServiceNowTableDefinition 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 > Search Management > Search Service > ServiceNow > Table

Configure a Table for Azure > Search Management > Search Service resource type in ServiceNow via the Azure > Search Management > Search Service > ServiceNow > Table > * policies.

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

Azure > Search Management > Search Service > 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 > Search Management > Search Service data.

URI
tmod:@turbot/servicenow-azure-searchmanagement#/policy/types/searchServiceServiceNowTableDefinition
Category
Parent
Targets
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_searchmanagement_searchservice",
      "label": "Azure > Search Management > Search Service",
      "extendsTable": "cmdb_ci"
    },
    "columns": [
      {
        "name": "diagnostic_settings",
        "label": "Diagnostic Settings",
        "type": "string",
        "size": 1000
      },
      {
        "name": "hosting_mode",
        "label": "Hosting Mode"
      },
      {
        "name": "id",
        "label": "ID"
      },
      {
        "name": "identity",
        "label": "Identity",
        "type": "string",
        "size": 1000
      },
      {
        "name": "network_rule_set",
        "label": "Network Rule Set",
        "type": "string",
        "size": 1000
      },
      {
        "name": "partition_count",
        "label": "Partition Count"
      },
      {
        "name": "private_endpoint_connections",
        "label": "Private Endpoint Connections",
        "type": "string",
        "size": 1000
      },
      {
        "name": "provisioning_state",
        "label": "Provisioning State"
      },
      {
        "name": "public_network_access",
        "label": "Public Network Access"
      },
      {
        "name": "region",
        "label": "Region"
      },
      {
        "name": "replica_count",
        "label": "Replica Count"
      },
      {
        "name": "resource_group",
        "label": "Resource Group"
      },
      {
        "name": "search_service_name",
        "label": "Name"
      },
      {
        "name": "shared_private_link_resources",
        "label": "Shared Private Link Resources",
        "type": "string",
        "size": 1000
      },
      {
        "name": "sku_name",
        "label": "Sku Name"
      },
      {
        "name": "status",
        "label": "Status"
      },
      {
        "name": "status_details",
        "label": "Status Details"
      },
      {
        "name": "subscription_id",
        "label": "Subscription Id"
      },
      {
        "name": "tags",
        "label": "Tags",
        "type": "string",
        "size": 1000
      },
      {
        "name": "type",
        "label": "Type"
      }
    ]
  }
}