Microsoft.AppPlatform Spring/apiPortals 2023-12-01

Remarks

Note: Azure Spring Apps API Portals (Microsoft.AppPlatform/Spring/apiPortals) is now deprecated and will be retired on 2028-05-31. See https://aka.ms/asaretirement for more information.

Bicep resource definition

The Spring/apiPortals resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Usage Examples

Bicep Samples

A basic example of deploying Spring Cloud API Portal.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource spring 'Microsoft.AppPlatform/Spring@2023-05-01-preview' = {
  name: resourceName
  location: location
  sku: {
    name: 'E0'
  }
  properties: {
    zoneRedundant: false
  }
}

resource apiPortal 'Microsoft.AppPlatform/Spring/apiPortals@2023-05-01-preview' = {
  name: 'default'
  parent: spring
  sku: {
    capacity: 1
    name: 'E0'
    tier: 'Enterprise'
  }
  properties: {
    gatewayIds: []
    httpsOnly: false
    public: false
  }
}

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
Deploy a simple Azure Spring Apps microservice application	This template deploys a simple Azure Spring Apps microservice application to run on Azure.

Resource format

To create a Microsoft.AppPlatform/Spring/apiPortals resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AppPlatform/Spring/apiPortals@2023-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiTryOutEnabledState: 'string'
    gatewayIds: [
      'string'
    ]
    httpsOnly: bool
    public: bool
    sourceUrls: [
      'string'
    ]
    ssoProperties: {
      clientId: 'string'
      clientSecret: 'string'
      issuerUri: 'string'
      scope: [
        'string'
      ]
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
}

Property Values

Microsoft.AppPlatform/Spring/apiPortals

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: Spring
properties	API portal properties payload	ApiPortalProperties
sku	Sku of the API portal resource	Sku

ApiPortalProperties

Name	Description	Value
apiTryOutEnabledState	Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.	'Disabled' 'Enabled'
gatewayIds	The array of resource Ids of gateway to integrate with API portal.	string[]
httpsOnly	Indicate if only https is allowed.	bool
public	Indicates whether the API portal exposes endpoint.	bool
sourceUrls	Collection of OpenAPI source URL locations.	string[]
ssoProperties	Single sign-on related configuration	SsoProperties

Sku

Name	Description	Value
capacity	Current capacity of the target resource	int
name	Name of the Sku	string
tier	Tier of the Sku	string

SsoProperties

Name	Description	Value
clientId	The public identifier for the application	string
clientSecret	The secret known only to the application and the authorization server	string
issuerUri	The URI of Issuer Identifier	string
scope	It defines the specific actions applications can be allowed to do on a user's behalf	string[]

ARM template resource definition

The Spring/apiPortals resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Deploy a simple Azure Spring Apps microservice application	This template deploys a simple Azure Spring Apps microservice application to run on Azure.

Resource format

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

{
  "type": "Microsoft.AppPlatform/Spring/apiPortals",
  "apiVersion": "2023-12-01",
  "name": "string",
  "properties": {
    "apiTryOutEnabledState": "string",
    "gatewayIds": [ "string" ],
    "httpsOnly": "bool",
    "public": "bool",
    "sourceUrls": [ "string" ],
    "ssoProperties": {
      "clientId": "string",
      "clientSecret": "string",
      "issuerUri": "string",
      "scope": [ "string" ]
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  }
}

Property Values

Microsoft.AppPlatform/Spring/apiPortals

Name	Description	Value
apiVersion	The api version	'2023-12-01'
name	The resource name	string (required)
properties	API portal properties payload	ApiPortalProperties
sku	Sku of the API portal resource	Sku
type	The resource type	'Microsoft.AppPlatform/Spring/apiPortals'

ApiPortalProperties

Name	Description	Value
apiTryOutEnabledState	Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.	'Disabled' 'Enabled'
gatewayIds	The array of resource Ids of gateway to integrate with API portal.	string[]
httpsOnly	Indicate if only https is allowed.	bool
public	Indicates whether the API portal exposes endpoint.	bool
sourceUrls	Collection of OpenAPI source URL locations.	string[]
ssoProperties	Single sign-on related configuration	SsoProperties

Sku

Name	Description	Value
capacity	Current capacity of the target resource	int
name	Name of the Sku	string
tier	Tier of the Sku	string

SsoProperties

Name	Description	Value
clientId	The public identifier for the application	string
clientSecret	The secret known only to the application and the authorization server	string
issuerUri	The URI of Issuer Identifier	string
scope	It defines the specific actions applications can be allowed to do on a user's behalf	string[]

Terraform (AzAPI provider) resource definition

The Spring/apiPortals resource type can be deployed with operations that target:

Resource groups For a list of changed properties in each API version, see change log.

Usage Examples

Terraform Samples

A basic example of deploying Spring Cloud API Portal.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "Spring" {
  type      = "Microsoft.AppPlatform/Spring@2023-05-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      zoneRedundant = false
    }
    sku = {
      name = "E0"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "apiPortal" {
  type      = "Microsoft.AppPlatform/Spring/apiPortals@2023-05-01-preview"
  parent_id = azapi_resource.Spring.id
  name      = "default"
  body = {
    properties = {
      gatewayIds = [
      ]
      httpsOnly = false
      public    = false
    }
    sku = {
      capacity = 1
      name     = "E0"
      tier     = "Enterprise"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Resource format

To create a Microsoft.AppPlatform/Spring/apiPortals resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/apiPortals@2023-12-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      apiTryOutEnabledState = "string"
      gatewayIds = [
        "string"
      ]
      httpsOnly = bool
      public = bool
      sourceUrls = [
        "string"
      ]
      ssoProperties = {
        clientId = "string"
        clientSecret = "string"
        issuerUri = "string"
        scope = [
          "string"
        ]
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.AppPlatform/Spring/apiPortals

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: Spring
properties	API portal properties payload	ApiPortalProperties
sku	Sku of the API portal resource	Sku
type	The resource type	"Microsoft.AppPlatform/Spring/apiPortals@2023-12-01"

ApiPortalProperties

Name	Description	Value
apiTryOutEnabledState	Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.	'Disabled' 'Enabled'
gatewayIds	The array of resource Ids of gateway to integrate with API portal.	string[]
httpsOnly	Indicate if only https is allowed.	bool
public	Indicates whether the API portal exposes endpoint.	bool
sourceUrls	Collection of OpenAPI source URL locations.	string[]
ssoProperties	Single sign-on related configuration	SsoProperties

Sku

Name	Description	Value
capacity	Current capacity of the target resource	int
name	Name of the Sku	string
tier	Tier of the Sku	string

SsoProperties

Name	Description	Value
clientId	The public identifier for the application	string
clientSecret	The secret known only to the application and the authorization server	string
issuerUri	The URI of Issuer Identifier	string
scope	It defines the specific actions applications can be allowed to do on a user's behalf	string[]

Feedback

Was this page helpful?

Last updated on 2026-01-20