Definitions for @turbot/azure-apimanagement

apiManagement

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "API Management"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/apiManagementAka"
}
},
"title": {
"const": "API Management"
},
"custom": {
"type": "object",
"properties": {
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
},
"tests": [
{
"description": "base",
"input": {
"namespace": "API Management",
"turbot": {
"akas": [
"azure:///subscriptions/ec7a5a3a-4225-474f-9dbe-bf477c8ea51b/providers/Microsoft.ApiManagement/services/apiManagement"
],
"title": "Azure API Management Service",
"custom": {
"azure": {
"subscriptionId": "ec7a5a3a-4225-474f-9dbe-bf477c8ea51b"
}
}
}
}
},
{
"description": "invalid - wrong title",
"input": {
"namespace": "API Management",
"turbot": {
"akas": [
"azure:///subscriptions/ec7a5a3a-4225-474f-9dbe-bf477c8ea51b/providers/Microsoft.ApiManagement/services/apiManagement"
],
"title": "Azure API Management",
"custom": {
"azure": {
"subscriptionId": "ec7a5a3a-4225-474f-9dbe-bf477c8ea51b"
}
}
}
}
},
{
"description": "invalid - missing namespace",
"input": {
"turbot": {
"akas": [
"azure:///subscriptions/ec7a5a3a-4225-474f-9dbe-bf477c8ea51b/providers/Microsoft.ApiManagement/services/apiManagement"
],
"title": "Azure API Management Service",
"custom": {
"azure": {
"subscriptionId": "ec7a5a3a-4225-474f-9dbe-bf477c8ea51b"
}
}
}
}
}
]
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-apimanagement#/definitions/apiManagement",
"modUri": "tmod:@turbot/azure-apimanagement"
}
}

apiManagementAka

{
"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.ApiManagement/services/apiManagement",
"tests": [
{
"descritpion": "base case",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/providers/Microsoft.ApiManagement/services/apiManagement"
},
{
"description": "invalid - account ID too long",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7jfhsjkds/search",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-apimanagement#/definitions/apiManagementAka",
"modUri": "tmod:@turbot/azure-apimanagement"
}
}

apiManagementService

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "object"
},
"etag": {
"type": "string"
},
"type": {
"type": "string"
},
"scmUrl": {
"type": "string"
},
"identity": {
"type": "string"
},
"location": {
"type": "string"
},
"portalUrl": {
"type": "string"
},
"gatewayUrl": {
"type": "string"
},
"certificates": {
"type": "string"
},
"createdAtUtc": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"publicIPAddresses": {
"type": "string"
},
"privateIPAddresses": {
"type": "string"
},
"publisherName": {
"type": "string"
},
"publisherEmail": {
"type": "string"
},
"customProperties": {
"type": "object"
},
"managementApiUrl": {
"type": "string"
},
"gatewayRegionalUrl": {
"type": "string"
},
"virtualNetworkType": {
"type": "string"
},
"additionalLocations": {
"type": "string"
},
"hostnameConfigurations": {
"type": "array",
"items": {
"type": "object"
}
},
"notificationSenderEmail": {
"type": "string"
},
"targetProvisioningState": {
"type": "string"
},
"name": {
"$ref": "#/definitions/serviceName"
},
"provisioningState": {
"$ref": "#/definitions/provisioningState"
},
"tags": {
"$ref": "azure#/definitions/tags"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/apiManagementServiceAka"
}
},
"title": {
"$ref": "#/definitions/serviceName"
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"name": "test01",
"turbot": {
"akas": [
"azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/resourceGroups/dev/providers/Microsoft.ApiManagement/service/test01"
],
"title": "test01",
"custom": {
"azure": {
"subscriptionId": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7",
"resourceGroupName": "dev"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-apimanagement#/definitions/apiManagementService",
"modUri": "tmod:@turbot/azure-apimanagement"
}
}

apiManagementServiceAka

{
"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-_().]*[A-Za-z0-9-_()]/providers/Microsoft.ApiManagement/service/[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"tests": [
{
"descritpion": "base case",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/resourceGroups/dev/providers/Microsoft.ApiManagement/service/test01"
},
{
"description": "invalid - Wrong Account id",
"input": "azure:///subscriptions/9e3548cf-17e2-4751-b87e-b72bdd2cqiho3uedwvcahcgsuaiyusadiguyv77f7/resourceGroups/dev/providers/Microsoft.ApiManagement/service/test01",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-apimanagement#/definitions/apiManagementServiceAka",
"modUri": "tmod:@turbot/azure-apimanagement"
}
}

provisioningState

{
"type": "string",
"enum": [
"Activating",
"Succeeded"
],
"tests": [
{
"input": "Activating"
},
{
"input": "Succeeded"
},
{
"description": "invalid - Activatingsss",
"input": "Activatingsss",
"expected": false
},
{
"description": "invalid - Succeededsscasa",
"input": "Succeededsscasa",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-apimanagement#/definitions/provisioningState",
"modUri": "tmod:@turbot/azure-apimanagement"
}
}

serviceName

{
"type": "string",
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"tests": [
{
"descritpion": "base case",
"input": "test-04"
},
{
"description": "invalid - cannot start with number",
"input": "9test",
"expected": false
},
{
"description": "invalid - Hyphen can not be at last position",
"input": "test-",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-apimanagement#/definitions/serviceName",
"modUri": "tmod:@turbot/azure-apimanagement"
}
}