Share via

az ml feature-store-entity

  • Reference

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 feature-store-entity command. Learn more about extensions.

Manage Azure ML feature store entities.

A collection of feature store entities on a source.

Commands

Name Description Type Status
az ml feature-store-entity archive

Archive a feature store entity.

 Extension GA
az ml feature-store-entity create

Create a feature store entity.

 Extension GA
az ml feature-store-entity list

List feature store entity in a feature store.

 Extension GA
az ml feature-store-entity restore

Restore an archived feature store entity.

 Extension GA
az ml feature-store-entity show

Shows details for a feature store entity.

 Extension GA
az ml feature-store-entity update

Update a feature store entity.

 Extension GA

az ml feature-store-entity archive

Archive a feature store entity.

Archiving a feature store entity will hide it by default from list queries (az ml feature-store-entity list).

az ml feature-store-entity archive --name
                                   --version
                                   [--feature-store-name]
                                   [--resource-group]
                                   [--workspace-name]
                                   [--yes]

Examples

Archive a specific feature store entity version

az ml feature-store-entity archive --name my-feature-store-entity --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature store entity.

--version -v

Version of the feature store entity.

Optional Parameters

--feature-store-name

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

--resource-group -g

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

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

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

--yes -y

Do not prompt for confirmation.

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 feature-store-entity create

Create a feature store entity.

Feature-store entities can be defined from files on your local machine. The created feature store entity will be tracked in the feature store under the specified name and version.

To create a feature store entity from file(s) on your local machine, specify the 'path' field in your YAML config. Azure ML will upload these file(s) to the blob container that backs the feature store's default datastore (named 'workspaceblobstore'). The created feature store entity will then point to that uploaded feature store entity.

az ml feature-store-entity create [--description]
                                  [--feature-store-name]
                                  [--file]
                                  [--name]
                                  [--no-wait]
                                  [--resource-group]
                                  [--set]
                                  [--version]
                                  [--workspace-name]

Examples

Create a feature store entity from a YAML specification file

az ml feature-store-entity create --file feature-store-entity.yml --resource-group my-resource-group --feature-store-name my-feature-store

Optional Parameters

--description -d

Description of the feature store entity.

--feature-store-name

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

--file -f

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

--name -n

Name of the feature store entity.

--no-wait

Do not wait for feature store entity creation to finish.

Default value: False
--resource-group -g

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

--set

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

--version -v

Version of the feature store entity.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<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.

az ml feature-store-entity list

List feature store entity in a feature store.

az ml feature-store-entity list [--archived-only]
                                [--feature-store-name]
                                [--include-archived]
                                [--max-results]
                                [--name]
                                [--resource-group]
                                [--workspace-name]

Examples

List all the feature store entity in a feature store

az ml feature-store-entity list --resource-group my-resource-group --feature-store-name my-feature-store

List all the feature store entity versions for the specified name in a feature store

az ml feature-store-entity list --name my-feature-store-entity --resource-group my-resource-group --feature-store-name my-feature-store

List all the feature store entity assets in a feature store using --query argument to execute a JMESPath query on the results of commands.

az ml feature-store-entity list --query "[].{Name:name}" --output table --resource-group my-resource-group --feature-store-name my-feature-store

Optional Parameters

--archived-only

List archived feature store entity assets only.

Default value: False
--feature-store-name

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

--include-archived

List archived feature store entity assets and active feature store entity assets.

Default value: False
--max-results -r

Max number of results to return.

--name -n

Name of the feature store entity. If provided, all the feature store entity versions under this name will be returned.

--resource-group -g

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

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<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.

az ml feature-store-entity restore

Restore an archived feature store entity.

When an archived featurestore-entity is restored, it will no longer be hidden from list queries (az ml feature-store-entity list).

az ml feature-store-entity restore --name
                                   --version
                                   [--feature-store-name]
                                   [--resource-group]
                                   [--workspace-name]
                                   [--yes]

Examples

Restore a specific archived feature store entity version

az ml feature-store-entity restore --name my-feature-store-entity --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature store entity.

--version -v

Version of the feature store entity.

Optional Parameters

--feature-store-name

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

--resource-group -g

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

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

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

--yes -y

Do not prompt for confirmation.

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 feature-store-entity show

Shows details for a feature store entity.

az ml feature-store-entity show --name
                                --version
                                [--feature-store-name]
                                [--resource-group]
                                [--workspace-name]

Examples

Show details for a feature store entity with the specified name and version in a feature store

az ml feature-store-entity show --name my-feature-store-entity --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature store entity.

--version -v

Version of the feature store entity.

Optional Parameters

--feature-store-name

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

--resource-group -g

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

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<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.

az ml feature-store-entity update

Update a feature store entity.

az ml feature-store-entity update --feature-store-name
                                  --name
                                  --resource-group
                                  --version
                                  --workspace-name
                                  [--add]
                                  [--force-string]
                                  [--no-wait]
                                  [--remove]
                                  [--set]

Required Parameters

--feature-store-name

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

--name -n

Name of the feature store entity.

--resource-group -g

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

--version -v

Version of the feature store entity.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--no-wait

Do not wait for feature store entity update to finish.

Default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--set

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

Default value: []
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.