Share via


Apps - Create Or Update

Create a new App or update an exiting App.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}?api-version=2023-12-01

URI Parameters

Name In Required Type Description
appName
path True

string

The name of the App resource.

resourceGroupName
path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName
path True

string

pattern: ^[a-z][a-z0-9-]*[a-z0-9]$

The name of the Service resource.

subscriptionId
path True

string

Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
identity

ManagedIdentityProperties

The Managed Identity type of the app resource

location

string

The GEO location of the application, always the same with its parent resource

properties

AppResourceProperties

Properties of the App resource

Responses

Name Type Description
200 OK

AppResource

Success. The response describes the updated App.

201 Created

AppResource

Created. The response describes the new App and contains an Azure-AsyncOperation header to query the operation result.

202 Accepted

AppResource

Accepted. The response indicates the exiting App is now updating and contains a Location header to query the operation result.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Apps_CreateOrUpdate
Apps_CreateOrUpdate_VNetInjection

Apps_CreateOrUpdate

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp?api-version=2023-12-01

{
  "properties": {
    "public": true,
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "mountPath": "/mypersistentdisk"
    },
    "loadedCertificates": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1",
        "loadTrustStore": false
      },
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2",
        "loadTrustStore": true
      }
    ],
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "enableSubPath": true,
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": null,
    "tenantId": null,
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": null,
        "principalId": null
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": null,
        "principalId": null
      }
    }
  },
  "location": "eastus"
}

Sample response

{
  "properties": {
    "public": true,
    "url": "myapp.myservice.azuremicroservices.io",
    "provisioningState": "Succeeded",
    "fqdn": "myapp.mydomain.com",
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "usedInGB": 1,
      "mountPath": "/mypersistentdisk"
    },
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "enableSubPath": true,
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apps",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "principalid",
    "tenantId": "tenantid",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "clientId1",
        "principalId": "principalId1"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": "clientId2",
        "principalId": "principalId2"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
  "name": "myapp"
}
{
  "properties": {
    "public": true,
    "url": "myapp.myservice.azuremicroservices.io",
    "provisioningState": "Creating",
    "fqdn": "myapp.mydomain.com",
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "usedInGB": 1,
      "mountPath": "/mypersistentdisk"
    },
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "enableSubPath": true,
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apps",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "principalid",
    "tenantId": "tenantid",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "clientId1",
        "principalId": "principalId1"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": "clientId2",
        "principalId": "principalId2"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
  "name": "myapp"
}
{
  "properties": {
    "public": true,
    "url": "myapp.myservice.azuremicroservices.io",
    "provisioningState": "Updating",
    "fqdn": "myapp.mydomain.com",
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "usedInGB": 1,
      "mountPath": "/mypersistentdisk"
    },
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "enableSubPath": true,
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apps",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "principalid",
    "tenantId": "tenantid",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "clientId1",
        "principalId": "principalId1"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": "clientId2",
        "principalId": "principalId2"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
  "name": "myapp"
}

Apps_CreateOrUpdate_VNetInjection

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp?api-version=2023-12-01

{
  "properties": {
    "public": true,
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "vnetAddons": {
      "publicEndpoint": true
    },
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "mountPath": "/mypersistentdisk"
    },
    "loadedCertificates": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1",
        "loadTrustStore": false
      },
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2",
        "loadTrustStore": true
      }
    ],
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": null,
    "tenantId": null,
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": null,
        "principalId": null
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": null,
        "principalId": null
      }
    }
  },
  "location": "eastus"
}

Sample response

