az prototype config

  • Preview

Note

This reference is part of the prototype extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an az prototype config command. Learn more about extensions.

Command group 'prototype' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage prototype project configuration.

Commands

Name Description Type Status
az prototype config get

Get a single configuration value.

 Extension Preview
az prototype config init

Interactive setup to create a prototype.yaml configuration file.

 Extension Preview
az prototype config set

Set a configuration value.

 Extension Preview
az prototype config show

Display current project configuration.

 Extension Preview

az prototype config get

Preview

Command group 'prototype config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a single configuration value.

Retrieves a configuration value by its dot-separated key path. Secret values are masked as '***'.

az prototype config get [--acquire-policy-token]
                        [--change-reference]
                        [--json]
                        [--key]

Examples

Get the AI provider

az prototype config get --key ai.provider

Get the project location

az prototype config get --key project.location

Get the naming strategy

az prototype config get --key naming.strategy

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--json -j

Output machine-readable JSON instead of formatted display.

Property Value
Default value: False
--key

Configuration key to retrieve (dot-separated path, e.g., ai.provider).

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az prototype config init

Preview

Command group 'prototype config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Interactive setup to create a prototype.yaml configuration file.

Walks through standard project questions (name, region, IaC tool, naming strategy, AI provider, etc.) and generates a prototype.yaml file.

Naming strategies control how Azure resources are named:

  • microsoft-alz (default): Azure Landing Zone — {zoneid}-{type}-{service}-{env}-{region}
  • microsoft-caf: Cloud Adoption Framework — {type}-{org}-{service}-{env}-{region}-{instance}
  • simple: Quick prototypes — {org}-{service}-{type}-{env}
  • enterprise: Business unit scoped — {type}-{bu}-{org}-{service}-{env}-{region}-{instance}
  • custom: User-defined pattern

The configuration file is optional — all settings can also be provided via command-line parameters.

az prototype config init [--acquire-policy-token]
                         [--change-reference]
                         [--json]

Examples

Start interactive configuration

az prototype config init

Initialize with verbose output

az prototype config init --debug

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--json -j

Output machine-readable JSON instead of formatted display.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az prototype config set

Preview

Command group 'prototype config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Set a configuration value.

az prototype config set [--acquire-policy-token]
                        [--change-reference]
                        [--json]
                        [--key]
                        [--value]

Examples

Switch AI provider

az prototype config set --key ai.provider --value azure-openai

Change deployment location

az prototype config set --key project.location --value westus2

Switch naming strategy

az prototype config set --key naming.strategy --value microsoft-caf

Change landing zone to production

az prototype config set --key naming.zone_id --value zp

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--json -j

Output machine-readable JSON instead of formatted display.

Property Value
Default value: False
--key

Configuration key (dot-separated path, e.g., ai.provider).

--value

Configuration value to set.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az prototype config show

Preview

Command group 'prototype config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Display current project configuration.

Shows the full prototype.yaml configuration. Secret values (API keys, subscription IDs, tokens) stored in prototype.secrets.yaml are masked as '***' in the output.

az prototype config show [--json]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--json -j

Output machine-readable JSON instead of formatted display.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False