MachineLearningWorkspaceResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class representing a MachineLearningWorkspace along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a MachineLearningWorkspaceResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetMachineLearningWorkspaces method.
public class MachineLearningWorkspaceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.MachineLearning.MachineLearningWorkspaceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.MachineLearning.MachineLearningWorkspaceData>
public class MachineLearningWorkspaceResource : Azure.ResourceManager.ArmResource
type MachineLearningWorkspaceResource = class
inherit ArmResource
interface IJsonModel<MachineLearningWorkspaceData>
interface IPersistableModel<MachineLearningWorkspaceData>
type MachineLearningWorkspaceResource = class
inherit ArmResource
Public Class MachineLearningWorkspaceResource
Inherits ArmResource
Implements IJsonModel(Of MachineLearningWorkspaceData), IPersistableModel(Of MachineLearningWorkspaceData)
Public Class MachineLearningWorkspaceResource
Inherits ArmResource
- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| MachineLearningWorkspaceResource() |
Initializes a new instance of MachineLearningWorkspaceResource for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource. |
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource. |
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, Nullable<Boolean>, CancellationToken) |
Deletes a machine learning workspace.
|
| DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Deletes a machine learning workspace.
|
| Diagnose(WaitUntil, MachineLearningWorkspaceDiagnoseContent, CancellationToken) |
Diagnose workspace setup issue.
|
| DiagnoseAsync(WaitUntil, MachineLearningWorkspaceDiagnoseContent, CancellationToken) |
Diagnose workspace setup issue.
|
| Get(CancellationToken) |
Gets the properties of the specified machine learning workspace.
|
| GetAsync(CancellationToken) |
Gets the properties of the specified machine learning workspace.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetCapabilityHost(String, CancellationToken) |
Get capabilityHost. |
| GetCapabilityHostAsync(String, CancellationToken) |
Get capabilityHost. |
| GetCapabilityHosts() |
Gets a collection of CapabilityHosts in the MachineLearningWorkspaceResource. |
| GetKeys(CancellationToken) |
Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
|
| GetKeysAsync(CancellationToken) |
Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
|
| GetMachineLearningBatchEndpoint(String, CancellationToken) |
Gets a batch inference endpoint by name. |
| GetMachineLearningBatchEndpointAsync(String, CancellationToken) |
Gets a batch inference endpoint by name. |
| GetMachineLearningBatchEndpoints() |
Gets a collection of MachineLearningBatchEndpoints in the MachineLearningWorkspaceResource. |
| GetMachineLearningCodeContainer(String, CancellationToken) |
Gets a code container. |
| GetMachineLearningCodeContainerAsync(String, CancellationToken) |
Gets a code container. |
| GetMachineLearningCodeContainers() |
Gets a collection of MachineLearningCodeContainerResources in the MachineLearningWorkspaceResource. |
| GetMachineLearningComponentContainer(String, CancellationToken) |
Gets a component container. |
| GetMachineLearningComponentContainerAsync(String, CancellationToken) |
Gets a component container. |
| GetMachineLearningComponentContainers() |
Gets component containers. |
| GetMachineLearningCompute(String, CancellationToken) |
Gets a compute resource. |
| GetMachineLearningComputeAsync(String, CancellationToken) |
Gets a compute resource. |
| GetMachineLearningComputes() |
Gets compute resources. |
| GetMachineLearningDataContainer(String, CancellationToken) |
Gets a data container. |
| GetMachineLearningDataContainerAsync(String, CancellationToken) |
Gets a data container. |
| GetMachineLearningDataContainers() |
Gets data containers. |
| GetMachineLearningDatastore(String, CancellationToken) |
Get datastore. |
| GetMachineLearningDatastoreAsync(String, CancellationToken) |
Get datastore. |
| GetMachineLearningDatastores() |
Gets a collection of MachineLearningDatastores in the MachineLearningWorkspaceResource. |
| GetMachineLearningEnvironmentContainer(String, CancellationToken) |
Gets an environment container. |
| GetMachineLearningEnvironmentContainerAsync(String, CancellationToken) |
Gets an environment container. |
| GetMachineLearningEnvironmentContainers() |
Gets environment containers. |
| GetMachineLearningFeatureSetContainer(String, CancellationToken) |
Get container. |
| GetMachineLearningFeatureSetContainerAsync(String, CancellationToken) |
Get container. |
| GetMachineLearningFeatureSetContainers() |
Gets a collection of MachineLearningFeatureSetContainers in the MachineLearningWorkspaceResource. |
| GetMachineLearningFeatureStoreEntityContainer(String, CancellationToken) |
Get container. |
| GetMachineLearningFeatureStoreEntityContainerAsync(String, CancellationToken) |
Get container. |
| GetMachineLearningFeatureStoreEntityContainers() |
Gets a collection of MachineLearningFeatureStoreEntityContainers in the MachineLearningWorkspaceResource. |
| GetMachineLearningJob(String, CancellationToken) |
Gets a job. |
| GetMachineLearningJobAsync(String, CancellationToken) |
Gets a job. |
| GetMachineLearningJobs() |
Gets jobs. |
| GetMachineLearningLabelingJob(String, Nullable<Boolean>, Nullable<Boolean>, CancellationToken) |
Gets a labeling job by name/id.
|
| GetMachineLearningLabelingJobAsync(String, Nullable<Boolean>, Nullable<Boolean>, CancellationToken) |
Gets a labeling job by name/id.
|
| GetMachineLearningLabelingJobs() |
Gets a collection of MachineLearningLabelingJobResources in the MachineLearningWorkspace. |
| GetMachineLearningMarketplaceSubscription(String, CancellationToken) |
Get container. |
| GetMachineLearningMarketplaceSubscriptionAsync(String, CancellationToken) |
Get container. |
| GetMachineLearningMarketplaceSubscriptions() |
Gets a collection of MachineLearningMarketplaceSubscriptions in the MachineLearningWorkspaceResource. |
| GetMachineLearningModelContainer(String, CancellationToken) |
Gets a model container. |
| GetMachineLearningModelContainerAsync(String, CancellationToken) |
Gets a model container. |
| GetMachineLearningModelContainers() |
Gets model containers. |
| GetMachineLearningOnlineEndpoint(String, CancellationToken) |
Get Online Endpoint. |
| GetMachineLearningOnlineEndpointAsync(String, CancellationToken) |
Get Online Endpoint. |
| GetMachineLearningOnlineEndpoints() |
Gets a collection of MachineLearningOnlineEndpoints in the MachineLearningWorkspaceResource. |
| GetMachineLearningOutboundRuleBasic(String, CancellationToken) |
Gets an outbound rule from the managed network of a machine learning workspace. |
| GetMachineLearningOutboundRuleBasicAsync(String, CancellationToken) |
Gets an outbound rule from the managed network of a machine learning workspace. |
| GetMachineLearningOutboundRuleBasics() |
Gets a collection of MachineLearningOutboundRuleBasics in the MachineLearningWorkspaceResource. |
| GetMachineLearningPrivateEndpointConnection(String, CancellationToken) |
Called by end-users to get a PE connection. |
| GetMachineLearningPrivateEndpointConnectionAsync(String, CancellationToken) |
Called by end-users to get a PE connection. |
| GetMachineLearningPrivateEndpointConnections() |
Gets a collection of MachineLearningPrivateEndpointConnections in the MachineLearningWorkspaceResource. |
| GetMachineLearningSchedule(String, CancellationToken) |
Get schedule. |
| GetMachineLearningScheduleAsync(String, CancellationToken) |
Get schedule. |
| GetMachineLearningSchedules() |
Gets a collection of MachineLearningSchedules in the MachineLearningWorkspaceResource. |
| GetMachineLearningServerlessEndpoint(String, CancellationToken) |
Get Serverless Endpoint. |
| GetMachineLearningServerlessEndpointAsync(String, CancellationToken) |
Get Serverless Endpoint. |
| GetMachineLearningServerlessEndpoints() |
Gets a collection of MachineLearningServerlessEndpoints in the MachineLearningWorkspaceResource. |
| GetMachineLearningWorkspaceConnection(String, CancellationToken) |
Gets a workspace connection. |
| GetMachineLearningWorkspaceConnectionAsync(String, CancellationToken) |
Gets a workspace connection. |
| GetMachineLearningWorkspaceConnections() |
Gets workspace connections. |
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetNotebookAccessToken(CancellationToken) |
Get Azure Machine Learning Workspace notebook access token
|
| GetNotebookAccessTokenAsync(CancellationToken) |
Get Azure Machine Learning Workspace notebook access token
|
| GetNotebookKeys(CancellationToken) |
Lists keys of Azure Machine Learning Workspaces notebook.
|
| GetNotebookKeysAsync(CancellationToken) |
Lists keys of Azure Machine Learning Workspaces notebook.
|
| GetOutboundNetworkDependenciesEndpoints(CancellationToken) |
Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. |
| GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken) |
Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetPrivateLinkResources(CancellationToken) |
Called by Client (Portal, CLI, etc) to get available "private link resources" for the workspace. Each "private link resource" is a connection endpoint (IP address) to the resource. Pre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution. Other RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc. Defined in the "[NRP] Private Endpoint Design" doc, topic "GET API for GroupIds".
|
| GetPrivateLinkResourcesAsync(CancellationToken) |
Called by Client (Portal, CLI, etc) to get available "private link resources" for the workspace. Each "private link resource" is a connection endpoint (IP address) to the resource. Pre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution. Other RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc. Defined in the "[NRP] Private Endpoint Design" doc, topic "GET API for GroupIds".
|
| GetStorageAccountKeys(CancellationToken) |
Lists keys of Azure Machine Learning Workspace's storage account.
|
| GetStorageAccountKeysAsync(CancellationToken) |
Lists keys of Azure Machine Learning Workspace's storage account.
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| GetWorkspaceFeatures(CancellationToken) |
Lists all enabled features for a workspace
|
| GetWorkspaceFeaturesAsync(CancellationToken) |
Lists all enabled features for a workspace
|
| PrepareNotebook(WaitUntil, CancellationToken) |
Prepare Azure Machine Learning Workspace's notebook resource
|
| PrepareNotebookAsync(WaitUntil, CancellationToken) |
Prepare Azure Machine Learning Workspace's notebook resource
|
| ProvisionManagedNetwork(WaitUntil, ManagedNetworkProvisionContent, CancellationToken) |
Provisions the managed network of a machine learning workspace.
|
| ProvisionManagedNetworkAsync(WaitUntil, ManagedNetworkProvisionContent, CancellationToken) |
Provisions the managed network of a machine learning workspace.
|
| ProvisionManagedNetworkManagedNetworkProvision(WaitUntil, ManagedNetworkProvisionContent, CancellationToken) |
Provisions the managed network. |
| ProvisionManagedNetworkManagedNetworkProvisionAsync(WaitUntil, ManagedNetworkProvisionContent, CancellationToken) |
Provisions the managed network. |
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| ResyncKeys(WaitUntil, CancellationToken) |
Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry
|
| ResyncKeysAsync(WaitUntil, CancellationToken) |
Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry
|
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, MachineLearningWorkspacePatch, CancellationToken) |
Updates a machine learning workspace with the specified parameters.
|
| UpdateAsync(WaitUntil, MachineLearningWorkspacePatch, CancellationToken) |
Updates a machine learning workspace with the specified parameters.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<MachineLearningWorkspaceData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<MachineLearningWorkspaceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<MachineLearningWorkspaceData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<MachineLearningWorkspaceData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<MachineLearningWorkspaceData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |