const (
// DefaultBaseURI is the default URI used for the service Workspaces
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Workspaces.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
Client is the these APIs allow end users to operate on Azure Machine Learning Workspace resources. They support CRUD operations for Azure Machine Learning Workspaces.
type Client struct {
BaseClient
}
func NewClient(subscriptionID string) Client
NewClient creates an instance of the Client client.
func NewClientWithBaseURI(baseURI string, subscriptionID string) Client
NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, parameters Workspace) (result Workspace, err error)
CreateOrUpdate creates or updates a workspace with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the machine learning workspace belongs. workspaceName - the name of the machine learning workspace. parameters - the parameters for creating or updating a machine learning workspace.
func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, parameters Workspace) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client Client) CreateOrUpdateResponder(resp *http.Response) (result Workspace, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client Client) Delete(ctx context.Context, resourceGroupName string, workspaceName string) (result autorest.Response, err error)
Delete deletes a machine learning workspace. Parameters: resourceGroupName - the name of the resource group to which the machine learning workspace belongs. workspaceName - the name of the machine learning workspace.
func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client Client) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client Client) Get(ctx context.Context, resourceGroupName string, workspaceName string) (result Workspace, err error)
Get gets the properties of the specified machine learning workspace. Parameters: resourceGroupName - the name of the resource group to which the machine learning workspace belongs. workspaceName - the name of the machine learning workspace.
func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client Client) GetResponder(resp *http.Response) (result Workspace, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client Client) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client Client) List(ctx context.Context) (result ListResultPage, err error)
List lists all the available machine learning workspaces under the specified subscription.
func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResultPage, err error)
ListByResourceGroup lists all the available machine learning workspaces under the specified resource group. Parameters: resourceGroupName - the name of the resource group to which the machine learning workspace belongs.
func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client Client) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client Client) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client Client) ListWorkspaceKeys(ctx context.Context, workspaceName string, resourceGroupName string) (result KeysResponse, err error)
ListWorkspaceKeys list the authorization keys associated with this workspace. Parameters: workspaceName - the name of the machine learning workspace. resourceGroupName - the name of the resource group to which the machine learning workspace belongs.
func (client Client) ListWorkspaceKeysPreparer(ctx context.Context, workspaceName string, resourceGroupName string) (*http.Request, error)
ListWorkspaceKeysPreparer prepares the ListWorkspaceKeys request.
func (client Client) ListWorkspaceKeysResponder(resp *http.Response) (result KeysResponse, err error)
ListWorkspaceKeysResponder handles the response to the ListWorkspaceKeys request. The method always closes the http.Response Body.
func (client Client) ListWorkspaceKeysSender(req *http.Request) (*http.Response, error)
ListWorkspaceKeysSender sends the ListWorkspaceKeys request. The method will close the http.Response Body if it receives an error.
func (client Client) ResyncStorageKeys(ctx context.Context, workspaceName string, resourceGroupName string) (result autorest.Response, err error)
ResyncStorageKeys resync storage keys associated with this workspace. Parameters: workspaceName - the name of the machine learning workspace. resourceGroupName - the name of the resource group to which the machine learning workspace belongs.
func (client Client) ResyncStorageKeysPreparer(ctx context.Context, workspaceName string, resourceGroupName string) (*http.Request, error)
ResyncStorageKeysPreparer prepares the ResyncStorageKeys request.
func (client Client) ResyncStorageKeysResponder(resp *http.Response) (result autorest.Response, err error)
ResyncStorageKeysResponder handles the response to the ResyncStorageKeys request. The method always closes the http.Response Body.
func (client Client) ResyncStorageKeysSender(req *http.Request) (*http.Response, error)
ResyncStorageKeysSender sends the ResyncStorageKeys request. The method will close the http.Response Body if it receives an error.
func (client Client) Update(ctx context.Context, resourceGroupName string, workspaceName string, parameters UpdateParameters) (result Workspace, err error)
Update updates a machine learning workspace with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the machine learning workspace belongs. workspaceName - the name of the machine learning workspace. parameters - the parameters for updating a machine learning workspace.
func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, parameters UpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client Client) UpdateResponder(resp *http.Response) (result Workspace, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client Client) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ErrorResponse the error response send when an operation fails.
type ErrorResponse struct {
// Code - error code
Code *string `json:"code,omitempty"`
// Message - error message
Message *string `json:"message,omitempty"`
}
KeysResponse workspace authorization keys for a workspace.
type KeysResponse struct {
autorest.Response `json:"-"`
// PrimaryToken - Primary authorization key for this workspace.
PrimaryToken *string `json:"primaryToken,omitempty"`
// SecondaryToken - Secondary authorization key for this workspace.
SecondaryToken *string `json:"secondaryToken,omitempty"`
}
ListResult the result of a request to list machine learning workspace keys.
type ListResult struct {
autorest.Response `json:"-"`
// Value - The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.
Value *[]Workspace `json:"value,omitempty"`
// NextLink - The URI that can be used to request the next list of machine learning workspaces.
NextLink *string `json:"nextLink,omitempty"`
}
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListResultIterator provides access to a complete listing of Workspace values.
type ListResultIterator struct {
// contains filtered or unexported fields
}
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
func (iter *ListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
func (iter ListResultIterator) Value() Workspace
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListResultPage contains a page of Workspace values.
type ListResultPage struct {
// contains filtered or unexported fields
}
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
func (page *ListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (page ListResultPage) Values() []Workspace
Values returns the slice of values for the current page or nil if there are no values.
Operation azure Machine Learning Studio REST API operation
type Operation struct {
// Name - Operation name: {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// Display - Display name of operation
Display *OperationDisplay `json:"display,omitempty"`
}
OperationDisplay display name of operation
type OperationDisplay struct {
// Provider - The resource provider name: Microsoft.MachineLearning
Provider *string `json:"provider,omitempty"`
// Resource - The resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Operation - The operation that users can perform.
Operation *string `json:"operation,omitempty"`
// Description - The description for the operation.
Description *string `json:"description,omitempty"`
}
OperationListResult an array of operations supported by the resource provider.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - List of AML Studio operations supported by the AML Studio resource provider.
Value *[]Operation `json:"value,omitempty"`
}
OperationsClient is the these APIs allow end users to operate on Azure Machine Learning Workspace resources. They support CRUD operations for Azure Machine Learning Workspaces.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List lists all of the available Azure Machine Learning Studio REST API operations.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
Properties the properties of a machine learning workspace.
type Properties struct {
// UserStorageAccountID - The fully qualified arm id of the storage account associated with this workspace.
UserStorageAccountID *string `json:"userStorageAccountId,omitempty"`
// OwnerEmail - The email id of the owner for this workspace.
OwnerEmail *string `json:"ownerEmail,omitempty"`
// WorkspaceType - READ-ONLY; The type of this workspace. Possible values include: 'Production', 'Free', 'Anonymous', 'PaidStandard', 'PaidPremium'
WorkspaceType WorkspaceType `json:"workspaceType,omitempty"`
// WorkspaceState - READ-ONLY; The current state of workspace resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', 'Migrated', 'Updated', 'Registered', 'Unregistered'
WorkspaceState State `json:"workspaceState,omitempty"`
// WorkspaceID - READ-ONLY; The immutable id associated with this workspace.
WorkspaceID *string `json:"workspaceId,omitempty"`
// CreationTime - READ-ONLY; The creation time for this workspace resource.
CreationTime *string `json:"creationTime,omitempty"`
// StudioEndpoint - READ-ONLY; The regional endpoint for the machine learning studio service which hosts this workspace.
StudioEndpoint *string `json:"studioEndpoint,omitempty"`
// KeyVaultIdentifierID - The key vault identifier used for encrypted workspaces.
KeyVaultIdentifierID *string `json:"keyVaultIdentifierId,omitempty"`
}
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
PropertiesUpdateParameters the parameters for updating the properties of a machine learning workspace.
type PropertiesUpdateParameters struct {
// WorkspaceState - The current state of workspace resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', 'Migrated', 'Updated', 'Registered', 'Unregistered'
WorkspaceState State `json:"workspaceState,omitempty"`
// KeyVaultIdentifierID - The key vault identifier used for encrypted workspaces.
KeyVaultIdentifierID *string `json:"keyVaultIdentifierId,omitempty"`
// Sku - The sku of the workspace.
Sku *Sku `json:"sku,omitempty"`
}
Resource an Azure resource.
type Resource struct {
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource. This cannot be changed after the resource is created.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
// Sku - The sku of the workspace.
Sku *Sku `json:"sku,omitempty"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
Sku sku of the resource
type Sku struct {
// Name - Name of the sku
Name *string `json:"name,omitempty"`
// Tier - Tier of the sku like Basic or Enterprise
Tier *string `json:"tier,omitempty"`
}
State enumerates the values for state.
type State string
const (
// Deleted ...
Deleted State = "Deleted"
// Disabled ...
Disabled State = "Disabled"
// Enabled ...
Enabled State = "Enabled"
// Migrated ...
Migrated State = "Migrated"
// Registered ...
Registered State = "Registered"
// Unregistered ...
Unregistered State = "Unregistered"
// Updated ...
Updated State = "Updated"
)
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
UpdateParameters the parameters for updating a machine learning workspace.
type UpdateParameters struct {
// Tags - The resource tags for the machine learning workspace.
Tags map[string]*string `json:"tags"`
// PropertiesUpdateParameters - The properties that the machine learning workspace will be updated with.
*PropertiesUpdateParameters `json:"properties,omitempty"`
}
func (up UpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateParameters.
func (up *UpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UpdateParameters struct.
Workspace an object that represents a machine learning workspace.
type Workspace struct {
autorest.Response `json:"-"`
// Properties - The properties of the machine learning workspace.
*Properties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource. This cannot be changed after the resource is created.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
// Sku - The sku of the workspace.
Sku *Sku `json:"sku,omitempty"`
}
func (w Workspace) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Workspace.
func (w *Workspace) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Workspace struct.
WorkspaceType enumerates the values for workspace type.
type WorkspaceType string
const (
// Anonymous ...
Anonymous WorkspaceType = "Anonymous"
// Free ...
Free WorkspaceType = "Free"
// PaidPremium ...
PaidPremium WorkspaceType = "PaidPremium"
// PaidStandard ...
PaidStandard WorkspaceType = "PaidStandard"
// Production ...
Production WorkspaceType = "Production"
)
func PossibleWorkspaceTypeValues() []WorkspaceType
PossibleWorkspaceTypeValues returns an array of possible values for the WorkspaceType const type.
| Name | Synopsis |
|---|---|
| .. | |
| workspacesapi | Deprecated: Please note, this package has been deprecated. |