sqlManagedInstances.json

{
  "swagger": "2.0",
  "info": {
    "version": "2022-06-15-preview",
    "title": "AzureArcDataManagementClient",
    "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources."
  },
  "paths": {},
  "definitions": {
    "SqlManagedInstance": {
      "description": "A SqlManagedInstance.",
      "type": "object",
      "allOf": [
        {
          "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/SqlManagedInstanceProperties",
          "description": "null",
          "x-ms-client-flatten": false
        },
        "extendedLocation": {
          "$ref": "./common.json#/definitions/ExtendedLocation",
          "description": "The extendedLocation of the resource."
        },
        "sku": {
          "$ref": "#/definitions/SqlManagedInstanceSku",
          "description": "Resource sku."
        }
      },
      "required": [
        "properties"
      ]
    },
    "SqlManagedInstanceSku": {
      "description": "The resource model definition representing SKU for Azure Managed Instance - Azure Arc",
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "enum": [
            "vCore"
          ],
          "description": "The name of the SKU.",
          "x-ms-enum": {
            "name": "SqlManagedInstanceSkuName",
            "modelAsString": false
          }
        },
        "tier": {
          "type": "string",
          "enum": [
            "GeneralPurpose",
            "BusinessCritical"
          ],
          "x-ms-enum": {
            "name": "SqlManagedInstanceSkuTier",
            "modelAsString": false
          },
          "default": "GeneralPurpose",
          "description": "The pricing tier for the instance."
        },
        "dev": {
          "type": "boolean",
          "default": true,
          "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. "
        },
        "size": {
          "type": "string",
          "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. "
        },
        "family": {
          "type": "string",
          "description": "The SKU family"
        },
        "capacity": {
          "type": "integer",
          "format": "int32",
          "description": "The SKU capacity"
        }
      },
      "required": [
        "name"
      ]
    },
    "SqlManagedInstanceProperties": {
      "description": "Properties of sqlManagedInstance.",
      "type": "object",
      "properties": {
        "dataControllerId": {
          "type": "string",
          "description": "null"
        },
        "admin": {
          "type": "string",
          "description": "The instance admin user"
        },
        "startTime": {
          "type": "string",
          "description": "The instance start time"
        },
        "endTime": {
          "type": "string",
          "description": "The instance end time"
        },
        "k8sRaw": {
          "$ref": "#/definitions/SqlManagedInstanceK8sRaw",
          "description": "The raw kubernetes information"
        },
        "basicLoginInformation": {
          "$ref": "./common.json#/definitions/BasicLoginInformation",
          "description": "Username and password for basic authentication."
        },
        "lastUploadedDate": {
          "type": "string",
          "format": "date-time",
          "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time"
        },
        "provisioningState": {
          "type": "string",
          "readOnly": true,
          "description": "The provisioning state of the Arc-enabled SQL Managed Instance resource."
        },
        "activeDirectoryInformation": {
          "description": "Active Directory information related to this SQL Managed Instance.",
          "$ref": "#/definitions/ActiveDirectoryInformation"
        },
        "licenseType": {
          "type": "string",
          "enum": [
            "BasePrice",
            "LicenseIncluded",
            "DisasterRecovery"
          ],
          "x-ms-enum": {
            "name": "arcSqlManagedInstanceLicenseType",
            "modelAsString": true
          },
          "default": "BasePrice",
          "description": "The license type to apply for this managed instance."
        },
        "clusterId": {
          "type": "string",
          "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to."
        },
        "extensionId": {
          "type": "string",
          "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to."
        }
      }
    },
    "SqlManagedInstanceUpdate": {
      "description": "An update to a SQL Managed Instance.",
      "type": "object",
      "properties": {
        "tags": {
          "description": "Resource tags.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "SqlManagedInstanceK8sRaw": {
      "type": "object",
      "description": "The raw kubernetes information.",
      "properties": {
        "spec": {
          "$ref": "#/definitions/SqlManagedInstanceK8sSpec"
        }
      },
      "additionalProperties": {}
    },
    "SqlManagedInstanceK8sSpec": {
      "type": "object",
      "description": "The kubernetes spec information.",
      "properties": {
        "scheduling": {
          "$ref": "#/definitions/K8sScheduling"
        },
        "replicas": {
          "type": "integer",
          "format": "int32",
          "description": "This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'."
        }
      },
      "additionalProperties": {}
    },
    "K8sScheduling": {
      "type": "object",
      "description": "The kubernetes scheduling information.",
      "properties": {
        "default": {
          "$ref": "#/definitions/K8sSchedulingOptions"
        }
      },
      "additionalProperties": {}
    },
    "K8sSchedulingOptions": {
      "type": "object",
      "description": "The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service",
      "properties": {
        "resources": {
          "$ref": "#/definitions/K8sResourceRequirements"
        }
      },
      "additionalProperties": {}
    },
    "K8sResourceRequirements": {
      "type": "object",
      "description": "The kubernetes resource limits and requests used to restrict or reserve resource usage.",
      "properties": {
        "requests": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'."
        },
        "limits": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'."
        }
      },
      "additionalProperties": {}
    },
    "KeytabInformation": {
      "type": "object",
      "description": "Keytab used for authenticate with Active Directory.",
      "properties": {
        "keytab": {
          "type": "string",
          "description": "A base64-encoded keytab.",
          "x-ms-mutability": [
            "create",
            "update"
          ],
          "x-ms-secret": true
        }
      }
    },
    "ActiveDirectoryInformation": {
      "type": "object",
      "description": "Active Directory information that related to the resource.",
      "properties": {
        "keytabInformation": {
          "description": "Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used.",
          "$ref": "#/definitions/KeytabInformation"
        }
      }
    },
    "SqlManagedInstanceListResult": {
      "description": "A list of SqlManagedInstance.",
      "type": "object",
      "properties": {
        "value": {
          "description": "Array of results.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/SqlManagedInstance"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to retrieve next page of results.",
          "type": "string",
          "readOnly": true
        }
      }
    }
  },
  "parameters": {
    "apiVersion": {
      "name": "api-version",
      "in": "query",
      "required": true,
      "type": "string",
      "description": "The API version to use for the request",
      "x-ms-parameter-location": "client"
    }
  },
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "description": "Azure Active Directory OAuth2 Flow",
      "flow": "implicit",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  }
}