Product logo
DocsBlogPricing

Policy types for @turbot/servicenow-azure-recoveryservice

Azure > Recovery Service > Backup > ServiceNow

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/backupServiceNow
Category
Parent
Targets

Azure > Recovery Service > Backup > ServiceNow > Configuration Item

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

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/backupServiceNowConfigurationItem
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 > Recovery Service > Backup > 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 > Recovery Service > Backup 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-recoveryservice#/policy/types/backupServiceNowConfigurationItemRecord
Category
Parent
Targets
Default Template Input
"{\n  resource: backup{\n    data\n    metadata\n    turbot {\n      akas\n      id\n      tags\n      title\n    }\n  }\n}\n"
Default Template
"backup_name: {{ $.resource.data.name | dump | safe }}\netag: {{ $.resource.data.etag | dump | safe }}\nid: {{ $.resource.data.id | dump | safe }}\nproperties: {{ $.resource.data.properties | dump | safe }}\nresource_group: {{ $.resource.metadata.azure.resourceGroupName | dump | safe }}\nsubscription_id: {{ $.resource.metadata.azure.subscriptionId | dump | safe }}\ntype: {{ $.resource.data.type | dump | safe }}\nvault_name: {{ $.resource.metadata.vaultName | dump | safe }}\n"
Schema
{
  "type": "object"
}

Azure > Recovery Service > Backup > ServiceNow > Configuration Item > Table Definition

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

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/backupServiceNowConfigurationItemTableDefinition
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-recoveryservice#/policy/types/backupServiceNowTableDefinition 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 > Recovery Service > Backup > ServiceNow > Table

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

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

Azure > Recovery Service > Backup > 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 > Recovery Service > Backup data.

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/backupServiceNowTableDefinition
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_recoveryservice_backup",
      "label": "Azure > Recovery Service > Backup",
      "extendsTable": "cmdb_ci"
    },
    "columns": [
      {
        "name": "backup_name",
        "label": "Backup Name"
      },
      {
        "name": "etag",
        "label": "Etag"
      },
      {
        "name": "id",
        "label": "ID"
      },
      {
        "name": "properties",
        "label": "Properties",
        "type": "string",
        "size": 1000
      },
      {
        "name": "resource_group",
        "label": "Resource Group"
      },
      {
        "name": "subscription_id",
        "label": "Subscription ID"
      },
      {
        "name": "type",
        "label": "Type"
      },
      {
        "name": "vault_name",
        "label": "Vault Name"
      }
    ]
  }
}

Azure > Recovery Service > Vault > ServiceNow

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/vaultServiceNow
Category
Parent
Targets

Azure > Recovery Service > Vault > ServiceNow > Configuration Item

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

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/vaultServiceNowConfigurationItem
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 > Recovery Service > Vault > 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 > Recovery Service > Vault 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-recoveryservice#/policy/types/vaultServiceNowConfigurationItemRecord
Category
Parent
Targets
Default Template Input
"{\n  resource: vault{\n    data\n    metadata\n    turbot {\n      akas\n      id\n      tags\n      title\n    }\n  }\n}\n"
Default Template
"etag: {{ $.resource.data.etag | dump | safe }}\nid: {{ $.resource.data.id | dump | safe }}\nidentity: {{ $.resource.data.identity | dump | safe }}\nprivate_endpoint_connections: {{ $.resource.data.properties.privateEndpointConnections | dump | safe }}\nprivate_endpoint_state_for_backup: {{ $.resource.data.properties.privateEndpointStateForBackup | dump | safe }}\nprivate_endpoint_state_for_site_recovery: {{ $.resource.data.properties.privateEndpointStateForSiteRecovery | dump | safe }}\nprovisioning_state: {{ $.resource.data.properties.provisioningState | dump | safe }}\nredundancy_settings: {{ $.resource.data.properties.redundancySettings | dump | safe }}\nregion: {{ $.resource.metadata.azure.regionName | dump | safe }}\nresource_group: {{ $.resource.metadata.azure.resourceGroupName | dump | safe }}\nsku: {{ $.resource.data.sku | dump | safe }}\nsubscription_id: {{ $.resource.metadata.azure.subscriptionId | dump | safe }}\ntags: {{ $.resource.turbot.tags | dump | safe }}\ntype: {{ $.resource.data.type | dump | safe }}\nvault_name: {{ $.resource.data.name | dump | safe }}\n"
Schema
{
  "type": "object"
}

Azure > Recovery Service > Vault > ServiceNow > Configuration Item > Table Definition

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

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/vaultServiceNowConfigurationItemTableDefinition
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-recoveryservice#/policy/types/vaultServiceNowTableDefinition 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 > Recovery Service > Vault > ServiceNow > Table

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

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

Azure > Recovery Service > Vault > 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 > Recovery Service > Vault data.

URI
tmod:@turbot/servicenow-azure-recoveryservice#/policy/types/vaultServiceNowTableDefinition
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_recoveryservice_vault",
      "label": "Azure > Recovery Service > Vault",
      "extendsTable": "cmdb_ci"
    },
    "columns": [
      {
        "name": "etag",
        "label": "Etag"
      },
      {
        "name": "id",
        "label": "ID"
      },
      {
        "name": "identity",
        "label": "Identity",
        "type": "string",
        "size": 1000
      },
      {
        "name": "private_endpoint_connections",
        "label": "Private Endpoint Connections",
        "type": "string",
        "size": 1000
      },
      {
        "name": "private_endpoint_state_for_backup",
        "label": "Private Endpoint State For Backup"
      },
      {
        "name": "private_endpoint_state_for_site_recovery",
        "label": "Private Endpoint State For Site Recovery"
      },
      {
        "name": "provisioning_state",
        "label": "Provisioning State"
      },
      {
        "name": "redundancy_settings",
        "label": "Redundancy Settings",
        "type": "string",
        "size": 1000
      },
      {
        "name": "region",
        "label": "Region"
      },
      {
        "name": "resource_group",
        "label": "Resource Group"
      },
      {
        "name": "sku",
        "label": "SKU",
        "type": "string",
        "size": 200
      },
      {
        "name": "subscription_id",
        "label": "Subscription ID"
      },
      {
        "name": "tags",
        "label": "Tags",
        "type": "string",
        "size": 1000
      },
      {
        "name": "type",
        "label": "Type"
      },
      {
        "name": "vault_name",
        "label": "Name"
      }
    ]
  }
}