az cu profile

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 profile command. Learn more about extensions.

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

Manage CU profiles stored atomically in Azure CLI configuration.

Commands

Name	Description	Type	Status
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 profile copy

Preview

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

Copy a CU CLI profile to a new name.

az cu profile copy --destination
                   [--acquire-policy-token]
                   [--change-reference]
                   [--source]

Required Parameters

--destination

New destination profile name. Use 1-64 ASCII letters or numbers, with hyphens (-) or underscores (_); 'default' and 'model_deployments' are reserved.

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

--source

Source CU CLI profile; defaults to the active CU CLI profile.

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 profile create

Preview

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

Create an empty named CU CLI profile without activating it.

az cu profile create --name
                     [--acquire-policy-token]
                     [--change-reference]

Required Parameters

--name -n

New profile name. Use 1-64 ASCII letters or numbers, with hyphens (-) or underscores (_); 'default' and 'model_deployments' are reserved.

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

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 profile delete

Preview

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

Delete an inactive named CU CLI profile.

az cu profile delete --name
                     [--acquire-policy-token]
                     [--change-reference]
                     [--yes]

Required Parameters

--name -n

Existing inactive profile to delete.

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

--yes -y

Delete without prompting for 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 profile get

Preview

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

Print one saved CU CLI profile value.

az cu profile get --key
                  [--acquire-policy-token]
                  [--change-reference]
                  [--name]

Required Parameters

--key

CU CLI profile setting key.

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

--name -n

CU CLI profile to inspect; defaults to the active CU CLI profile.

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 profile list

Preview

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

List saved CU CLI profiles and identify the active CU CLI profile.

az cu profile list

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 profile rename

Preview

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

Rename a CU CLI profile while preserving its values and active state.

az cu profile rename --destination
                     --source
                     [--acquire-policy-token]
                     [--change-reference]

Required Parameters

--destination

New profile name. Use 1-64 ASCII letters or numbers, with hyphens (-) or underscores (_); 'default' and 'model_deployments' are reserved.

--source

Existing profile name.

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

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 profile set

Preview

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

Set one saved CU CLI profile value.

az cu profile set --key
                  --value
                  [--acquire-policy-token]
                  [--change-reference]
                  [--name]

Required Parameters

--key

CU CLI profile setting key.

--value

Value to save.

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

--name -n

CU CLI profile to update; defaults to the active CU CLI profile.

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 profile set-active

Preview

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

Select the active CU CLI profile.

az cu profile set-active --name
                         [--acquire-policy-token]
                         [--change-reference]

Required Parameters

--name -n

Existing profile to activate.

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

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 profile show

Preview

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

Show the effective CU CLI profile with secrets redacted.

az cu profile show [--deployments]
                   [--name]

Optional Parameters

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

--deployments

Also list live Foundry model deployments.

Property	Value
Default value:	False

--name -n

CU CLI profile to show; defaults to the active CU CLI profile.

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 profile sync-defaults

Preview

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

Refresh a profile's model mappings from Content Understanding defaults.

az cu profile sync-defaults [--acquire-policy-token]
                            [--api-key]
                            [--auth-mode {key, login}]
                            [--change-reference]
                            [--name]

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

--api-key

Microsoft Foundry resource API key.

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

--name -n

CU CLI profile to synchronize; defaults to the active CU CLI profile.

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 profile unset

Preview

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

Remove one explicitly saved CU CLI profile value.

az cu profile unset --key
                    [--acquire-policy-token]
                    [--change-reference]
                    [--name]

Required Parameters

--key

CU CLI profile setting key.

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

--name -n

CU CLI profile to inspect; defaults to the active CU CLI profile.

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