Definitions for @turbot/azure-synapseanalytics

sqlPool

{
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/sqlPoolName"
},
"tags": {
"$ref": "azure#/definitions/tags"
},
"id": {
"type": "string"
},
"location": {
"type": "string"
},
"collation": {
"type": "string"
},
"creationDate": {
"type": "string"
},
"maxSizeBytes": {
"type": "string"
},
"provisioningState": {
"type": "string"
},
"sku": {
"type": "object"
},
"status": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/sqlPoolAka"
}
},
"title": {
"$ref": "#/definitions/sqlPoolName"
},
"tags": {
"$ref": "azure#/definitions/tags"
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"collation": "SQL_Latin1_General_CP1_CI_AS",
"createMode": null,
"creationDate": "2020-06-02T10:04:14.107000+00:00",
"id": "/subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace123/sqlPools/testsumitpool",
"location": "eastus",
"maxSizeBytes": 263882790666240,
"name": "testsumitpool",
"provisioningState": "Succeeded",
"recoverableDatabaseId": null,
"resourceGroup": "test_sumit_rg",
"restorePointInTime": "0001-01-01T00:00:00",
"sku": {
"name": "DW100c",
"tier": null
},
"sourceDatabaseId": null,
"status": "Online",
"tags": {
"Captain": "Marvel"
},
"type": "Microsoft.Synapse/workspaces/sqlPools",
"turbot": {
"akas": [
"azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace123/sqlPools/testsumitpool"
],
"title": "testsumitpool",
"tags": {
"Captain": "Marvel"
},
"custom": {
"azure": {
"subscriptionId": "3510ae4d-530b-497d-8f30-53b9616fc6c1",
"resourceGroupName": "test_sumit_rg"
}
}
}
}
},
{
"description": "Invalid - Name is missing",
"input": {
"turbot": {
"akas": [
"azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace123/sqlPools/testsumitpool"
],
"title": "testsumitpool",
"custom": {
"azure": {
"subscriptionId": "3510ae4d-530b-497d-8f30-53b9616fc6c1",
"resourceGroupName": "test_sumit_rg"
}
}
}
}
},
{
"description": "Invalid - Service name missing",
"input": {
"turbot": {
"akas": [
"azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace123/sqlPools/testsumitpool"
],
"title": "testsumitpool",
"custom": {
"azure": {
"subscriptionId": "3510ae4d-530b-497d-8f30-53b9616fc6c1",
"resourceGroupName": "test_sumit_rg"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/sqlPool",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}

sqlPoolAka

{
"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}/resource(?:Groups|groups)/[A-Za-z0-9-_().]*[A-Za-z0-9-_()]/providers/(?:M|m)icrosoft.(?:S|s)ynapse/workspaces/[a-z0-9]{1,45}(?<!-ondemand)/sql(?:P|p)ools/[a-zA-Z0-9]{1,15}$",
"tests": [
{
"description": "base case",
"input": "azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace123/sqlPools/testsumitpool"
},
{
"description": "invalid - Wrong Account id",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2chkjfhhdshfkndjfjkdsjh77f7/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace123/sqlPools/testsumitpool",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/sqlPoolAka",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}

sqlPoolName

{
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,15}$",
"tests": [
{
"description": "base case",
"input": "testsumitpool"
},
{
"description": "invalid - Hyphen can use first",
"input": "-test",
"expected": false
},
{
"description": "invalid - Hyphen can not be at last position",
"input": "test-",
"expected": false
},
{
"description": "invalid - cannot be more than 15 characters",
"input": "testsumitpool1234567890098",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/sqlPoolName",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}

synapseAnalytics

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Synapse Analytics"
},
"namespace": {
"const": "Microsoft.Synapse"
},
"registrationState": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/synapseAnalyticsAka"
}
},
"title": {
"const": "Synapse Analytics"
},
"custom": {
"type": "object",
"properties": {
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"required": [
"name",
"turbot"
],
"additionalProperties": true,
"tests": [
{
"description": "All details provided",
"input": {
"name": "Synapse Analytics",
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.Synapse/services/synapseAnalytics"
],
"title": "Synapse Analytics",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
}
},
{
"description": "Invalid - Name is not as declared",
"input": {
"name": "synapseAnalytics",
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.Synapse/services/synapseAnalytics"
],
"title": "Synapse Analytics",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
},
"expected": false
},
{
"description": "Invalid - Service name missing",
"input": {
"turbot": null,
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.Synapse/services/synapseAnalytics"
],
"title": "Synapse Analytics",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
},
"expected": false
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/synapseAnalytics",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}

synapseAnalyticsAka

{
"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/(?:M|m)icrosoft.(?:S|s)ynapse/services/synapse(?:A|a)nalytics$",
"tests": [
{
"description": "base",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.Synapse/services/synapseAnalytics"
},
{
"description": "invalid service name",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.Synapse/services/sql",
"expected": false
},
{
"description": "invalid subscription id",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-12345-b72bdd2c77f7/providers/Microsoft.Synapse/services/synapseAnalytics",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/synapseAnalyticsAka",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}

synapseWorkspace

{
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/synapseWorkspaceName"
},
"tags": {
"$ref": "azure#/definitions/tags"
},
"id": {
"type": "string"
},
"location": {
"type": "string"
},
"connectivityEndpoints": {
"type": "object"
},
"defaultDataLakeStorage": {
"type": "object"
},
"identity": {
"type": "object"
},
"managedResourceGroupName": {
"type": "string"
},
"privateEndpointConnections": {
"type": "array"
},
"provisioningState": {
"type": "string"
},
"sqlAdministratorLogin": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/synapseWorkspaceAka"
}
},
"title": {
"$ref": "#/definitions/synapseWorkspaceName"
},
"tags": {
"$ref": "azure#/definitions/tags"
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"connectivityEndpoints": {
"dev": "https://testsumitworkspace.dev.azuresynapse.net",
"sql": "testsumitworkspace.sql.azuresynapse.net",
"sqlOnDemand": "testsumitworkspace-ondemand.sql.azuresynapse.net",
"web": "https://web.azuresynapse.net?workspace=%2fsubscriptions%2f3510ae4d-530b-497d-8f30-53b9616fc6c1%2fresourceGroups%2ftest_sumit_rg%2fproviders%2fMicrosoft.Synapse%2fworkspaces%2ftestsumitworkspace"
},
"defaultDataLakeStorage": {
"accountUrl": "https://testsumitaccount.dfs.core.windows.net",
"filesystem": "testsumitfs"
},
"id": "/subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace",
"identity": {
"principalId": "da45bb03-e24f-4b55-b3b2-7477a6f3d553",
"tenantId": "cdffd708-7da0-4cea-abeb-0a4c334d7f64",
"type": "SystemAssigned"
},
"location": "eastus",
"managedResourceGroupName": "workspacemanagedrg-1fc5a916-0655-4a1b-a8bb-18b5c342db6c",
"managedVirtualNetwork": null,
"name": "testsumitworkspace",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"resourceGroup": "test_sumit_rg",
"sqlAdministratorLogin": "sqladminuser",
"sqlAdministratorLoginPassword": null,
"tags": {
"Alpha": "Centauri"
},
"type": "Microsoft.Synapse/workspaces",
"virtualNetworkProfile": null,
"turbot": {
"akas": [
"azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace"
],
"title": "testsumitworkspace",
"tags": {
"Alpha": "Centauri"
},
"custom": {
"azure": {
"subscriptionId": "3510ae4d-530b-497d-8f30-53b9616fc6c1",
"resourceGroupName": "test_sumit_rg"
}
}
}
}
},
{
"description": "Invalid - Name is missing",
"input": {
"turbot": {
"akas": [
"azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace"
],
"title": "testsumitworkspace",
"custom": {
"azure": {
"subscriptionId": "3510ae4d-530b-497d-8f30-53b9616fc6c1",
"resourceGroupName": "test_sumit_rg"
}
}
}
}
},
{
"description": "Invalid - Service name missing",
"input": {
"turbot": {
"akas": [
"azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace"
],
"title": "testsumitworkspace",
"custom": {
"azure": {
"subscriptionId": "3510ae4d-530b-497d-8f30-53b9616fc6c1",
"resourceGroupName": "test_sumit_rg"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/synapseWorkspace",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}

synapseWorkspaceAka

{
"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}/resource(?:Groups|groups)/[A-Za-z0-9-_().]*[A-Za-z0-9-_()]/providers/(?:M|m)icrosoft.(?:S|s)ynapse/workspaces/[a-z0-9]{1,45}(?<!-ondemand)$",
"tests": [
{
"description": "base case",
"input": "azure:///subscriptions/3510ae4d-530b-497d-8f30-53b9616fc6c1/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace"
},
{
"description": "invalid - Wrong Account id",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2chkjfhhdshfkndjfjkdsjh77f7/resourceGroups/test_sumit_rg/providers/Microsoft.Synapse/workspaces/testsumitworkspace",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/synapseWorkspaceAka",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}

synapseWorkspaceName

{
"type": "string",
"pattern": "^[a-z0-9]{1,45}(?<!-ondemand)$",
"tests": [
{
"description": "base case",
"input": "testsumitworkspace"
},
{
"description": "invalid - Hyphen can use first",
"input": "-test",
"expected": false
},
{
"description": "invalid - Hyphen can not be at last position",
"input": "test-",
"expected": false
},
{
"description": "invalid - cannot end with -ondemand",
"input": "test-ondemand",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-synapseanalytics#/definitions/synapseWorkspaceName",
"modUri": "tmod:@turbot/azure-synapseanalytics"
}
}