Microsoft.AppPlatform Spring/storages

Remarks

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

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.AppPlatform/Spring/storages@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    storageType: 'string'
    // For remaining properties, see StorageProperties objects
  }
}

StorageProperties objects

Set the storageType property to specify the type of object.

For StorageAccount, use:

{
  accountKey: 'string'
  accountName: 'string'
  storageType: 'StorageAccount'
}

Property Values

Microsoft.AppPlatform/Spring/storages

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 Properties of the storage resource payload. StorageProperties

StorageAccount

Name Description Value
accountKey The account key of the Azure Storage Account. string

Constraints:
Sensitive value. Pass in as a secure parameter. (required)
accountName The account name of the Azure Storage Account. string (required)
storageType The type of the storage. 'StorageAccount' (required)

StorageProperties

Name Description Value
storageType Set to 'StorageAccount' for type StorageAccount. 'StorageAccount' (required)

Usage Examples

Bicep Samples

A basic example of deploying Spring Cloud Storage.

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

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_GRS'
  }
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
    allowBlobPublicAccess: true
    allowCrossTenantReplication: true
    allowSharedKeyAccess: true
    defaultToOAuthAuthentication: false
    encryption: {
      keySource: 'Microsoft.Storage'
      services: {
        queue: {
          keyType: 'Service'
        }
        table: {
          keyType: 'Service'
        }
      }
    }
    isHnsEnabled: false
    isNfsV3Enabled: false
    isSftpEnabled: false
    minimumTlsVersion: 'TLS1_2'
    networkAcls: {
      defaultAction: 'Allow'
    }
    publicNetworkAccess: 'Enabled'
    supportsHttpsTrafficOnly: true
  }
}

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

resource storage 'Microsoft.AppPlatform/Spring/storages@2023-05-01-preview' = {
  name: resourceName
  parent: spring
  properties: {
    accountKey: storageAccount.listKeys().keys[0].value
    accountName: storageAccount.name
    storageType: 'StorageAccount'
  }
}

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.AppPlatform/Spring/storages",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "properties": {
    "storageType": "string"
    // For remaining properties, see StorageProperties objects
  }
}

StorageProperties objects

Set the storageType property to specify the type of object.

For StorageAccount, use:

{
  "accountKey": "string",
  "accountName": "string",
  "storageType": "StorageAccount"
}

Property Values

Microsoft.AppPlatform/Spring/storages

Name Description Value
apiVersion The api version '2024-05-01-preview'
name The resource name string (required)
properties Properties of the storage resource payload. StorageProperties
type The resource type 'Microsoft.AppPlatform/Spring/storages'

StorageAccount

Name Description Value
accountKey The account key of the Azure Storage Account. string

Constraints:
Sensitive value. Pass in as a secure parameter. (required)
accountName The account name of the Azure Storage Account. string (required)
storageType The type of the storage. 'StorageAccount' (required)

StorageProperties

Name Description Value
storageType Set to 'StorageAccount' for type StorageAccount. 'StorageAccount' (required)

Usage Examples

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/storages@2024-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      storageType = "string"
      // For remaining properties, see StorageProperties objects
    }
  }
}

StorageProperties objects

Set the storageType property to specify the type of object.

For StorageAccount, use:

{
  accountKey = "string"
  accountName = "string"
  storageType = "StorageAccount"
}

Property Values

Microsoft.AppPlatform/Spring/storages

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 Properties of the storage resource payload. StorageProperties
type The resource type "Microsoft.AppPlatform/Spring/storages@2024-05-01-preview"

StorageAccount

Name Description Value
accountKey The account key of the Azure Storage Account. string

Constraints:
Sensitive value. Pass in as a secure parameter. (required)
accountName The account name of the Azure Storage Account. string (required)
storageType The type of the storage. 'StorageAccount' (required)

StorageProperties

Name Description Value
storageType Set to 'StorageAccount' for type StorageAccount. 'StorageAccount' (required)

Usage Examples

Terraform Samples

A basic example of deploying Spring Cloud Storage.

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" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = true
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = {
            keyType = "Service"
          }
          table = {
            keyType = "Service"
          }
        }
      }
      isHnsEnabled      = false
      isNfsV3Enabled    = false
      isSftpEnabled     = false
      minimumTlsVersion = "TLS1_2"
      networkAcls = {
        defaultAction = "Allow"
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = {
      name = "Standard_GRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2021-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

resource "azapi_resource" "storage" {
  type      = "Microsoft.AppPlatform/Spring/storages@2023-05-01-preview"
  parent_id = azapi_resource.Spring.id
  name      = var.resource_name
  body = {
    properties = {
      accountKey  = data.azapi_resource_action.listKeys.output.keys[0].value
      accountName = azapi_resource.storageAccount.name
      storageType = "StorageAccount"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}