The identity and technical contract details declared by the specification.
AvailableOperations
object
Available operations of the service
2 properties
GatewayInstance
object
Collection of instances belong to the Spring Cloud Gateway
2 properties
HttpScaleRule
object
Azure Spring Apps App Instance Http scaling rule.
2 properties
LogFileUrlResponse
object
Log file URL payload
1 property
1 required
ApplicationLiveViewResource
object
Application Live View resource
1 property
NetworkProfile
object
Service network profile payload
9 properties
ResourceSkuCapabilities
object
2 properties
StackProperties
object
KPack ClusterStack properties payload
2 properties
ConfigurationServiceGitProperty
object
Property of git environment.
1 property
GitPatternRepository
object
Git repository property payload for config server
11 properties
2 required
ScaleRule
object
Azure Spring Apps App Instance scaling rule.
5 properties
DiagnosticParameters
object
Diagnostic parameters of diagnostic operations
3 properties
DeploymentResourceCollection
object
Object that includes an array of App resources and a possible link for next set
2 properties
LogSpecification
object
Specifications of the Log for Azure Monitoring
3 properties
CustomPersistentDiskResource
object
Custom persistent disk resource payload.
2 properties
1 required
ContainerRegistryProperties
object
Container registry resource payload.
2 properties
1 required
SupportedStacksCollection
object
Object that includes an array of supported stacks resources and a possible link for next set
2 properties
BuildpackBindingProperties
object
Properties of a buildpack binding
3 properties
EurekaServerProperties
object
Eureka server properties payload
3 properties
DevToolPortalResourceCollection
object
Object that includes an array of Dev Tool Portal resources and a possible link for next set
2 properties
DevToolPortalFeatureSettings
object
Settings for Dev Tool Portal
2 properties
SkuCapacity
object
The SKU capacity
4 properties
1 required
ApiPortalCustomDomainResource
object
Custom domain of the API portal
1 property
GatewayCustomDomainResource
object
Custom domain of the Spring Cloud Gateway
1 property
BuildServiceCollection
object
Object that includes an array of Build service resources and a possible link for next set
2 properties
Secret
object
Secret definition.
2 properties
GatewayApiMetadataProperties
object
API metadata property for Spring Cloud Gateway
5 properties
ResourceUploadDefinition
object
Resource upload definition payload
2 properties
ConfigurationServiceGitPropertyValidateResult
object
Validation result for configuration service settings
2 properties
BuildServiceAgentPoolResourceCollection
object
Object that includes an array of build service agent pool resources and a possible link for next set
2 properties
BuildService
object
Build service resource payload
1 property
ConfigurationServiceGitPropertyRepository
array
Repositories of Application Configuration Service git property.
QueueScaleRule
object
Azure Spring Apps App Instance Azure Queue based scaling rule.
3 properties
ApplicationLiveViewProperties
object
Application Live View properties payload
2 properties
LoadedCertificateCollection
array
Collection of loaded certificate resources list and a possible link for next page.
SupportedStackResource
object
Supported stack resource payload
1 property
CustomizedAcceleratorValidateResult
object
Validation result for customized accelerator properties
2 properties
DeploymentInstance
object
Deployment instance payload
6 properties
GatewayResourceRequests
object
Resource request payload of Spring Cloud Gateway.
2 properties
AvailableRuntimeVersions
object
1 property
PersistentDisk
object
Persistent disk payload
3 properties
RemoteDebugging
object
Remote debugging config.
2 properties
BindingResourceCollection
object
Object that includes an array of Binding resources and a possible link for next set
2 properties
IngressConfig
object
Ingress configuration payload for Azure Spring Apps resource.
1 property
UserAssignedManagedIdentity
object
The details of the user-assigned managed identity assigned to an App.
2 properties
BuildServiceAgentPoolProperties
object
Build service agent pool properties
2 properties
Build
object
Build resource payload
1 property
GatewayResource
object
Spring Cloud Gateway resource
2 properties
ApmResourceCollection
object
Object that includes an array of APM resources and a possible link for next set
2 properties
MonitoringSettingResource
object
Monitoring Setting resource
1 property
TemporaryDisk
object
Temporary disk payload
2 properties
ApplicationAcceleratorResource
object
Application accelerator resource
2 properties
CertificateReferenceCollection
array
Collection of CertificateReferences
ApmSecretKeys
object
Keys of APM sensitive properties
1 property
OperationDisplay
object
Operation display payload
4 properties
ServiceSpecification
object
Service specification payload
2 properties
SupportedBuildpackResourceProperties
object
Supported buildpack resource properties
1 property
ConfigServerGitProperty
object
Property of git.
10 properties
1 required
CloudError
object
An error response from the service.
1 property
BuilderResource
object
KPack Builder resource
1 property
TrackedResource
object
The resource model definition for a ARM tracked top level resource.
2 properties
RequiredTraffic
object
Required inbound or outbound traffic for Azure Spring Apps resource.
5 properties
OperationProperties
object
Extra Operation properties
1 property
BuildResultProperties
object
Build result resource properties payload
6 properties
AppResource
object
App resource payload
3 properties
ContainerProbeSettings
object
Container liveness and readiness probe settings
1 property
AppVNetAddons
object
Additional App settings in vnet injection instance
2 properties
GatewayApiRoute
object
API route config of the Spring Cloud Gateway
9 properties
TriggeredBuildResult
object
The build result triggered by a build
6 properties
ApiPortalResourceCollection
object
Object that includes an array of API portal resources and a possible link for next set
2 properties
DeploymentResource
object
Deployment resource payload
2 properties
ConfigurationServiceResourceCollection
object
Object that includes an array of configuration service resources and a possible link for next set
2 properties
BuildCollection
object
Object that includes an array of Build resources and a possible link for next set
2 properties
RegenerateTestKeyRequestPayload
object
Regenerate test key request payload
1 property
1 required
CustomDomainProperties
object
Custom domain of app resource payload.
4 properties
BuildServiceProperties
object
Build service resource properties payload
4 properties
GatewayRouteConfigResourceCollection
object
Object that includes an array of Spring Cloud Gateway route config resources and a possible link for next set
2 properties
BuilderProperties
object
KPack Builder properties payload
3 properties
ApplicationAcceleratorResourceRequests
object
3 properties
DevToolPortalInstance
object
Collection of instances belong to the Dev Tool Portal.
2 properties
CertificateResource
object
Certificate resource payload.
1 property
GatewayOperatorResourceRequests
object
Properties of the Spring Cloud Gateway Operator.
3 properties
ApmReference
object
A reference to the APM
1 property
1 required
DevToolPortalProperties
object
Dev Tool Portal properties payload
6 properties
BuildpackBindingResourceCollection
object
Object that includes an array of BuildpackBinding resources and a possible link for next set
2 properties
CertificateReference
object
A reference to the certificate
1 property
1 required
ContainerRegistryResourceCollection
object
Collection compose of container registry resources list and a possible link for next page.
2 properties
UserAssignedManagedIdentities
object
User-assigned managed identities in key-value map. The key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{re…
ContainerRegistryCredentials
object
The credential for the container registry resource.
1 property
1 required
ServiceResource
object
Service resource
2 properties
SkuObject
object
Resource Sku object used for scaling out and scaling in.
1 property
ApplicationAcceleratorInstance
object
2 properties
applicationInsightsAgentVersions
object
Application Insights agent versions properties payload
1 property
ApiPortalResource
object
API portal resource
2 properties
EurekaServerResource
object
Eureka server resource
1 property
GatewayResourceCollection
object
Object that includes an array of gateway resources and a possible link for next set
2 properties
ConfigurationServiceSettings
object
The settings of Application Configuration Service.
1 property
BuildStageProperties
object
The build stage (init-container and container) resources in build pod.
4 properties
ApmReferenceCollection
array
Collection of ApmReferences
NameAvailability
object
Name availability result payload
3 properties
BuildpackBindingLaunchProperties
object
Buildpack Binding Launch Properties
2 properties
BindingResource
object
Binding resource payload
1 property
MarketplaceResource
object
Purchasing 3rd Party product for one Azure Spring Apps instance
3 properties
ApmProperties
object
Properties of an APM
4 properties
1 required
BuildProperties
object
Build resource properties payload
9 properties
ContainerRegistryResource
object
Container registry resource payload.
1 property
ApplicationLiveViewResourceRequests
object
The resource quantity for required CPU and Memory of Application Live View component
3 properties
ConfigServerResource
object
Config Server resource
1 property
ConfigurationServiceProperties
object
Application Configuration Service properties payload
5 properties
SupportedBuildpackResource
object
Supported buildpack resource payload
1 property
ConfigServerSettingsValidateResult
object
Validation result for config server settings
2 properties
GatewayCorsProperties
object
Cross-Origin Resource Sharing property
7 properties
NameAvailabilityParameters
object
Name availability parameters payload
2 properties
2 required
ConfigurationServiceResourceRequests
object
Resource request payload of Application Configuration Service
3 properties
BuildpackBindingResource
object
Buildpack Binding Resource object
1 property
MonitoringSettingProperties
object
Monitoring Setting properties payload
6 properties
EurekaServerResourceCollection
object
Object that includes an array of Eureka server resources and a possible link for next set
2 properties
BuildResult
object
Build result resource payload
1 property
SupportedServerVersion
object
Supported server version.
3 properties
StorageResourceCollection
object
Collection compose of storage resources list and a possible link for next page.
2 properties
Error
object
The error code compose of code and message.
2 properties
DevToolPortalFeatureDetail
object
Detail settings for Dev Tool Portal feature
2 properties
UserSourceInfo
object
Source information for a deployment
2 properties
1 required
ConfigServerSettings
object
The settings of config server.
1 property
CustomDomainResource
object
Custom domain resource payload.
1 property
GatewayCustomDomainResourceCollection
object
Object that includes an array of Spring Cloud Gateway custom domain resources and a possible link for next set
2 properties
Scale
object
Azure Spring Apps scaling configurations.
3 properties
ResourceRequests
object
Deployment resource request payload
2 properties
ConfigurationServiceResource
object
Application Configuration Service resource
1 property
ConfigServerSettingsErrorRecord
object
Error record of the config server settings
3 properties
ApiPortalProperties
object
API portal properties payload
10 properties
ScaleRuleAuth
object
Auth Secrets for Azure Spring Apps App Instance Scale Rule
2 properties
MetricSpecification
object
Specifications of the Metrics for Azure Monitoring
11 properties
ApiPortalInstance
object
Collection of instances belong to the API portal
2 properties
GatewayEnvSecrets
object
Sensitive properties for Spring Cloud Gateway
ActiveDeploymentCollection
object
Object that includes an array of Deployment resource name and set them as active.
1 property
BuilderResourceCollection
object
Object that includes an array of Builder resources and a possible link for next set
2 properties
CustomPersistentDiskProperties
object
Custom persistent disk resource payload.
5 properties
2 required
GatewayRouteConfigResource
object
Spring Cloud Gateway route config resource
1 property
ServiceRegistryResource
object
Service Registry resource
1 property
BuildpacksGroupProperties
object
Buildpack group properties of the Builder
2 properties
ConfigurationServiceInstance
object
Collection of instances belong to the Application Configuration Service
2 properties
AcceleratorGitRepository
object
7 properties
2 required
SsoProperties
object
Single sign-on related configuration
4 properties
ConfigurationServiceSettingsValidateResult
object
Validation result for configuration service settings
1 property
DeploymentResourceProperties
object
Deployment resource properties payload
6 properties
GatewayOperatorProperties
object
Properties of the Spring Cloud Gateway Operator.
2 properties
ClusterResourceProperties
object
Service properties payload
12 properties
ResourceSkuRestrictions
object
Restrictions where the SKU cannot be used
4 properties
StorageResource
object
Storage resource payload.
1 property
GatewayRouteConfigProperties
object
API route config of the Spring Cloud Gateway
8 properties
ApmResource
object
APM Resource object
1 property
PredefinedAcceleratorResource
object
Predefined accelerator resource
2 properties
SystemData
object
Metadata pertaining to creation and last modification of the resource.
6 properties
CustomizedAcceleratorResourceCollection
object
2 properties
StorageProperties
object
Storage resource payload.
1 property
1 required
ApiPortalResourceRequests
object
Resource requests of the API portal
2 properties
GloballyEnabledApms
object
Globally enabled APMs payload
1 property
CustomizedAcceleratorProperties
object
Customized accelerator properties payload
8 properties
1 required
CustomPersistentDiskCollection
array
Collection of persistent disk resources list and a possible link for next page.
MaintenanceScheduleConfiguration
object
Configuration for the planned maintenance
1 property
1 required
SupportedApmType
object
Supported APM type
1 property
ApplicationLiveViewInstance
object
Collection of instances belong to the Application Live View
2 properties
ApiPortalCustomDomainProperties
object
The properties of custom domain for API portal
1 property
LoadedCertificate
object
Loaded certificate payload
2 properties
1 required
AppResourceProperties
object
App resource properties payload
15 properties
RemoteDebuggingPayload
object
Remote debugging payload.
1 property
PredefinedAcceleratorProperties
object
Predefined accelerator properties payload
6 properties
GatewayCustomDomainProperties
object
The properties of custom domain for Spring Cloud Gateway
1 property
SupportedStackResourceProperties
object
Supported stack resource properties
2 properties
ServiceRegistryProperties
object
Service Registry properties payload
3 properties
CustomDomainValidateResult
object
Validation result for custom domain.
2 properties
ValidationMessages
object
Validate messages of the configuration service git repositories
2 properties
GitImplementation
string
Git libraries used to support various repository providers
BuildResultCollection
object
Object that includes an array of Build result resources and a possible link for next set
2 properties
ConfigurationServiceGitRepository
object
Git repository property payload for Application Configuration Service
13 properties
4 required
SupportedApmTypes
object
Supported APM types payload
2 properties
GatewayResponseCacheProperties
object
Spring Cloud Gateway response cache properties.
1 property
1 required
DevToolPortalResourceRequests
object
The resource quantity for required CPU and Memory of Dev Tool Portal
3 properties
OperationDetail
object
Operation detail payload
6 properties
ResourceSkuCollection
object
Object that includes an array of Azure Spring Apps SKU and a possible link for next set
2 properties
AppResourceCollection
object
Object that includes an array of App resources and a possible link for next set
2 properties
TcpScaleRule
object
Azure Spring Apps App Instance Tcp scaling rule.
2 properties
ConfigServerProperties
object
Config server git properties payload
4 properties
ApplicationAcceleratorResourceCollection
object
Object that includes an array of application accelerator resources and a possible link for next set
2 properties
AcceleratorAuthSetting
object
Auth setting payload.
1 property
1 required
ServiceRegistryInstance
object
Collection of instances belong to the Service Registry
2 properties
GatewayProperties
object
Spring Cloud Gateway properties payload
16 properties
DevToolPortalResource
object
Dev Tool Portal resource
1 property
ProbeAction
object
The action of the probe.
1 property
1 required
DeploymentList
object
A list of deployments resource ids.
1 property
Resource
object
The core properties of ARM resources.
4 properties
CustomDomainResourceCollection
object
Collection compose of a custom domain resources list and a possible link for next page.
2 properties
PredefinedAcceleratorResourceCollection
object
2 properties
ApplicationAcceleratorProperties
object
Application accelerator properties payload
2 properties
ApplicationAcceleratorComponent
object
3 properties
ProxyResource
object
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.
BuildServiceAgentPoolResource
object
The build service agent pool resource
1 property
BuildpackProperties
object
Buildpack properties payload
1 property
BuildResourceRequests
object
Resource request payload of Build Resource.
2 properties
BuildServiceAgentPoolSizeProperties
object
Build service agent pool size properties
3 properties
ApplicationLiveViewResourceCollection
object
Object that includes an array of Application Live View resources and a possible link for next set
2 properties
Sku
object
Sku of Azure Spring Apps
3 properties
CertificateProperties
object
Certificate resource payload.
9 properties
1 required
TestKeys
object
Test keys payload
5 properties
SupportedServerVersions
object
Supported server versions.
2 properties
ManagedIdentityProperties
object
Managed identity properties retrieved from ARM request headers.
4 properties
ServiceResourceList
object
Object that includes an array of Service resources and a possible link for next set
2 properties
SupportedRuntimeVersion
object
Supported deployment runtime version descriptor.
3 properties
ServiceRegistryResourceRequests
object
Resource request payload of Service Registry
3 properties
IngressSettings
object
App ingress settings payload.
6 properties
DeploymentSettings
object
Deployment settings payload
10 properties
ContainerRegistryValidateResult
object
Validation result for container registry properties
2 properties
DevToolPortalSsoProperties
object
Single sign-on related configuration
4 properties
GatewayRouteConfigOpenApiProperties
object
OpenAPI properties of Spring Cloud Gateway route config.
1 property
Probe
object
Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.
7 properties
1 required
ResourceSkuRestrictionInfo
object
Information about the restriction where the SKU cannot be used
2 properties
CloudErrorBody
object
An error response from the service.
4 properties
SupportedBuildpacksCollection
object
Object that includes an array of supported buildpacks resources and a possible link for next set
2 properties
CustomDomainValidatePayload
object
Custom domain validate payload.
1 property
1 required
BuildResultLog
object
Build result log resource properties payload
1 property
CertificateResourceCollection
object
Collection compose of certificate resources list and a possible link for next page.
2 properties
ServiceRegistryResourceCollection
object
Object that includes an array of Service Registry resources and a possible link for next set
2 properties
ServiceVNetAddons
object
Additional Service settings in vnet injection instance
2 properties
ApplicationLiveViewComponent
object
Application Live View properties payload
3 properties
DevToolPortalComponent
object
3 properties
ResourceSkuLocationInfo
object
Locations and availability zones where the SKU is available
3 properties
MetricDimension
object
Specifications of the Dimension of metrics
3 properties
ApiPortalCustomDomainResourceCollection
object
Object that includes an array of API portal custom domain resources and a possible link for next set
2 properties
CustomizedAcceleratorResource
object
Customized accelerator resource
2 properties
BindingResourceProperties
object
Binding resource properties payload
8 properties
CustomScaleRule
object
Azure Spring Apps App Instance Custom scaling rule.
3 properties
ResourceSkuZoneDetails
object
Details of capabilities available to a SKU in specific zones
2 properties
ResourceSku
object
Describes an available Azure Spring Apps SKU.
7 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.