Skip to content

AI Gateway CLI 1.0.0b14

Pre-release
Pre-release

Choose a tag to compare

@paulyuk paulyuk released this 27 Oct 20:04
eee3f39

AI Gateway CLI 1.0.0b14 — Public Preview

Azure CLI extension for creating and managing Azure AI Gateway resources, model providers, callable model aliases, MCP tool servers, policies, API keys, identities, and networking with az aigateway.

Targets Microsoft.ApiManagement/aigateways@2025-09-01-preview (while continuing to support existing Microsoft.ApiManagement/service@2025-09-01-preview AI Gateway resources).


What's New in 1.0.0b14

Following 1.0.0b12 (1.0.0b13 was an internal CI build serial), 1.0.0b14 completes the standalone Microsoft.ApiManagement/aigateways management surface and adds provider synchronization and pipeline ergonomics:

  • Complete Microsoft.ApiManagement/aigateways model & policy lifecycle: Unblocks az aigateway model create, az aigateway model update, az aigateway model policy set, set-token-limit, set-content-safety, remove, az aigateway update --tags, and az aigateway api-key regenerate --key-type secondary on standalone aigateways resources with If-Match ETag concurrency protection.
  • Foundry provider synchronization (az aigateway model-provider sync): Reconciles registered gateway models against an existing Foundry AI Services or Azure OpenAI account's current deployments (--dry-run to preview, --create-default-aliases to create 1:1 callable model aliases for newly synced models).
  • Composable CLI piping (--ids & JSON stdin): Pipe output from az cognitiveservices account show/list, az aigateway show/list, or az aigateway model show/list directly into az aigateway commands, and configure session defaults with az configure --defaults group=<rg> aigateway=<gw>.
  • ARM-aligned CLI surface: Standardized Foundry onboarding on --foundry-resource-id (with --deployment for single-deployment onboarding), replaced sample-only MCP flags (--learn, --github) with explicit --endpoints, and required explicit --location on az aigateway create.

Install or Upgrade

Requires Azure CLI (2.75.0 or later).

Bash (macOS / Linux)

curl -fsSL https://aka.ms/aigateway-cli-install | bash

PowerShell (Windows / macOS / Linux)

irm https://aka.ms/aigateway-cli-install-ps | iex

Direct wheel install

az extension add --upgrade --yes --source https://github.com/Azure/ai-gateway/releases/download/cli-v1.0.0b14/aigateway-1.0.0b14-py3-none-any.whl

Verify

az aigateway version
az aigateway --help

Quick Examples

1. Onboard & synchronize a Foundry account with default callable aliases

FOUNDRY_RESOURCE_ID="$(az cognitiveservices account show -g "$FOUNDRY_RG" -n "$FOUNDRY_ACCOUNT" --query id -o tsv)"

az aigateway model-provider create \
  -g "$RG" --gateway-name "$GATEWAY" --name "$PROVIDER" \
  --foundry-resource-id "$FOUNDRY_RESOURCE_ID"

az aigateway model-provider sync \
  -g "$RG" --gateway-name "$GATEWAY" --name "$PROVIDER" \
  --create-default-aliases --yes

2. Weighted & priority model alias routing

Create an alias (chat-production, callable by clients as contoso/chat) that splits traffic 50/50 across two registered backend models at priority=0, weight=1:

az aigateway model-alias create \
  -g "$RG" --gateway-name "$GATEWAY" -n chat-production --routing-name contoso/chat \
  --backend-model resource-id="$MODEL_A_ID" priority=0 weight=1 \
  --backend-model resource-id="$MODEL_B_ID" priority=0 weight=1

Rebalance traffic to a 75/25 weighted split or promote a fallback tier:

az aigateway model-alias update \
  -g "$RG" --gateway-name "$GATEWAY" -n chat-production \
  --backend-model resource-id="$MODEL_A_ID" priority=0 weight=75 \
  --backend-model resource-id="$MODEL_B_ID" priority=0 weight=25

Release Assets

Full documentation: CLI Quickstart · Command Reference

Public preview: Commands and behavior may change before general availability.

Full Changelog: cli-v1.0.0b12...cli-v1.0.0b14