Skip to content
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

Document Azure service principal auth in snapshot/agent.mdx #21942

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+8 −1
Open

Document Azure service principal auth in snapshot/agent.mdx #21942

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9f0a73
Update agent.mdx
SuyashHashiCorp Nov 14, 2024
ea6cc63
Update website/content/commands/snapshot/agent.mdx
SuyashHashiCorp Jan 14, 2025
87e7706
Update website/content/commands/snapshot/agent.mdx
SuyashHashiCorp Jan 14, 2025
7f9006a
Update website/content/commands/snapshot/agent.mdx
SuyashHashiCorp Jan 14, 2025
5f5282f
Merge branch 'main' into SuyashHashiCorp-patch-2
SuyashHashiCorp Jan 14, 2025
2f40925
Update website/content/commands/snapshot/agent.mdx
SuyashHashiCorp Jan 15, 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
8 changes: 7 additions & 1 deletion website/content/commands/snapshot/agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,9 +396,15 @@ These options cannot be used when using `backup_destinations` in a config file.
- `-azure-blob-container-name` - Container to use. Required for Azure blob storage, and setting this
disables local storage.

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

~> These below options `azure-blob-service-principal-id`, `azure-blob-service-principal-secret`, and `azure-blob-tenant-id` are introduced in v1.20.1+ent.
SuyashHashiCorp marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
~> These below options `azure-blob-service-principal-id`, `azure-blob-service-principal-secret`, and `azure-blob-tenant-id` are introduced in v1.20.1+ent.
The following options were introduced in v1.20.1+ent.

In addition to Blake's suggestion, the callout should be dropped. Especially because the callout with a list inside it is likely to throw rendering errors


- `-azure-blob-service-principal-id` and `-azure-blob-service-principal-secret` - Use these parameters to authenticate using Service Principal (SPN) ID + Secret together.
SuyashHashiCorp marked this conversation as resolved.
Show resolved Hide resolved

- `-azure-blob-tenant-id` - Required when using Service Principal ID and Secret.
SuyashHashiCorp marked this conversation as resolved.
Show resolved Hide resolved

#### Google Cloud Storage options

~> 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.
Expand Down
Loading