Skip to content

Resource Configurations

Xiaolu Dai edited this page Dec 6, 2024 · 8 revisions

Configuration options for each resource

In azure.yaml, there are some configuration options for each resource type, here is the detailed list of the configuration properties:

Azure Database for PostgreSQL

  1. databaseName. The name of the database. Not database server name. This url can explain the difference: jdbc:mysql://databaseServerName:3306/databaseName.
  2. authType. The authentication type. Here is the list of supported types:
    1. userAssignedManagedIdentity. This will use user assigned managed identity to access the database.
    2. password. This option will use username and password to access the database.

Azure Database for MySQL

  1. databaseName. The name of the database. Not database server name. This url can explain the difference: jdbc:mysql://databaseServerName:3306/databaseName.
  2. authType. The authentication type. Here is the list of supported types:
    1. userAssignedManagedIdentity. This will use user assigned managed identity to access the database.
    2. password. This option will use username and password to access the database.

Azure Cache for Redis

No configuration options for Azure Cache for Redis now.

Azure Cosmos DB for Mongo

  1. databaseName. The name of the database. Not database server name. This url can explain the difference: jdbc:mysql://databaseServerName:3306/databaseName.

Azure Cosmos DB

  1. databaseName. The name of the database. Not database server name. This url can explain the difference: jdbc:mysql://databaseServerName:3306/databaseName.
  2. containers. The containers in Cosmos DB, it's a list. Each Container contains these properties:
    1. containerName. The name of the container.
    2. partitionKeyPaths. The paths to partition key.

Azure Service Bus

  1. queues. The name of queue in Azure Service Bus. It's a list.
  2. isJms. Whether the Azure Service Bus is used as JMS mode. Its type is boolean.
  3. authType. The authentication type. Here is the list of supported types:
    1. userAssignedManagedIdentity. This will use user assigned managed identity to access Azure Service Bus.
    2. connectionString. This option will use connection string to access the Azure Service Bus.

Azure Event Hubs

  1. eventHubNames. The name of event hubs.
  2. authType. The authentication type. Here is the list of supported types:
    1. userAssignedManagedIdentity. This will use user assigned managed identity to access Azure Event Hubs.
    2. connectionString. This option will use connection string to access the Azure Event Hubs.

Azure Event Hubs for Kafka

  1. topics. The name of kafka topics.
  2. authType. The authentication type. Here is the list of supported types:
    1. userAssignedManagedIdentity. This will use user assigned managed identity to access Azure Event Hubs.
    2. connectionString. This option will use connection string to access the Azure Event Hubs.
  3. springBootVersion. The supported spring boot versions are 2.x and 3.x.

Azure Storage Account

  1. containers. The containers in Azure Storage Account.
  2. authType. The authentication type. Here is the list of supported types:
    1. userAssignedManagedIdentity. This will use user assigned managed identity to access Azure Storage Account.
    2. connectionString. This option will use connection string to access the Azure Storage Account.

Host Container Apps

  1. port. The exposed port of your application that will deploy to Azure Container Apps .
  2. uses. The "uses" relationship between Azure Container Apps and other services. For example, When your application deployed into Azure Container App, your application need to read and write data in Azure Database for PostgreSQL, then the "uses" relationship exists between Azure Container Apps and Azure Database for PostgreSQL. Here is an example:
resources:
    app:
        type: host.containerapp
        uses:
            - postgres
        port: 3100
    postgres:
        type: db.postgres
        databaseName: test