@datafire/azure_machinelearningservices_artifact v3.0.0
@datafire/azure_machinelearningservices_artifact
Client library for Artifact
Installation and Usage
npm install --save @datafire/azure_machinelearningservices_artifact
let azure_machinelearningservices_artifact = require('@datafire/azure_machinelearningservices_artifact').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Actions
Artifacts_BatchGetById
Get Batch Artifacts by the specific Ids.
azure_machinelearningservices_artifact.Artifacts_BatchGetById({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"artifactIds": {
"artifactIds": []
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - artifactIds required ArtifactIdList
- subscriptionId required
Output
Artifacts_Create
Create an Artifact.
azure_machinelearningservices_artifact.Artifacts_Create({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"artifact": {
"origin": "",
"container": "",
"path": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - artifact required Artifact
- subscriptionId required
Output
- output Artifact
Artifacts_Register
Create an Artifact for an existing dataPath.
azure_machinelearningservices_artifact.Artifacts_Register({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"artifact": {
"origin": "",
"container": "",
"path": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - artifact required Artifact
- subscriptionId required
Output
- output Artifact
Artifacts_BatchGetStorageById
Get Batch Artifacts storage by specific Ids.
azure_machinelearningservices_artifact.Artifacts_BatchGetStorageById({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"artifactIds": {
"artifactIds": []
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - artifactIds required ArtifactIdList
- subscriptionId required
Output
Artifacts_ListInContainer
Get Artifacts metadata in a specific container or path.
azure_machinelearningservices_artifact.Artifacts_ListInContainer({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path. - continuationToken
string
: The continuation token.
- subscriptionId required
Output
- output PaginatedArtifactList
Artifacts_DeleteMetaDataInContainer
Delete Artifact Metadata in a specific container.
azure_machinelearningservices_artifact.Artifacts_DeleteMetaDataInContainer({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - hardDelete
boolean
: If set to true. The delete cannot be revert at later time.
- subscriptionId required
Output
Output schema unknown
Artifacts_BatchIngestFromSas
Ingest Batch Artifacts using shared access signature.
azure_machinelearningservices_artifact.Artifacts_BatchIngestFromSas({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": "",
"artifactContainerSas": {
"containerSas": "",
"containerUri": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - artifactContainerSas required ArtifactContainerSas
- subscriptionId required
Output
- output PaginatedArtifactList
Artifacts_BatchCreateEmptyArtifacts
Create a Batch of empty Artifacts from the supplied paths.
azure_machinelearningservices_artifact.Artifacts_BatchCreateEmptyArtifacts({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": "",
"artifactPaths": {
"paths": []
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - artifactPaths required ArtifactPathList
- subscriptionId required
Output
Artifacts_DeleteBatchMetaData
Delete a Batch of Artifact Metadata.
azure_machinelearningservices_artifact.Artifacts_DeleteBatchMetaData({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": "",
"artifactPaths": {
"paths": []
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - artifactPaths required ArtifactPathList
- hardDelete
boolean
: If set to true, the delete cannot be reverted at a later time.
- subscriptionId required
Output
Output schema unknown
Artifacts_Download
Get Artifact content of a specific Id.
azure_machinelearningservices_artifact.Artifacts_Download({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path.
- subscriptionId required
Output
- output
file
Artifacts_Upload
Upload content to an Artifact.
azure_machinelearningservices_artifact.Artifacts_Upload({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": "",
"content": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path. - index
integer
: The index. - append
boolean
: Whether or not to append the content or replace it. - allowOverwrite
boolean
: whether to allow overwrite if Artifact Content exist already. when set to true, Overwrite happens if Artifact Content already exists - content required
string
- subscriptionId required
Output
- output Artifact
Artifacts_GetContentInformation
Get content information of an Artifact.
azure_machinelearningservices_artifact.Artifacts_GetContentInformation({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path.
- subscriptionId required
Output
- output ArtifactContentInformation
Artifacts_GetStorageContentInformation
Get storage content information of an Artifact.
azure_machinelearningservices_artifact.Artifacts_GetStorageContentInformation({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path.
- subscriptionId required
Output
- output ArtifactContentInformation
Artifacts_DeleteMetaData
Delete an Artifact Metadata.
azure_machinelearningservices_artifact.Artifacts_DeleteMetaData({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path. - hardDelete
boolean
: If set to true. The delete cannot be revert at later time.
- subscriptionId required
Output
Output schema unknown
Artifacts_Get
Get Artifact metadata for a specific Id.
azure_machinelearningservices_artifact.Artifacts_Get({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": "",
"path": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path required
string
: The Artifact Path.
- subscriptionId required
Output
- output Artifact
Artifacts_ListSasByPrefix
Get shared access signature for an Artifact in specific path.
azure_machinelearningservices_artifact.Artifacts_ListSasByPrefix({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path. - continuationToken
string
: The continuation token.
- subscriptionId required
Output
Artifacts_ListStorageUriByPrefix
Get storage Uri for Artifacts in a specific path.
azure_machinelearningservices_artifact.Artifacts_ListStorageUriByPrefix({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path. - continuationToken
string
: The continuation token.
- subscriptionId required
Output
Artifacts_GetSas
Get writable shared access signature for a specific Artifact.
azure_machinelearningservices_artifact.Artifacts_GetSas({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceName": "",
"origin": "",
"container": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure Subscription ID. - resourceGroupName required
string
: The Name of the resource group in which the workspace is located. - workspaceName required
string
: The name of the workspace. - origin required
string
: The origin of the Artifact. - container required
string
: The container name. - path
string
: The Artifact Path.
- subscriptionId required
Output
- output ArtifactContentInformation
Definitions
Artifact
- Artifact
object
: Details of an Artifact.- artifactId
string
: The identifier of an Artifact. Format of ArtifactId - {Origin}/{Container}/{Path}. - container required
string
: The name of container. Artifacts can be grouped by container. - createdTime
string
: The Date and Time at which the Artifact is created. The DateTime is in UTC. - dataPath DataPath
- etag
string
: The Etag of the Artifact. - origin required
string
: The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset' and 'Unknown'. - path required
string
: The path to the Artifact in a container.
- artifactId
ArtifactContainerSas
- ArtifactContainerSas
object
: Details of the Artifact Container's shared access signature.- artifactPrefix
string
: The Prefix to the Artifact in the Blob. - containerSas required
string
: The shared access signature of the Container. - containerUri required
string
: The URI of the Container. - prefix
string
: The Prefix to the Blobs in the Container.
- artifactPrefix
ArtifactContentInformation
- ArtifactContentInformation
object
: Details of an Artifact Content Information.- container
string
: The name of container. Artifacts can be grouped by container. - contentUri
string
: The URI of the content. - origin
string
: The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset', 'ComputeRecord', 'Metric', and 'Unknown'. - path
string
: The path to the Artifact in a container.
- container
ArtifactIdList
- ArtifactIdList
object
: Contains list of Artifact Ids.- artifactIds required
array
: List of Artifacts Ids.- items
string
- items
- artifactIds required
ArtifactPath
- ArtifactPath
object
: Details of an Artifact Path.- path required
string
: The path to the Artifact in a container.
- path required
ArtifactPathList
- ArtifactPathList
object
: Contains list of Artifact Paths.- paths required
array
: List of Artifact Paths.- items ArtifactPath
- paths required
BatchArtifactContentInformationResult
- BatchArtifactContentInformationResult
object
: Results of the Batch Artifact Content Information request.- artifactContentInformation
object
: Artifact Content Information details of the Artifact Ids requested. - artifacts
object
: Artifact details of the Artifact Ids requested. - errors
object
: Errors occurred while fetching the requested Artifact Ids.
- artifactContentInformation
DataPath
- DataPath
object
- dataStoreName
string
- relativePath
string
- sqlDataPath SqlDataPath
- dataStoreName
ErrorDetails
- ErrorDetails
object
: The error details.- code
string
: The error code. - message
string
: The error message. - target
string
: The target of the error (e.g., the name of the property in error).
- code
ErrorResponse
- ErrorResponse
object
: The error response.- correlation
object
: Dictionary containing correlation details for the error. - environment
string
: The hosting environment. - error RootError
- location
string
: The Azure region. - time
string
: The time in UTC.
- correlation
InnerErrorResponse
- InnerErrorResponse
object
: A nested structure of errors.- code
string
: The error code. - innerError InnerErrorResponse
- code
PaginatedArtifactContentInformationList
- PaginatedArtifactContentInformationList
object
: A paginated list of ArtifactContentInformations.- continuationToken
string
: The token used in retrieving the next page. If null, there are no additional pages. - nextLink
string
: The link to the next page constructed using the continuationToken. If null, there are no additional pages. - value
array
: An array of objects of type ArtifactContentInformation.
- continuationToken
PaginatedArtifactList
- PaginatedArtifactList
object
: A paginated list of Artifacts.- continuationToken
string
: The token used in retrieving the next page. If null, there are no additional pages. - nextLink
string
: The link to the next page constructed using the continuationToken. If null, there are no additional pages. - value
array
: An array of objects of type Artifact.- items Artifact
- continuationToken
RootError
- RootError
object
: The root error.- code
string
: The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled. - details
array
: The related errors that occurred during the request.- items ErrorDetails
- innerError InnerErrorResponse
- message
string
: A human-readable representation of the error. - target
string
: The target of the error (e.g., the name of the property in error).
- code
SqlDataPath
- SqlDataPath
object
- sqlQuery
string
- sqlStoredProcedureName
string
- sqlStoredProcedureParams
array
- items StoredProcedureParameter
- sqlTableName
string
- sqlQuery
StoredProcedureParameter
- StoredProcedureParameter
object
- name
string
- type
string
(values: String, Int, Decimal, Guid, Boolean, Date) - value
string
- name
5 years ago