Configure environment variables

gcloud

To set a runtime environment variable using the Google Cloud CLI, use the --set-env-vars flag at deploy time:

gcloud functions deploy FUNCTION_NAME --set-env-vars FOO=bar FLAGS ...

You can also set multiple runtime environment variables using a comma separated list:

gcloud functions deploy FUNCTION_NAME --set-env-vars FOO=bar,BAZ=boo FLAGS...

If you want to store your configuration in a file (e.g. under source control), you can use a YAML file together with the --env-vars-file flag:

gcloud functions deploy FUNCTION_NAME --env-vars-file .env.yaml FLAGS...

where the contents of the .env.yaml file are:

 FOO: bar
 BAZ: boo

In the above examples, FLAGS... refers to other options that you pass during deployment of your function. For a complete reference for the deploy command, see gcloud functions deploy.

Google Cloud console UI

You can set runtime environment variables during function creation in the Google Cloud console:

1. Open the Functions Overview page in the Google Cloud console:

   Go to the Cloud Run functions Overview page.

2. Click Create function.

3. Fill in the required fields for your function.

4. Open the Runtime, build and connections settings section.

5. Select the Runtime tab.

6. In the Runtime environment variables section, click Add variable and add the name and value.

   For instructions on how to add environment variables to an existing function, see Updating runtime environment variables.

gcloud

To update a variable using the Google Cloud CLI, use the --update-env-vars flag at deploy time:

gcloud functions deploy FUNCTION_NAME --update-env-vars FOO=bar

You can also update multiple runtime environment variables using a comma separated list:

gcloud functions deploy FUNCTION_NAME --update-env-vars FOO=bar,BAZ=boo

Google Cloud console UI

To update runtime environment variables using the Google Cloud console:

1. Open the Functions Overview page in the Google Cloud console:

   Go to the Cloud Run functions Overview page.

2. Click an existing function to go to its details page.

3. Click Edit.

4. Open the Runtime, build and connections settings section.

5. Select the Runtime tab.

6. Make your edits in the Runtime environment variables section.

gcloud

If you want to selectively remove runtime environment variables you can use the --remove-env-vars flag at deploy time:

gcloud functions deploy FUNCTION_NAME --remove-env-vars FOO,BAZ

Alternatively, you can clear all previously set runtime environment variables with the --clear-env-vars flag:

gcloud functions deploy FUNCTION_NAME --clear-env-vars

Google Cloud console UI

To delete runtime environment variables using the Google Cloud console:

1. Open the Functions Overview page in the Google Cloud console:

   Go to the Cloud Run functions Overview page.

2. Click an existing function to go to its details page.

3. Click Edit.

4. Open the Runtime, build and connections settings section.

5. Select the Runtime tab.

6. In the Runtime environment variables section, click the garbage icon next to the key/value pair to delete it.

Node.js

gcloud functions deploy envVar \
--runtime nodejs22 \
--set-env-vars FOO=bar \
--trigger-http

Use the --runtime flag to specify the runtime ID of a supported Node.js version to run your function.

Python

gcloud functions deploy env_vars \
--runtime python312 \
--set-env-vars FOO=bar \
--trigger-http

Use the --runtime flag to specify the runtime ID of a supported Python version to run your function.

Go

gcloud functions deploy EnvVar \
--runtime go122 \
--set-env-vars FOO=bar \
--trigger-http

Use the --runtime flag to specify the runtime ID of a supported Go version to run your function.

Java

gcloud functions deploy java-envVar-function \
--entry-point functions.EnvVars \
--runtime java21 \
--memory 512MB \
--set-env-vars FOO=bar \
--trigger-http

Use the --runtime flag to specify the runtime ID of a supported Java version to run your function.

C#

gcloud functions deploy csharp-envVar-function \
--entry-point EnvironmentVariables.Function \
--runtime dotnet8 \
--set-env-vars FOO=bar \
--trigger-http

Use the --runtime flag to specify the runtime ID of a supported .NET version to run your function.

Ruby

gcloud functions deploy env_vars --runtime ruby33 \
--set-env-vars FOO=bar \
--trigger-http

Use the --runtime flag to specify the runtime ID of a supported Ruby version to run your function.

PHP

 gcloud functions deploy envVar --runtime php83 \
--set-env-vars FOO=bar \
--trigger-http

Use the --runtime flag to specify the runtime ID of a supported PHP version to run your function.

Node.js

In Node.js use the process.env property to access runtime environment variables:

