Definitions for @turbot/azure-servicebus

namespace

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"$ref": "#/definitions/serviceBusNamespaceName"
},
"type": {
"type": "string"
},
"tags": {
"$ref": "azure#/definitions/tags"
},
"location": {
"type": "string"
},
"sku": {
"$ref": "#/definitions/serviceBusNamespaceSku"
},
"provisioningState": {
"type": "string"
},
"metricId": {
"type": "string"
},
"createdAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"updatedAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"serviceBusEndpoint": {
"type": "string"
},
"disableLocalAuth": {
"type": "boolean"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/serviceBusNamespaceAka"
}
},
"title": {
"$ref": "#/definitions/serviceBusNamespaceName"
},
"tags": {
"$ref": "azure#/definitions/tags"
},
"custom": {
"type": "object",
"properties": {
"azure": {
"$ref": "azure#/definitions/azureMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"name": "test01",
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01",
"type": "Microsoft.ServiceBus/Namespaces",
"location": "South Central US",
"sku": {
"name": "Standard",
"tier": "Standard"
},
"tags": {
"hello": "world"
},
"turbot": {
"akas": [
"azure:///subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01"
],
"title": "test01",
"tags": {
"hello": "world"
},
"custom": {
"azure": {
"subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4",
"resourceGroupName": "dev"
}
}
}
}
},
{
"description": "Invalid - Namespace name missing",
"input": {
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01",
"type": "Microsoft.ServiceBus/Namespaces",
"location": "South Central US",
"sku": {
"name": "Standard",
"tier": "Standard"
},
"tags": {
"hello": "world"
},
"turbot": {
"akas": [
"azure:///subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01"
],
"title": null,
"tags": {
"hello": "world"
},
"custom": {
"azure": {
"subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4",
"resourceGroupName": "dev"
}
}
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/namespace",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

queue

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"$ref": "#/definitions/servicebusQueueName"
},
"type": {
"type": "string"
},
"lockDuration": {
"type": "string"
},
"maxSizeInMegabytes": {
"type": "integer"
},
"maxMessageSizeInKilobytes": {
"type": "integer"
},
"requiresDuplicateDetection": {
"type": "boolean"
},
"requiresSession": {
"type": "boolean"
},
"defaultMessageTimeToLive": {
"type": "string"
},
"duplicateDetectionHistoryTimeWindow": {
"type": "string"
},
"deadLetteringOnMessageExpiration": {
"type": "boolean"
},
"forwardDeadLetteredMessagesTo": {
"type": "string"
},
"forwardTo": {
"type": "string"
},
"maxDeliveryCount": {
"type": "integer"
},
"sizeInBytes": {
"type": "integer"
},
"messageCount": {
"type": "integer"
},
"status": {
"$ref": "#/definitions/servicebusQueueStatus"
},
"autoDeleteOnIdle": {
"type": "string"
},
"enableBatchedOperations": {
"type": "boolean"
},
"enablePartitioning": {
"type": "boolean"
},
"enableExpress": {
"type": "boolean"
},
"createdAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"updatedAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"accessedAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/servicebusQueueAka"
}
},
"title": {
"$ref": "#/definitions/servicebusQueueName"
},
"custom": {
"type": "object",
"properties": {
"namespaceName": {
"$ref": "#/definitions/serviceBusNamespaceName"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"name": "queue-nd",
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/queues/queue-nd",
"type": "Microsoft.ServiceBus/Namespaces/Queues",
"turbot": {
"akas": [
"azure:///subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/queues/queue-nd"
],
"title": "queue-nd",
"custom": {
"azure": {
"subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4",
"resourceGroupName": "dev"
},
"namespaceName": "testNiharika"
}
}
}
},
{
"description": "Invalid - Queue name missing",
"input": {
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/queues/queue-nd",
"type": "Microsoft.ServiceBus/Namespaces/Queues",
"turbot": {
"akas": [
"azure:///subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/queues/queue-nd"
],
"title": null,
"custom": {
"azure": {
"subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4",
"resourceGroupName": "dev"
},
"namespaceName": "testNiharika"
}
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/queue",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

serviceBus

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Service Bus"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/serviceBusAka"
}
},
"title": {
"const": "Service Bus"
},
"custom": {
"type": "object",
"properties": {
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"name": "serviceBus",
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.ServiceBus/services/serviceBus"
],
"title": "serviceBus",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
}
},
{
"description": "Invalid - Service name missing",
"input": {
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.ServiceBus/services/serviceBus"
],
"title": "serviceBus",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
},
"expected": false
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/serviceBus",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

serviceBusAka

{
"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.ServiceBus/services/serviceBus",
"tests": [
{
"descritpion": "base case",
"input": "azure:///subscriptions/ec7a5a3a-4225-474f-9dbe-bf477c8ea51b/providers/Microsoft.ServiceBus/services/serviceBus"
},
{
"description": "invalid - account ID too long",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7jfhsjkds/search/services/serviceBus",
"expected": false
},
{
"description": "invalid - name of the service",
"input": "azure:///subscriptions/ec7a5a3a-4225-474f-9dbe-bf477c8ea51b/providers/Microsoft.Sql/services/serviceBus",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/serviceBusAka",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

serviceBusNamespaceAka

{
"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_.-]{0,89}[A-Za-z0-9_-]/providers/Microsoft.ServiceBus/namespaces/[a-z][a-zA-Z0-9-]{4,48}[a-zA-Z0-9]$",
"tests": [
{
"descritpion": "base case",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01"
},
{
"description": "invalid - Wrong Account id",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2cqiho3uedwvcahcgsuaiyusadiguyv77f7/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/serviceBusNamespaceAka",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

serviceBusNamespaceName

{
"type": "string",
"pattern": "^([a-z][a-zA-Z0-9-]{4,48}[a-zA-Z0-9])$",
"tests": [
{
"input": "test001"
},
{
"description": "invalid - must contain atleast 6 characters",
"input": "es",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/serviceBusNamespaceName",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

serviceBusNamespaceSku

{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Premium",
"Basic",
"Standard"
],
"tests": []
},
"tier": {
"type": "string",
"enum": [
"Basic",
"Premium",
"Standard"
],
"tests": []
}
},
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/serviceBusNamespaceSku",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

servicebusQueueAka

{
"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_.-]{0,89}[A-Za-z0-9_-]/providers/Microsoft.ServiceBus/namespaces/[a-z][a-zA-Z0-9-]{4,48}[a-zA-Z0-9]/queues/[A-Za-z0-9][A-Za-z0-9-~.]{0,258}[A-Za-z0-9]$",
"tests": [
{
"descritpion": "base case",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01/queues/queue-nd"
},
{
"description": "invalid - Wrong Account id",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2cqiho3uedwvcahcgsuaiyusadiguyv77f7/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01/queues/queue-nd",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/servicebusQueueAka",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

servicebusQueueName

{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9-~.]{0,258}[A-Za-z0-9]$",
"tests": [
{
"input": "test001"
},
{
"description": "invalid - too short",
"input": "",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/servicebusQueueName",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

servicebusQueueStatus

{
"type": "string",
"enum": [
"Active",
"Creating",
"Deleting",
"Disabled",
"ReceiveDisabled",
"Renaming",
"Restoring",
"SendDisabled",
"Unknown"
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/servicebusQueueStatus",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

servicebusTopicAka

{
"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_.-]{0,89}[A-Za-z0-9_-]/providers/Microsoft.ServiceBus/namespaces/[a-z][a-zA-Z0-9-]{4,48}[a-zA-Z0-9]/topics/[A-Za-z0-9][A-Za-z0-9-~.]{0,258}[A-Za-z0-9]$",
"tests": [
{
"descritpion": "base case",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01/topics/topic-nd"
},
{
"description": "invalid - Wrong Account id",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2cqiho3uedwvcahcgsuaiyusadiguyv77f7/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/test01/topics/topic-nd",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/servicebusTopicAka",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

servicebusTopicName

{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9-~.]{0,258}[A-Za-z0-9]$",
"tests": [
{
"input": "test001"
},
{
"description": "invalid - too short",
"input": "",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/servicebusTopicName",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

servicebusTopicStatus

{
"type": "string",
"enum": [
"Active",
"Creating",
"Deleting",
"Disabled",
"ReceiveDisabled",
"Renaming",
"Restoring",
"SendDisabled",
"Unknown"
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/servicebusTopicStatus",
"modUri": "tmod:@turbot/azure-servicebus"
}
}

topic

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"$ref": "#/definitions/servicebusTopicName"
},
"type": {
"type": "string"
},
"defaultMessageTimeToLive": {
"type": "string"
},
"maxSizeInMegabytes": {
"type": "integer"
},
"maxMessageSizeInKilobytes": {
"type": "integer"
},
"requiresDuplicateDetection": {
"type": "boolean"
},
"duplicateDetectionHistoryTimeWindow": {
"type": "string"
},
"enableBatchedOperations": {
"type": "boolean"
},
"sizeInBytes": {
"type": "integer"
},
"status": {
"$ref": "#/definitions/servicebusTopicStatus"
},
"supportOrdering": {
"type": "boolean"
},
"autoDeleteOnIdle": {
"type": "string"
},
"enablePartitioning": {
"type": "boolean"
},
"enableExpress": {
"type": "boolean"
},
"createdAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"updatedAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"accessedAt": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"subscriptionCount": {
"type": "integer"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/servicebusTopicAka"
}
},
"title": {
"$ref": "#/definitions/servicebusTopicName"
},
"custom": {
"type": "object",
"properties": {
"namespaceName": {
"$ref": "#/definitions/serviceBusNamespaceName"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"name": "topic-nd",
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/topics/topic-nd",
"type": "Microsoft.ServiceBus/Namespaces/Topics",
"turbot": {
"akas": [
"azure:///subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/topics/topic-nd"
],
"title": "topic-nd",
"custom": {
"azure": {
"subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4",
"resourceGroupName": "dev"
},
"namespaceName": "testNiharika"
}
}
}
},
{
"description": "Invalid - Topic name missing",
"input": {
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/topics/topic-nd",
"type": "Microsoft.ServiceBus/Namespaces/Topics",
"turbot": {
"akas": [
"azure:///subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/dev/providers/Microsoft.ServiceBus/namespaces/testNiharika/topics/topic-nd"
],
"title": null,
"custom": {
"azure": {
"subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4",
"resourceGroupName": "dev"
},
"namespaceName": "testNiharika"
}
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-servicebus#/definitions/topic",
"modUri": "tmod:@turbot/azure-servicebus"
}
}