az cu

Preview

Note

This reference is part of the content-understanding extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az cu command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage and use Azure Content Understanding.

Commands

Name	Description	Type	Status
az cu analyze	Process local files or HTTPS URLs and return analyzer results.	Extension	Preview
az cu analyzer	Manage Content Understanding analyzers.	Extension	Preview
az cu analyzer copy	Copy an analyzer within or across Microsoft Foundry resources.	Extension	Preview
az cu analyzer create	Create an analyzer from a JSON schema file.	Extension	Preview
az cu analyzer delete	Delete an analyzer.	Extension	Preview
az cu analyzer list	List analyzers in the Microsoft Foundry resource.	Extension	Preview
az cu analyzer schema	Author Content Understanding analyzer schemas.	Extension	Preview
az cu analyzer schema create	Create a starter schema or derive one from a local document sample.	Extension	Preview
az cu analyzer show	Show a single analyzer definition (JSON).	Extension	Preview
az cu analyzer test	Run an analyzer over local samples.	Extension	Preview
az cu analyzer validate	Validate a local analyzer schema.	Extension	Preview
az cu defaults	Manage Content Understanding model-deployment defaults.	Extension	Preview
az cu defaults set	Configure Content Understanding defaults that map models to deployments.	Extension	Preview
az cu defaults show	Show Content Understanding defaults that map models to deployments.	Extension	Preview
az cu doctor	Verify a Microsoft Foundry resource connection and Content Understanding defaults.	Extension	Preview
az cu env-var	Inspect recognized CU environment-variable names safely.	Extension	Preview
az cu env-var list	List recognized environment variables that are currently set.	Extension	Preview
az cu infra	Generate infrastructure-as-code for Content Understanding.	Extension	Preview
az cu infra _models	Configure model deployments for a generated infrastructure project.	Extension	Preview
az cu infra _postprovision-v1	Complete generated-project setup after azd provisioning.	Extension	Preview
az cu infra generate	Generate an azd/Bicep project for Content Understanding.	Extension	Preview
az cu profile	Manage CU profiles stored atomically in Azure CLI configuration.	Extension	Preview
az cu profile copy	Copy a CU CLI profile to a new name.	Extension	Preview
az cu profile create	Create an empty named CU CLI profile without activating it.	Extension	Preview
az cu profile delete	Delete an inactive named CU CLI profile.	Extension	Preview
az cu profile get	Print one saved CU CLI profile value.	Extension	Preview
az cu profile list	List saved CU CLI profiles and identify the active CU CLI profile.	Extension	Preview
az cu profile rename	Rename a CU CLI profile while preserving its values and active state.	Extension	Preview
az cu profile set	Set one saved CU CLI profile value.	Extension	Preview
az cu profile set-active	Select the active CU CLI profile.	Extension	Preview
az cu profile show	Show the effective CU CLI profile with secrets redacted.	Extension	Preview
az cu profile sync-defaults	Refresh a profile's model mappings from Content Understanding defaults.	Extension	Preview
az cu profile unset	Remove one explicitly saved CU CLI profile value.	Extension	Preview

az cu analyze

Preview

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

Process local files or HTTPS URLs and return analyzer results.

az cu analyze [--acquire-policy-token]
              [--analyzer]
              [--api-key]
              [--api-version]
              [--auth-mode {key, login}]
              [--change-reference]
              [--concurrency]
              [--dry-run]
              [--endpoint]
              [--file]
              [--inline]
              [--llm-input]
              [--on-existing {error, reanalyze, skip}]
              [--output-dir]
              [--output-file]
              [--pattern]
              [--profile]
              [--recursive]
              [--report-file]
              [--source]
              [--url]
              [--usage]
              [--yes]

Examples

Analyze an invoice with an explicit analyzer and endpoint.

az cu analyze --file invoice.pdf --analyzer prebuilt-invoice --endpoint https://contoso.services.ai.azure.com/

Analyze a file using defaults from the active CU profile.

az cu analyze --file invoice.pdf

Select extracted fields using JMESPath.

az cu analyze --file invoice.pdf --query "contents[0].fields"

Analyze an HTTPS or Azure Blob SAS URL.

az cu analyze --url "https://storage.example/container/invoice.pdf?<sas>" --analyzer prebuilt-invoice

Analyze a directory recursively and write results under one directory.

az cu analyze --source documents --recursive --output-dir results --analyzer prebuilt-document --yes

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

--analyzer -a

Analyzer name; defaults to the configured default analyzer.

--api-key

Microsoft Foundry resource API key.

--api-version

Content Understanding service API version.

--auth-mode

Authentication mode.

Property	Value
Accepted values:	key, login

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--concurrency -j

Concurrent analysis jobs.

Property	Value
Default value:	4

--dry-run

Display the local execution plan without service calls or writes.

Property	Value
Default value:	False

--endpoint

Microsoft Foundry resource endpoint for Content Understanding.

--file

Literal local file. Repeat for multiple files.

--inline -i

Use preview synchronous analysis.

Property	Value
Default value:	False

--llm-input

Return the analyzer result formatted as generative AI model input.

Property	Value
Default value:	False

--on-existing

How to handle existing result files.

Property	Value
Accepted values:	error, reanalyze, skip

--output-dir -d

Write results under this directory, preserving source-relative paths.

--output-file

Write the primary payload for one selected file.

--pattern

Python fnmatch pattern applied to every --source.

--profile

CU CLI profile used to resolve endpoint and API-version defaults.

--recursive -r

Recurse into selected directories.

Property	Value
Default value:	False

--report-file

Write a standalone JSON status report.

--source

Local source directory. Repeat for multiple directories.

--url

HTTPS or Azure Blob SAS URL. Repeat for multiple URLs.

--usage

Include service usage details.

Property	Value
Default value:	False

--yes -y

Skip discovery confirmation.

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 cu doctor

Preview

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

Verify a Microsoft Foundry resource connection and Content Understanding defaults.

az cu doctor [--acquire-policy-token]
             [--api-key]
             [--api-version]
             [--auth-mode {key, login}]
             [--change-reference]
             [--endpoint]
             [--fix-defaults]
             [--profile]

Examples

Check the active profile and resource defaults.

az cu doctor --output table