Skip to content

Commit 1b65a3f

Browse files
github-actions[bot]chaptersixDuncanma
authored
Update CLI docs for release v1.8.2 (#5002)
* Update CLI docs for release v1.8.2 * Fix formatting of Azure PE resource ID example --------- Co-authored-by: Alex Stanfield <chaptersix@users.noreply.github.com> Co-authored-by: Duncan Mackenzie <duncanma@duncanmackenzie.net>
1 parent 580fce5 commit 1b65a3f

3 files changed

Lines changed: 373 additions & 1 deletion

File tree

‎docs/cli/command-reference/cloud/namespace.mdx‎

Lines changed: 101 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,107 @@ Use the following options to change the behavior of this command. You can also u
431431

432432
Commands for managing workflow history export sinks for Temporal Cloud namespaces.
433433

434-
Export sinks define destinations (S3 or GCS) to which workflow history is exported.
434+
Export sinks define destinations (S3, GCS, or Azure Blob) to which workflow history is exported.
435+
436+
### export azure-blob
437+
438+
Commands for managing Azure Blob workflow history export sinks for Temporal Cloud namespaces.
439+
440+
#### export azure-blob create
441+
442+
Create a new Azure Blob workflow history export sink for a Temporal Cloud namespace.
443+
The sink is created in the enabled state.
444+
445+
Example:
446+
447+
```
448+
temporal cloud namespace export azure-blob create --namespace my-namespace.my-account --sink-name my-sink \
449+
--tenant-id 11111111-1111-1111-1111-111111111111 \
450+
--subscription-id 22222222-2222-2222-2222-222222222222 \
451+
--resource-group my-resource-group --storage-account my-storage-account \
452+
--container-name my-container --region eastus
453+
```
454+
455+
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
456+
457+
| Flag | Required | Description |
458+
|------|----------|-------------|
459+
| `--api-key` | No | **string** API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. |
460+
| `--async` | No | **bool** Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. |
461+
| `--async-operation-id` | No | **string** Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. |
462+
| `--container-name` | Yes | **string** The name of the destination Azure Blob container where Temporal will send data. |
463+
| `--idempotent` | No | **bool** Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. |
464+
| `--namespace`, `-n` | Yes | **string** The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account'). |
465+
| `--poll-interval` | No | **duration** Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). |
466+
| `--region` | Yes | **string** The region where the Azure storage account is located. |
467+
| `--resource-group` | Yes | **string** The Azure resource group that contains the storage account. |
468+
| `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
469+
| `--sink-name` | Yes | **string** The name of the export sink. |
470+
| `--storage-account` | Yes | **string** The name of the destination Azure storage account where Temporal will send data. |
471+
| `--subscription-id` | Yes | **string** The Azure subscription ID that contains the storage account. |
472+
| `--tenant-id` | Yes | **string** The Azure tenant ID where the storage account exists and where Temporal's app registration is consented/granted access. |
473+
474+
#### export azure-blob update
475+
476+
Update the configuration of an existing Azure Blob workflow history export sink.
477+
Only the flags you provide are changed; omitted flags keep their current
478+
values. The enabled/disabled state and region are also preserved.
479+
480+
Example (rotate storage account only):
481+
482+
```
483+
temporal cloud namespace export azure-blob update --namespace my-namespace.my-account --sink-name my-sink \
484+
--storage-account my-new-storage-account
485+
```
486+
487+
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
488+
489+
| Flag | Required | Description |
490+
|------|----------|-------------|
491+
| `--api-key` | No | **string** API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. |
492+
| `--async` | No | **bool** Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. |
493+
| `--async-operation-id` | No | **string** Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. |
494+
| `--container-name` | No | **string** The name of the destination Azure Blob container where Temporal will send data. If omitted, the current value is kept. |
495+
| `--idempotent` | No | **bool** Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. |
496+
| `--namespace`, `-n` | Yes | **string** The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account'). |
497+
| `--poll-interval` | No | **duration** Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). |
498+
| `--resource-group` | No | **string** The Azure resource group that contains the storage account. If omitted, the current value is kept. |
499+
| `--resource-version`, `-v` | No | **string** Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. |
500+
| `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
501+
| `--sink-name` | Yes | **string** The name of the export sink. |
502+
| `--storage-account` | No | **string** The name of the destination Azure storage account where Temporal will send data. If omitted, the current value is kept. |
503+
| `--subscription-id` | No | **string** The Azure subscription ID that contains the storage account. If omitted, the current value is kept. |
504+
| `--tenant-id` | No | **string** The Azure tenant ID where the storage account exists and where Temporal's app registration is consented/granted access. If omitted, the current value is kept. |
505+
506+
#### export azure-blob validate
507+
508+
Validate an Azure Blob workflow history export sink configuration without creating or updating it.
509+
A successful response means the configuration is valid.
510+
511+
Example:
512+
513+
```
514+
temporal cloud namespace export azure-blob validate --namespace my-namespace.my-account --sink-name my-sink \
515+
--tenant-id 11111111-1111-1111-1111-111111111111 \
516+
--subscription-id 22222222-2222-2222-2222-222222222222 \
517+
--resource-group my-resource-group --storage-account my-storage-account \
518+
--container-name my-container --region eastus
519+
```
520+
521+
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
522+
523+
| Flag | Required | Description |
524+
|------|----------|-------------|
525+
| `--api-key` | No | **string** API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. |
526+
| `--container-name` | Yes | **string** The name of the destination Azure Blob container where Temporal will send data. |
527+
| `--namespace`, `-n` | Yes | **string** The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account'). |
528+
| `--region` | Yes | **string** The region where the Azure storage account is located. |
529+
| `--resource-group` | Yes | **string** The Azure resource group that contains the storage account. |
530+
| `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
531+
| `--sink-name` | Yes | **string** The name of the export sink. |
532+
| `--storage-account` | Yes | **string** The name of the destination Azure storage account where Temporal will send data. |
533+
| `--subscription-id` | Yes | **string** The Azure subscription ID that contains the storage account. |
534+
| `--tenant-id` | Yes | **string** The Azure tenant ID where the storage account exists and where Temporal's app registration is consented/granted access. |
435535

436536
### export delete
437537

0 commit comments

Comments
 (0)