exports.envVar = (req, res) => {
  // Sends 'bar' as response
  res.send(process.env.FOO);
};

Python

In Python use os.environ to access runtime environment variables:

import os


def env_vars(request):
    return os.environ.get("FOO", "Specified environment variable is not set.")

Go

In Go use os.Getenv() to access runtime environment variables:

// Package tips contains tips for writing Cloud Functions in Go.
package tips

import (
	"fmt"
	"net/http"
	"os"
)

// EnvVar is an example of getting an environment variable in a Go function.
func EnvVar(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "FOO: %q", os.Getenv("FOO"))
}

Java

In Java use System.getenv to access runtime environment variables:

import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.BufferedWriter;
import java.io.IOException;

public class EnvVars implements HttpFunction {

  // Returns the environment variable "foo" set during function deployment.
  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    BufferedWriter writer = response.getWriter();
    String foo = System.getenv("FOO");
    if (foo == null) {
      foo = "Specified environment variable is not set.";
    }
    writer.write(foo);
  }
}

C#

using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System;
using System.Threading.Tasks;

namespace EnvironmentVariables;

public class Function : IHttpFunction
{
    public async Task HandleAsync(HttpContext context)
    {
        string foo = Environment.GetEnvironmentVariable("FOO")
            ?? "Specified environment variable is not set.";
        await context.Response.WriteAsync(foo, context.RequestAborted);
    }
}

Ruby

require "functions_framework"

FunctionsFramework.http "env_vars" do |_request|
  ENV["FOO"] || "Specified environment variable is not set."
end

PHP

use Psr\Http\Message\ServerRequestInterface;

function envVar(ServerRequestInterface $request): string
{
    return getenv('FOO') . PHP_EOL;
}

gcloud

To set a variable using the Google Cloud CLI, use the --set-build-env-vars flag at deploy time:

gcloud beta functions deploy FUNCTION_NAME --set-build-env-vars FOO=bar FLAGS...

You can also set multiple build environment variables using a comma separated list:

gcloud functions deploy FUNCTION_NAME --set-build-env-vars FOO=bar,BAZ=boo FLAGS...

If you want to store your configuration in a file (e.g. under source control), you can use a YAML file together with the --build-env-vars-file flag:

gcloud functions deploy FUNCTION_NAME --build-env-vars-file FILE_NAME.yaml FLAGS...

where the contents of the *.yaml file are:

 FOO: bar
 BAZ: boo

In the above examples, FLAGS... refers to other options that you pass during deployment of your function. For a complete reference for the deploy command, see gcloud beta functions deploy.

Google Cloud console UI

You can also set build environment variables during function creation in the Google Cloud console:

1. Open the Functions Overview page in the Google Cloud console:

   Go to the Cloud Run functions Overview page.

2. Click Create function.

3. Fill in the required fields for your function.

4. Open the Runtime, build and connections settings section.

5. Select the Build tab.

6. In the Build environment variables section, click Add variable and add the name and value.

gcloud

To set a variable using the Google Cloud CLI, use the --update-build-env-vars flag at deploy time:

gcloud functions deploy FUNCTION_NAME --update-build-env-vars FOO=bar

You can also update multiple build environment variables using a comma separated list:

gcloud functions deploy FUNCTION_NAME --update-build-env-vars FOO=bar,BAZ=boo

Google Cloud console UI

To update build environment variables using the Google Cloud console:

1. Open the Functions Overview page in the Google Cloud console:

   Go to the Cloud Run functions Overview page.

2. Click an existing function to go to its details page.

3. Click Edit.

4. Open the Runtime, build and connections settings section.

5. Select the Build tab.

6. Make your edits in the Build environment variables section.

gcloud

If you want to selectively remove build environment variables you can use the --remove-build-env-vars flag at deploy time:

gcloud functions deploy FUNCTION_NAME --remove-build-env-vars FOO,BAZ

Alternatively, you can clear all previously set build environment variables with the --clear-build-env-vars flag:

gcloud functions deploy FUNCTION_NAME --clear-build-env-vars

Google Cloud console UI

To delete build environment variables using the Google Cloud console:

1. Open the Functions Overview page in the Google Cloud console:

   Go to the Cloud Run functions Overview page.

2. Click an existing function to go to its details page.

3. Click Edit.

4. Open the Runtime, build and connections settings section.

5. Select the Build tab.

6. In the Build environment variables section, click the garbage icon next to the key/value pair to delete it.