Skip to content

Commit 6d7d684

Browse files
authored
Document supported CLI environment variables
1 parent 545cec6 commit 6d7d684

3 files changed

Lines changed: 6 additions & 0 deletions

File tree

docs/commands/extract.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ apiops extract \
7575
| `--subscription-id <id>` | string | env: `AZURE_SUBSCRIPTION_ID` | Azure subscription ID (required) |
7676
| `--log-level <level>` | string | `info` | Log level: `debug`, `info`, `warn`, `error` |
7777
| `--format <type>` | string | `text` | Output format: `text` or `json` |
78+
| `--api-version <version>` | string | `2024-05-01` (env: `AZURE_API_VERSION`) | APIM REST API version override |
7879
| `--cloud <name>` | string | `public` | Sovereign cloud: `public`, `china`, `usgov`, `germany` |
7980
| `--client-id <id>` | string || Service principal client ID |
8081
| `--client-secret <secret>` | string || Service principal client secret |

docs/commands/publish.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ apiops publish \
8686
| `--subscription-id <id>` | string | env: `AZURE_SUBSCRIPTION_ID` | Azure subscription ID (required) |
8787
| `--log-level <level>` | string | `info` | Log level: `debug`, `info`, `warn`, `error` |
8888
| `--format <type>` | string | `text` | Output format: `text` or `json` |
89+
| `--api-version <version>` | string | `2024-05-01` (env: `AZURE_API_VERSION`) | APIM REST API version override |
8990
| `--cloud <name>` | string | `public` | Sovereign cloud: `public`, `china`, `usgov`, `germany` |
9091
| `--client-id <id>` | string || Service principal client ID |
9192
| `--client-secret <secret>` | string || Service principal client secret |
@@ -162,6 +163,8 @@ In CI/CD pipelines, this is typically set automatically:
162163
- run: npx apiops publish --commit-id ${{ github.event.before }}
163164
```
164165

166+
When both are provided, `--commit-id` takes precedence over `COMMIT_ID`.
167+
165168
> **Tip:** Incremental publish cannot be combined with `--delete-unmatched` because delete-unmatched requires a full comparison between source and APIM.
166169

167170
## Dry run

docs/reference/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ Available on all commands (`extract`, `publish`, `init`):
8888
| `AZURE_TENANT_ID` | all | Microsoft Entra ID (Azure AD) tenant ID |
8989
| `AZURE_API_VERSION` | extract, publish | APIM REST API version (default: `2024-05-01`) |
9090
| `COMMIT_ID` | publish | Git commit SHA for incremental publish (alternative to `--commit-id`) |
91+
| `OTEL_EXPORTER_OTLP_ENDPOINT` | extract, publish | OpenTelemetry OTLP exporter endpoint for telemetry |
92+
| `APPLICATIONINSIGHTS_CONNECTION_STRING` | extract, publish | Azure Monitor Application Insights connection string for telemetry |
9193

9294
### Authentication Environment Variables
9395

0 commit comments

Comments
 (0)