az ml capability-host

Note

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

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

The Capability Host enables the Hub and Project to seamlessly interact with the Azure AI Agent Service.

The Capability Host on Hub/Project enables users to interact with Azure AI Agent Enterprise tools, such as File Search, Code Interpreter, and Azure Fabric Skills, while providing customers with enterprise-grade security through Bring Your Own (BYO) Storage and BYO Search Service.

Commands

Name	Description	Type	Status
az ml capability-host create	Create a capability host.	Extension	Preview
az ml capability-host delete	Delete a capability host.	Extension	Preview
az ml capability-host show	Show details of a capability host.	Extension	Preview

az ml capability-host create

Preview

Command group 'ml capability-host' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a capability host.

Azure ML capability host initiative focuses on creating a new generation of AI applications poised to revolutionize application development in the upcoming decade.

az ml capability-host create --resource-group
                             --workspace-name
                             [--ai-services-connections]
                             [--capability-host-kind]
                             [--description]
                             [--file]
                             [--name]
                             [--no-wait]
                             [--set]
                             [--storage-connections]
                             [--vector-store-connections]

Examples

Create a capability host in Hub/Project from a YAML specification file.

az ml capability-host create --file caphost.yml --resource-group my-resource-group --workspace-name my-workspace

Create a capability host in Hub.

az ml capability-host create --name my-host-name --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--ai-services-connections -a

List of Open AIServices connections names.

--capability-host-kind

Capability host kind. Default value is Agents.

Default value: Agents

--description

Description of the capability host.

--file -f

Local path to the YAML file containing the Azure ML capability-host specification. The YAML reference docs for capability-host can be found at: https://aka.ms/ml-cli-v2-capability-host-yaml-reference.

--name -n

Name of the capability host.

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

Default value: False

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=value.

--storage-connections -s

List of storage connections names.

--vector-store-connections -v

List of vector store (AISearch) connections names.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az ml capability-host delete

Preview

Command group 'ml capability-host' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a capability host.

az ml capability-host delete --name
                             --resource-group
                             --workspace-name
                             [--no-wait]

Examples

Delete a capability host. Workspace name can be either Hub or Project name.

az ml capability-host delete --resource-group my-resource-group --name my-host-name --workspace-name my-workspace

Required Parameters

--name -n

Name of the capability host.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az ml capability-host show

Preview

Command group 'ml capability-host' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a capability host.

az ml capability-host show --name
                           --resource-group
                           --workspace-name

Examples

Show details of a capability host. Workspace name can be either Hub or Project name.

az ml capability-host show --resource-group my-resource-group --name my-host-name --workspace-name my-workspace

Required Parameters

--name -n

Name of the capability host.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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