{
  "properties": {
    "public": true,
    "url": "myapp.myservice.private.azuremicroservices.io",
    "provisioningState": "Succeeded",
    "fqdn": "myapp.private.mydomain.com",
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "vnetAddons": {
      "publicEndpoint": true,
      "publicEndpointUrl": "myapp.myservice.azuremicroservices.io"
    },
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "usedInGB": 1,
      "mountPath": "/mypersistentdisk"
    },
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apps",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "principalid",
    "tenantId": "tenantid",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "clientId1",
        "principalId": "principalId1"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": "clientId2",
        "principalId": "principalId2"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
  "name": "myapp"
}
{
  "properties": {
    "public": true,
    "url": "myapp.myservice.private.azuremicroservices.io",
    "provisioningState": "Creating",
    "fqdn": "myapp.private.mydomain.com",
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "vnetAddons": {
      "publicEndpoint": true,
      "publicEndpointUrl": "myapp.myservice.azuremicroservices.io"
    },
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "usedInGB": 1,
      "mountPath": "/mypersistentdisk"
    },
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apps",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "principalid",
    "tenantId": "tenantid",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "clientId1",
        "principalId": "principalId1"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": "clientId2",
        "principalId": "principalId2"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
  "name": "myapp"
}
{
  "properties": {
    "public": true,
    "url": "myapp.myservice.private.azuremicroservices.io",
    "provisioningState": "Updating",
    "fqdn": "myapp.private.mydomain.com",
    "httpsOnly": false,
    "enableEndToEndTLS": false,
    "vnetAddons": {
      "publicEndpoint": true,
      "publicEndpointUrl": "myapp.myservice.azuremicroservices.io"
    },
    "temporaryDisk": {
      "sizeInGB": 2,
      "mountPath": "/mytemporarydisk"
    },
    "addonConfigs": {
      "ApplicationConfigurationService": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs"
      },
      "ServiceRegistry": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry"
      }
    },
    "persistentDisk": {
      "sizeInGB": 2,
      "usedInGB": 1,
      "mountPath": "/mypersistentdisk"
    },
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "type": "AzureFileVolume",
          "mountPath": "/mypath1/mypath2",
          "mountOptions": [
            "uid=0",
            "gid=0",
            "dir_mode=0777",
            "file_mode=0777"
          ],
          "shareName": "myFileShare"
        },
        "storageId": "myASCStorageID"
      }
    ]
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apps",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "principalid",
    "tenantId": "tenantid",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "clientId1",
        "principalId": "principalId1"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": "clientId2",
        "principalId": "principalId2"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
  "name": "myapp"
}

Definitions

Name Description
AppResource

App resource payload

AppResourceProperties

App resource properties payload

AppResourceProvisioningState

Provisioning state of the App

AppVNetAddons

Additional App settings in vnet injection instance

AzureFileVolume

The properties of the Azure File volume. Azure File shares are mounted as volumes.

BackendProtocol

How ingress should communicate with this app backend service.

ClientAuth

Client-Certification Authentication.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

createdByType

The type of identity that created the resource.

CustomPersistentDiskResource

Custom persistent disk resource payload.

IngressSettings

App ingress settings payload.

lastModifiedByType

The type of identity that last modified the resource.

LoadedCertificate

Loaded certificate payload

ManagedIdentityProperties

Managed identity properties retrieved from ARM request headers.

ManagedIdentityType

Type of the managed identity

PersistentDisk

Persistent disk payload

SessionAffinity

Type of the affinity, set this to Cookie to enable session affinity.

SystemData

Metadata pertaining to creation and last modification of the resource.

TemporaryDisk

Temporary disk payload

UserAssignedManagedIdentity

The details of the user-assigned managed identity assigned to an App.

AppResource

App resource payload

Name Type Description
id

string

Fully qualified resource Id for the resource.

identity

ManagedIdentityProperties

The Managed Identity type of the app resource

location

string

The GEO location of the application, always the same with its parent resource

name

string

The name of the resource.

properties

AppResourceProperties

Properties of the App resource

systemData

SystemData

Metadata pertaining to creation and last modification of the resource.

type

string

The type of the resource.

AppResourceProperties

App resource properties payload

Name Type Default value Description
addonConfigs

object

Collection of addons

customPersistentDisks

CustomPersistentDiskResource[]

List of custom persistent disks

enableEndToEndTLS

boolean

False

Indicate if end to end TLS is enabled.

fqdn

string

Fully qualified dns Name.

httpsOnly

boolean

False

Indicate if only https is allowed.

ingressSettings

IngressSettings

