Skip to content

Commit 616de64

Browse files
Document Azure service principal auth in snapshot/agent.mdx (#21942)
* Update agent.mdx Starting from Consul v1.20.1+ent, Consul supports using Azure Blob Storage for the snapshot agent via Azure Service Principal ID and Secret authentication. I've successfully tested this configuration in my lab environment and have added the relevant parameters to this documentation for completeness. * Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias <[email protected]> * Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias <[email protected]> * Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias <[email protected]> * Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias <[email protected]> --------- Co-authored-by: Blake Covarrubias <[email protected]>
1 parent 9bd863d commit 616de64

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

website/content/commands/snapshot/agent.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,9 +396,16 @@ These options cannot be used when using `backup_destinations` in a config file.
396396
- `-azure-blob-container-name` - Container to use. Required for Azure blob storage, and setting this
397397
disables local storage.
398398

399-
* `-azure-blob-environment` - Environment to use. Defaults to AZUREPUBLICCLOUD. Other valid environments
399+
- `-azure-blob-environment` - Environment to use. Defaults to AZUREPUBLICCLOUD. Other valid environments
400400
are AZURECHINACLOUD, AZUREGERMANCLOUD and AZUREUSGOVERNMENTCLOUD. Introduced in Consul 1.7.3.
401401

402+
~> The following options were introduced in v1.20.1+ent.
403+
404+
- `-azure-blob-service-principal-id` - The ID of the service principal that owns the blob object.
405+
- `-azure-blob-service-principal-secret` - The secret of the service principal that owns the blob object.
406+
407+
- `-azure-blob-tenant-id` - The ID of the tenant that owns the Azure blob.
408+
402409
#### Google Cloud Storage options
403410

404411
~> This option is deprecated when used with a top-level `google_storage` object in a config file. Use `snapshot_agent -> backup_destinations -> google_storage[0]` in a config file instead.

0 commit comments

Comments
 (0)