FeatureStore Class

Feature Store

Constructor

FeatureStore(*, name: str, compute_runtime: ComputeRuntime | None = None, offline_store: MaterializationStore | None = None, online_store: MaterializationStore | None = None, materialization_identity: ManagedIdentityConfiguration | None = None, description: str | None = None, tags: Dict[str, str] | None = None, display_name: str | None = None, location: str | None = None, resource_group: str | None = None, hbi_workspace: bool = False, storage_account: str | None = None, container_registry: str | None = None, key_vault: str | None = None, application_insights: str | None = None, customer_managed_key: CustomerManagedKey | None = None, image_build_compute: str | None = None, public_network_access: str | None = None, identity: IdentityConfiguration | None = None, primary_user_assigned_identity: str | None = None, managed_network: ManagedNetwork | None = None, **kwargs: Any)

Parameters

Name Description
kwargs
Required
dict

A dictionary of additional configuration parameters.

Keyword-Only Parameters

Name Description
name
str

The name of the feature store.
compute_runtime
Optional[ComputeRuntime]

The compute runtime of the feature store. Defaults to None.

Default value: None
offline_store
Optional[MaterializationStore]

The offline store for feature store. materialization_identity is required when offline_store is passed. Defaults to None.

Default value: None
online_store
Optional[MaterializationStore]

The online store for feature store. materialization_identity is required when online_store is passed. Defaults to None.

Default value: None
materialization_identity
Optional[ManagedIdentityConfiguration]

The identity used for materialization. Defaults to None.

Default value: None
description
Optional[str]

The description of the feature store. Defaults to None.

Default value: None
tags
dict

Tags of the feature store.

Default value: None
display_name
Optional[str]

The display name for the feature store. This is non-unique within the resource group. Defaults to None.

Default value: None
location
Optional[str]

The location to create the feature store in. If not specified, the same location as the resource group will be used. Defaults to None.

Default value: None
resource_group
Optional[str]

The name of the resource group to create the feature store in. Defaults to None.

Default value: None
hbi_workspace
Optional[bool]

Boolean for whether the customer data is of high business impact (HBI), containing sensitive business information. Defaults to False. For more information, see https://learn.microsoft.com/azure/machine-learning/concept-data-encryption#encryption-at-rest.

Default value: False
storage_account
Optional[str]

The resource ID of an existing storage account to use instead of creating a new one. Defaults to None.

Default value: None
container_registry
Optional[str]

The resource ID of an existing container registry to use instead of creating a new one. Defaults to None.

Default value: None
key_vault
Optional[str]

The resource ID of an existing key vault to use instead of creating a new one. Defaults to None.

Default value: None
application_insights
Optional[str]

The resource ID of an existing application insights to use instead of creating a new one. Defaults to None.

Default value: None
customer_managed_key
Optional[CustomerManagedKey]

The key vault details for encrypting data with customer-managed keys. If not specified, Microsoft-managed keys will be used by default. Defaults to None.

Default value: None
image_build_compute
Optional[str]

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

Default value: None
public_network_access
Optional[str]

Whether to allow public endpoint connectivity when a workspace is private link enabled. Defaults to None.

Default value: None
identity
Optional[IdentityConfiguration]

The workspace's Managed Identity (user assigned, or system assigned). Defaults to None.

Default value: None
primary_user_assigned_identity
Optional[str]

The workspace's primary user assigned identity. Defaults to None.

Default value: None
managed_network
Optional[ManagedNetwork]

The workspace's Managed Network configuration. Defaults to None.

Default value: None

Examples

Instantiating a Feature Store object


   from azure.ai.ml.entities import FeatureStore

   featurestore_name = "my-featurestore"
   featurestore_location = "eastus"
   featurestore = FeatureStore(name=featurestore_name, location=featurestore_location)

   # wait for featurestore creation
   fs_poller = ml_client.feature_stores.begin_create(featurestore, update_dependent_resources=True)
   print(fs_poller.result())

Methods

dump

Dump the workspace spec into a file in yaml format.

dump

Dump the workspace spec into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name Description
dest
Required
Union[<xref:PathLike>, str, IO[AnyStr]]

The destination to receive this workspace's spec. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

discovery_url

Backend service base URLs for the workspace.

Returns

Type Description
str

Backend service URLs of the workspace

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

mlflow_tracking_uri

MLflow tracking uri for the workspace.

Returns

Type Description
str

Returns mlflow tracking uri of the workspace.