Share via

az ml feature-store

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

Manage Azure ML feature stores.

A feature store is a lifecycle management system for features. Feature store provides feature discovery, materialization serving offline workloads (training/batch inference), serving online inference with low latency requirements, and operational and feature quality monitoring.

Commands

Name Description Type Status
az ml feature-store create

Create a feature store.

 Extension GA
az ml feature-store delete

Delete a feature store.

 Extension GA
az ml feature-store list

List all the feature stores in a subscription.

 Extension GA
az ml feature-store provision-network

Provision managed network.

 Extension GA
az ml feature-store show

Show details for a feature store.

 Extension GA
az ml feature-store update

Update a feature store.

 Extension GA

az ml feature-store create

Create a feature store.

When a feature store is created, several Azure resources that will be used by Azure ML also get created by default: Azure Storage, Azure Container Registry, Azure Key Vault, and Azure Application Insights. You can instead use existing Azure resource instances for those when creating the feature store by specifying the resource IDs in the feature store configuration YAML file.

az ml feature-store create --resource-group
                           [--application-insights]
                           [--container-registry]
                           [--description]
                           [--display-name]
                           [--file]
                           [--image-build-compute]
                           [--location]
                           [--managed-network]
                           [--materialization-identity]
                           [--name]
                           [--no-wait]
                           [--not-grant-permissions]
                           [--offline-store]
                           [--primary-user-assigned-identity]
                           [--public-network-access]
                           [--set]
                           [--tags]
                           [--update-dependent-resources]

Examples

Create a feature store from a YAML specification file.

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

Required Parameters

--resource-group -g

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

Optional Parameters

--application-insights -a

ARM id of the application insights associated with this workspace.

--container-registry -c

ARM id of the container registry associated with this workspace.

--description

Description of the feature store.

--display-name

Display name for the feature store.

--file -f

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

--image-build-compute -i

The name of the compute target to use for building environment Docker images when the container registry is behind a VNet.

--location -l

The location to be used for the new feature store.

--managed-network -m

Managed Network Isolation Mode for the workspace.

--materialization-identity -t

The identity used for offline/online store connection.

--name -n

Name of the feature store.

--no-wait

Do not wait for feature store creation to finish.

Default value: False
--not-grant-permissions

Specifying --not-grant-permissions, to not grant materializtion identity permission to feature store (workspace, offline store and online store). Default is False.

Default value: False
--offline-store

Feature store offline store config. materialization-identity is needed to setup offline store.

--primary-user-assigned-identity -p

ARM identifier of primary user assigned managed identity, in case multiple ones are specified. Also the default managed identity for clusterless compute.

--public-network-access

Allow public endpoint connectivity when a workspace is private link enabled.

--set

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

--tags

Space-separated key-value pairs for the tags of the object.

--update-dependent-resources -u

Specifying --update_dependent_resources, gives your consent to update the feature store dependent resources. Updating the workspace-attached Azure Container Registry or Application Insights resource may break lineage of previous jobs, deployed inference endpoints, or your ability to rerun earlier jobs in this feature store.

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 delete

Delete a feature store.

By default the dependent resources associated with the feature store (Azure Storage, Azure Container Registry, Azure Key Vault, Azure Application Insights) are not deleted. To delete those as well, include --all-resources.

az ml feature-store delete --name
                           --resource-group
                           [--all-resources]
                           [--no-wait]
                           [--yes]

Required Parameters

--name -n

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

Optional Parameters

--all-resources

Delete all the dependent resources associated with the feature store (Azure Storage account, Azure Container Registry, Azure Application Insights, Azure Key Vault).

Default value: False
--no-wait

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

Default value: False
--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 list

List all the feature stores in a subscription.

The list of feature-stores can be filtered by resource group.

az ml feature-store list [--max-results]
                         [--resource-group]

Examples

List all the feature stores in a resource group

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

List all the feature stores using --query argument to execute a JMESPath query on the results of commands.

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

Optional Parameters

--max-results -r

Max number of results to return.

--resource-group -g

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

Provision managed network.

Triggers the feature-store to provision the managed network. Specifying spark enabled flag prepares the workspace managed network for supporting Spark. The default is false if not specified but can be enabled later by running this command again with this flag. Once enabled it cannot be disabled.

az ml feature-store provision-network --name
                                      --resource-group
                                      [--include-spark]
                                      [--no-wait]

Examples

Provision managed network.

az ml feature-store provision-network --resource-group my-resource-group --name my-feature-store-name

Required Parameters

--name -n

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

Optional Parameters

--include-spark

Boolean [true/false] for if managed network should be provisioned to account for spark jobs. The default is false if flag not set. It can be enabled later by running this command again with this flag.

Default value: False
--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 feature-store show

Show details for a feature store.

az ml feature-store show --name
                         --resource-group

Required Parameters

--name -n

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

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 update

Update a feature store.

The 'description', 'tags', 'friendly_name', and materialization_identity properties can be updated.

az ml feature-store update --name
                           --resource-group
                           [--add]
                           [--application-insights]
                           [--container-registry]
                           [--description]
                           [--display-name]
                           [--file]
                           [--force-string]
                           [--image-build-compute]
                           [--managed-network]
                           [--materialization-identity]
                           [--no-wait]
                           [--not-grant-permissions]
                           [--primary-user-assigned-identity]
                           [--public-network-access]
                           [--remove]
                           [--set]
                           [--update-dependent-resources]

Examples

update a feature store from a YAML specification file.

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

Required Parameters

--name -n

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

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: []
--application-insights -a

ARM id of the application insights associated with this workspace.

--container-registry -c

ARM id of the container registry associated with this workspace.

--description

Description of the feature store.

--display-name

Display name for the feature store.

--file -f

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

--force-string

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

Default value: False
--image-build-compute -i

The name of the compute target to use for building environment Docker images when the container registry is behind a VNet.

--managed-network -m

Managed Network Isolation Mode for the workspace.

--materialization-identity -t

The identity used for offline/online store connection.

--no-wait

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

Default value: False
--not-grant-permissions

Specifying --not-grant-permissions, to not grant materializtion identity permission to feature store (workspace, offline store and online store). Default is False.

Default value: False
--primary-user-assigned-identity -p

ARM id of the primary user assigned identity associated with this workspace.

--public-network-access

Allow public endpoint connectivity when a workspace is private link enabled.

--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: []
--update-dependent-resources -u

Specifying --update_dependent_resources, gives your consent to update the workspace dependent resources. Updating the workspace-attached Azure Container Registry or Application Insights resource may break lineage of previous jobs, deployed inference endpoints, or your ability to rerun earlier jobs in this workspace.

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.