Microsoft.AppPlatform Spring/apps/bindings

Remarks

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

Bicep resource definition

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

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

Usage Examples

Bicep Samples

A basic example of deploying Associates a Spring Cloud Application with a resource.

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

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

resource app 'Microsoft.AppPlatform/Spring/apps@2023-05-01-preview' = {
  name: resourceName
  location: location
  parent: spring
  properties: {
    customPersistentDisks: []
    enableEndToEndTLS: false
    public: false
  }
}

resource binding 'Microsoft.AppPlatform/Spring/apps/bindings@2023-05-01-preview' = {
  name: resourceName
  parent: app
  properties: {
    bindingParameters: {
      useSsl: 'true'
    }
    key: redis.listKeys().primaryKey
    resourceId: redis.id
  }
}

resource redis 'Microsoft.Cache/redis@2023-04-01' = {
  name: resourceName
  location: location
  properties: {
    enableNonSslPort: true
    minimumTlsVersion: '1.2'
    sku: {
      capacity: 2
      family: 'C'
      name: 'Standard'
    }
  }
}

Resource format

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

resource symbolicname 'Microsoft.AppPlatform/Spring/apps/bindings@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    bindingParameters: {
      {customized property}: 'string'
    }
    key: 'string'
    resourceId: 'string'
  }
}

Property Values

Microsoft.AppPlatform/Spring/apps/bindings

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/apps
properties Properties of the Binding resource BindingResourceProperties

BindingResourceProperties

Name Description Value
bindingParameters Binding parameters of the Binding resource BindingResourcePropertiesBindingParameters
key The key of the bound resource string
resourceId The Azure resource id of the bound resource string

BindingResourcePropertiesBindingParameters

Name Description Value

ARM template resource definition

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

Usage Examples

Resource format

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

{
  "type": "Microsoft.AppPlatform/Spring/apps/bindings",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "properties": {
    "bindingParameters": {
      "{customized property}": "string"
    },
    "key": "string",
    "resourceId": "string"
  }
}

Property Values

Microsoft.AppPlatform/Spring/apps/bindings

Name Description Value
apiVersion The api version '2024-05-01-preview'
name The resource name string (required)
properties Properties of the Binding resource BindingResourceProperties
type The resource type 'Microsoft.AppPlatform/Spring/apps/bindings'

BindingResourceProperties

Name Description Value
bindingParameters Binding parameters of the Binding resource BindingResourcePropertiesBindingParameters
key The key of the bound resource string
resourceId The Azure resource id of the bound resource string

BindingResourcePropertiesBindingParameters

Name Description Value

Terraform (AzAPI provider) resource definition

The Spring/apps/bindings 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 Associates a Spring Cloud Application with a resource.

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 = "S0"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "app" {
  type      = "Microsoft.AppPlatform/Spring/apps@2023-05-01-preview"
  parent_id = azapi_resource.Spring.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      customPersistentDisks = [
      ]
      enableEndToEndTLS = false
      public            = false
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "redis" {
  type      = "Microsoft.Cache/redis@2023-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      sku = {
        capacity = 2
        family   = "C"
        name     = "Standard"
      }
      enableNonSslPort  = true
      minimumTlsVersion = "1.2"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Cache/redis@2023-04-01"
  resource_id            = azapi_resource.redis.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

resource "azapi_resource" "binding" {
  type      = "Microsoft.AppPlatform/Spring/apps/bindings@2023-05-01-preview"
  parent_id = azapi_resource.app.id
  name      = var.resource_name
  body = {
    properties = {
      bindingParameters = {
        useSsl = "true"
      }
      key        = data.azapi_resource_action.listKeys.output.primaryKey
      resourceId = azapi_resource.redis.id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/apps/bindings@2024-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      bindingParameters = {
        {customized property} = "string"
      }
      key = "string"
      resourceId = "string"
    }
  }
}

Property Values

Microsoft.AppPlatform/Spring/apps/bindings

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/apps
properties Properties of the Binding resource BindingResourceProperties
type The resource type "Microsoft.AppPlatform/Spring/apps/bindings@2024-05-01-preview"

BindingResourceProperties

Name Description Value
bindingParameters Binding parameters of the Binding resource BindingResourcePropertiesBindingParameters
key The key of the bound resource string
resourceId The Azure resource id of the bound resource string

BindingResourcePropertiesBindingParameters

Name Description Value
  • Last updated on