Skip to content

add env vars and update docs #36922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

add env vars and update docs #36922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e2e338
add env vars and update docs
jaredfholgate Apr 25, 2025
c6990bf
add release note
jaredfholgate Apr 25, 2025
0f9a91b
fix env var name
jaredfholgate Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changes/v1.13/ENHANCEMENTS-20250425-160021.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kind: ENHANCEMENTS
body: 'backend/azurerm: Support Azure DevOps environment variables and backend specific variables'
time: 2025-04-25T16:00:21.8153592+01:00
custom:
Issue: "36922"
4 changes: 2 additions & 2 deletions internal/backend/remote-state/azure/backend.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ func New() backend.Backend {
Type: schema.TypeString,
Optional: true,
Description: "The Client ID to use when authenticating using Azure Active Directory.",
DefaultFunc: schema.EnvDefaultFunc("ARM_CLIENT_ID", ""),
DefaultFunc: schema.MultiEnvDefaultFunc([]string{"ARM_CLIENT_ID_BACKEND", "ARM_CLIENT_ID"}, ""),
},

"client_id_file_path": {
Expand Down Expand Up @@ -166,7 +166,7 @@ func New() backend.Backend {
"ado_pipeline_service_connection_id": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.MultiEnvDefaultFunc([]string{"ARM_ADO_PIPELINE_SERVICE_CONNECTION_ID", "ARM_OIDC_AZURE_SERVICE_CONNECTION_ID"}, nil),
DefaultFunc: schema.MultiEnvDefaultFunc([]string{"ARM_OIDC_AZURE_SERVICE_CONNECTION_ID_BACKEND", "ARM_ADO_PIPELINE_SERVICE_CONNECTION_ID", "ARM_OIDC_AZURE_SERVICE_CONNECTION_ID", "AZURESUBSCRIPTION_SERVICE_CONNECTION_ID"}, nil),
Description: "The Azure DevOps Pipeline Service Connection ID.",
},

Expand Down
8 changes: 4 additions & 4 deletions website/docs/language/backend/azurerm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ These optional configuration options apply when [looking up the data plane URI](

The recommended data plane role assignments required for this method are either one of:

- `Storage Blob Data Owner` on the storage account container (Recommended)
- `Storage Blob Data Contributor` on the storage account container (Recommended)
- `Storage Blob Data Contributor` on the storage account

The recommended management plane role assignments required for this method are:
Expand Down Expand Up @@ -339,7 +339,7 @@ These optional configuration options apply when [looking up the data plane URI](

The recommended data plane role assignments required for this method are either one of:

- `Storage Blob Data Owner` on the storage account container (Recommended)
- `Storage Blob Data Contributor` on the storage account container (Recommended)
- `Storage Blob Data Contributor` on the storage account

The recommended management plane role assignments required for this method are:
Expand Down Expand Up @@ -548,9 +548,9 @@ The following configuration options are supported:

* `use_oidc` - (Optional) Set to `true` to use OpenID Connect / Workload identity federation authentication for authentication to the storage account management and data plane. This can also be sourced from the `ARM_USE_OIDC` environment variable.

* `client_id` - (Optional) The Client ID of the Azure Active Directory Principal required for some authentication sub-types. This can also be sourced from the `ARM_CLIENT_ID` environment variable.
* `client_id` - (Optional) The Client ID of the Azure Active Directory Principal required for some authentication sub-types. This can also be sourced from the `ARM_CLIENT_ID` or `ARM_CLIENT_ID_BACKEND` environment variable.

* `ado_pipeline_service_connection_id` - (Optional) The Azure DevOps Pipeline Service Connection ID required for Open ID Connect / Workload identity federation authentication with Azure DevOps. This can also be sourced from the `ARM_ADO_PIPELINE_SERVICE_CONNECTION_ID` or `ARM_OIDC_AZURE_SERVICE_CONNECTION_ID` environment variables. The provider will look for values in this order and use the first it finds configured.
* `ado_pipeline_service_connection_id` - (Optional) The Azure DevOps Pipeline Service Connection ID required for Open ID Connect / Workload identity federation authentication with Azure DevOps. This can also be sourced from the `ARM_ADO_PIPELINE_SERVICE_CONNECTION_ID`, `ARM_OIDC_AZURE_SERVICE_CONNECTION_ID`, `AZURESUBSCRIPTION_SERVICE_CONNECTION_ID` or `ARM_OIDC_AZURE_SERVICE_CONNECTION_ID_BACKEND` environment variables. The provider will look for values in this order and use the first it finds configured.

* `oidc_request_url` - (Optional) The URL for the Open ID Connect provider from which to request an ID token. This is only required for advanced scenarios or third party integrations. This can also be sourced from the `ARM_OIDC_REQUEST_URL`, `ACTIONS_ID_TOKEN_REQUEST_URL` or `SYSTEM_OIDCREQUESTURI` environment variables. The provider will look for values in this order and use the first it finds configured.

Expand Down