App ingress settings payload.

loadedCertificates

LoadedCertificate[]

Collection of loaded certificates

persistentDisk

PersistentDisk

Persistent disk settings

provisioningState

AppResourceProvisioningState

Provisioning state of the App

public

boolean

Indicates whether the App exposes public endpoint

temporaryDisk

TemporaryDisk

Temporary disk settings

url

string

URL of the App

vnetAddons

AppVNetAddons

Additional App settings in vnet injection instance

AppResourceProvisioningState

Provisioning state of the App

Value Description
Succeeded
Failed
Creating
Updating
Deleting

AppVNetAddons

Additional App settings in vnet injection instance

Name Type Default value Description
publicEndpoint

boolean

False

Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet.

publicEndpointUrl

string

URL of the App in vnet injection instance which could be accessed from internet

AzureFileVolume

The properties of the Azure File volume. Azure File shares are mounted as volumes.

Name Type Default value Description
enableSubPath

boolean

False

If set to true, it will create and mount a dedicated directory for every individual app instance.

mountOptions

string[]

These are the mount options for a persistent disk.

mountPath

string

The mount path of the persistent disk.

readOnly

boolean

Indicates whether the persistent disk is a readOnly one.

shareName

string

The share name of the Azure File share.

type string:

AzureFileVolume

The type of the underlying resource to mount as a persistent disk.

BackendProtocol

How ingress should communicate with this app backend service.

Value Description
GRPC
Default

ClientAuth

Client-Certification Authentication.

Name Type Description
certificates

string[]

Collection of certificate resource id.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

An error response from the service.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

CustomPersistentDiskResource

Custom persistent disk resource payload.

Name Type Description
customPersistentDiskProperties CustomPersistentDiskProperties:

AzureFileVolume

Properties of the custom persistent disk resource payload.

storageId

string

The resource id of Azure Spring Apps Storage resource.

IngressSettings

App ingress settings payload.

Name Type Description
backendProtocol

BackendProtocol

How ingress should communicate with this app backend service.

clientAuth

ClientAuth

Client-Certification Authentication.

readTimeoutInSeconds

integer (int32)

Ingress read time out in seconds.

sendTimeoutInSeconds

integer (int32)

Ingress send time out in seconds.

sessionAffinity

SessionAffinity

Type of the affinity, set this to Cookie to enable session affinity.

sessionCookieMaxAge

integer (int32)

Time in seconds until the cookie expires.

lastModifiedByType

The type of identity that last modified the resource.

Value Description
User
Application
ManagedIdentity
Key

LoadedCertificate

Loaded certificate payload

Name Type Default value Description
loadTrustStore

boolean

False

Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.

resourceId

string

Resource Id of loaded certificate

ManagedIdentityProperties

Managed identity properties retrieved from ARM request headers.

Name Type Description
principalId

string

Principal Id of system-assigned managed identity.

tenantId

string

Tenant Id of system-assigned managed identity.

type

ManagedIdentityType

Type of the managed identity

userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Properties of user-assigned managed identities

ManagedIdentityType

Type of the managed identity

Value Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

PersistentDisk

Persistent disk payload

Name Type Description
mountPath

string

Mount path of the persistent disk

sizeInGB

integer (int32)

minimum: 0
maximum: 50

Size of the persistent disk in GB

usedInGB

integer (int32)

minimum: 0
maximum: 50

Size of the used persistent disk in GB

SessionAffinity

Type of the affinity, set this to Cookie to enable session affinity.

Value Description
Cookie
None

SystemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource modification (UTC).

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

lastModifiedByType

The type of identity that last modified the resource.

TemporaryDisk

Temporary disk payload

Name Type Default value Description
mountPath

string

/tmp

Mount path of the temporary disk

sizeInGB

integer (int32)

minimum: 0
maximum: 5

Size of the temporary disk in GB

UserAssignedManagedIdentity

The details of the user-assigned managed identity assigned to an App.

Name Type Description
clientId

string

Client Id of user-assigned managed identity.

principalId

string

Principal Id of user-assigned managed identity.