Microsoft.AppPlatform Spring template reference

Template format

To create a Microsoft.AppPlatform/Spring resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.AppPlatform/Spring",
  "apiVersion": "2019-05-01-preview",
  "location": "string",
  "tags": {},
  "properties": {
    "configServerProperties": {
      "error": {
        "code": "string",
        "message": "string"
      },
      "configServer": {
        "gitProperty": {
          "repositories": [
            {
              "name": "string",
              "pattern": [
                "string"
              ],
              "uri": "string",
              "label": "string",
              "searchPaths": [
                "string"
              ],
              "username": "string",
              "password": "string",
              "hostKey": "string",
              "hostKeyAlgorithm": "string",
              "privateKey": "string",
              "strictHostKeyChecking": "boolean"
            }
          ],
          "uri": "string",
          "label": "string",
          "searchPaths": [
            "string"
          ],
          "username": "string",
          "password": "string",
          "hostKey": "string",
          "hostKeyAlgorithm": "string",
          "privateKey": "string",
          "strictHostKeyChecking": "boolean"
        }
      }
    },
    "trace": {
      "error": {
        "code": "string",
        "message": "string"
      },
      "enabled": "boolean",
      "appInsightInstrumentationKey": "string"
    }
  },
  "sku": {
    "name": "string",
    "tier": "string",
    "capacity": "integer"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.AppPlatform/Spring object

Name Type Required Value
name string Yes The name of the Service resource.
type enum Yes Microsoft.AppPlatform/Spring
apiVersion enum Yes 2019-05-01-preview
location string No The GEO location of the resource.
tags object No Tags of the service which is a list of key value pairs that describe the resource.
properties object Yes Properties of the Service resource - ClusterResourceProperties object
sku object No Sku of the Service resource - Sku object
resources array No certificates apps

ClusterResourceProperties object

Name Type Required Value
configServerProperties object No Config server git properties of the Service - ConfigServerProperties object
trace object No Trace properties of the Service - TraceProperties object

Sku object

Name Type Required Value
name string No Name of the Sku
tier string No Tier of the Sku
capacity integer No Current capacity of the target resource

ConfigServerProperties object

Name Type Required Value
error object No Error when apply config server settings. - Error object
configServer object No Settings of config server. - ConfigServerSettings object

TraceProperties object

Name Type Required Value
error object No Error when apply trace proxy changes. - Error object
enabled boolean No Indicates whether enable the tracing functionality
appInsightInstrumentationKey string No Target application insight instrumentation key

Error object

Name Type Required Value
code string No The code of error.
message string No The message of error.

ConfigServerSettings object

Name Type Required Value
gitProperty object No Property of git environment. - ConfigServerGitProperty object

ConfigServerGitProperty object

Name Type Required Value
repositories array No Repositories of git. - GitPatternRepository object
uri string Yes URI of the repository
label string No Label of the repository
searchPaths array No Searching path of the repository - string
username string No Username of git repository basic auth.
password string No Password of git repository basic auth.
hostKey string No Public sshKey of git repository.
hostKeyAlgorithm string No SshKey algorithm of git repository.
privateKey string No Private sshKey algorithm of git repository.
strictHostKeyChecking boolean No Strict host key checking or not.

GitPatternRepository object

Name Type Required Value
name string Yes Name of the repository
pattern array No Collection of pattern of the repository - string
uri string Yes URI of the repository
label string No Label of the repository
searchPaths array No Searching path of the repository - string
username string No Username of git repository basic auth.
password string No Password of git repository basic auth.
hostKey string No Public sshKey of git repository.
hostKeyAlgorithm string No SshKey algorithm of git repository.
privateKey string No Private sshKey algorithm of git repository.
strictHostKeyChecking boolean No Strict host key checking or not.