experimentation

package
v68.0.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 19, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearning/armmachinelearning(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearning/armmachinelearning). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package experimentation implements the Azure ARM Experimentation service API version 2017-05-01-preview.

These APIs allow end users to operate on Azure Machine Learning Team Account resources. They support CRUD operations for Azure Machine Learning Team Accounts.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Experimentation
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type Account 

type Account struct {
	autorest.Response `json:"-"`
	// AccountProperties - The properties of the machine learning team account.
	*AccountProperties `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"`
}

Account an object that represents a machine learning team account.

func (Account) MarshalJSON 

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Account.

func (*Account) UnmarshalJSON 

func (a *Account) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Account struct.

type AccountListResult 

type AccountListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of machine learning team accounts. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning team accounts.
	Value *[]Account `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next list of machine learning team accounts.
	NextLink *string `json:"nextLink,omitempty"`
}

AccountListResult the result of a request to list machine learning team accounts.

func (AccountListResult) IsEmpty 

func (alr AccountListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListResultIterator 

type AccountListResultIterator struct {
	// contains filtered or unexported fields
}

AccountListResultIterator provides access to a complete listing of Account values.

func NewAccountListResultIterator 

func NewAccountListResultIterator(page AccountListResultPage) AccountListResultIterator

Creates a new instance of the AccountListResultIterator type.

func (*AccountListResultIterator) Next 

func (iter *AccountListResultIterator) 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 (*AccountListResultIterator) NextWithContext 

func (iter *AccountListResultIterator) 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 (AccountListResultIterator) NotDone 

func (iter AccountListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AccountListResultIterator) Response 

func (iter AccountListResultIterator) Response() AccountListResult

Response returns the raw server response from the last page request.

func (AccountListResultIterator) Value 

func (iter AccountListResultIterator) Value() Account

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AccountListResultPage 

type AccountListResultPage struct {
	// contains filtered or unexported fields
}

AccountListResultPage contains a page of Account values.

func NewAccountListResultPage 

func NewAccountListResultPage(cur AccountListResult, getNextPage func(context.Context, AccountListResult) (AccountListResult, error)) AccountListResultPage

Creates a new instance of the AccountListResultPage type.

func (*AccountListResultPage) Next 

func (page *AccountListResultPage) 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 (*AccountListResultPage) NextWithContext 

func (page *AccountListResultPage) 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 (AccountListResultPage) NotDone 

func (page AccountListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AccountListResultPage) Response 

func (page AccountListResultPage) Response() AccountListResult

Response returns the raw server response from the last page request.

func (AccountListResultPage) Values 

func (page AccountListResultPage) Values() []Account

Values returns the slice of values for the current page or nil if there are no values.

type AccountProperties 

type AccountProperties struct {
	// VsoAccountID - The fully qualified arm id of the vso account to be used for this team account.
	VsoAccountID *string `json:"vsoAccountId,omitempty"`
	// AccountID - READ-ONLY; The immutable id associated with this team account.
	AccountID *string `json:"accountId,omitempty"`
	// Description - The description of this workspace.
	Description *string `json:"description,omitempty"`
	// FriendlyName - The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created
	FriendlyName *string `json:"friendlyName,omitempty"`
	// KeyVaultID - The fully qualified arm id of the user key vault.
	KeyVaultID *string `json:"keyVaultId,omitempty"`
	// Seats - The no of users/seats who can access this team account. This property defines the charge on the team account.
	Seats *string `json:"seats,omitempty"`
	// DiscoveryURI - READ-ONLY; The uri for this machine learning team account.
	DiscoveryURI *string `json:"discoveryUri,omitempty"`
	// CreationDate - READ-ONLY; The creation date of the machine learning team account in ISO8601 format.
	CreationDate *date.Time `json:"creationDate,omitempty"`
	// StorageAccount - The properties of the storage account for the machine learning team account.
	StorageAccount *StorageAccountProperties `json:"storageAccount,omitempty"`
	// ProvisioningState - READ-ONLY; The current deployment state of team account resource. The provisioningState is to indicate states for resource provisioning. Possible values include: 'Creating', 'Succeeded', 'Updating', 'Deleting', 'Failed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

AccountProperties the properties of a machine learning team account.

func (AccountProperties) MarshalJSON 

func (ap AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountProperties.

type AccountPropertiesUpdateParameters 

type AccountPropertiesUpdateParameters struct {
	// Description - The description of this workspace.
	Description *string `json:"description,omitempty"`
	// FriendlyName - The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created
	FriendlyName *string `json:"friendlyName,omitempty"`
	// Seats - The no of users/seats who can access this team account. This property defines the charge on the team account.
	Seats *string `json:"seats,omitempty"`
	// StorageAccountKey - The key for storage account associated with this team account
	StorageAccountKey *string `json:"storageAccountKey,omitempty"`
}

AccountPropertiesUpdateParameters the parameters for updating the properties of a machine learning team account.

type AccountUpdateParameters 

type AccountUpdateParameters struct {
	// Tags - The resource tags for the machine learning team account.
	Tags map[string]*string `json:"tags"`
	// AccountPropertiesUpdateParameters - The properties that the machine learning team account will be updated with.
	*AccountPropertiesUpdateParameters `json:"properties,omitempty"`
}

AccountUpdateParameters the parameters for updating a machine learning team account.

func (AccountUpdateParameters) MarshalJSON 

func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON 

func (aup *AccountUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccountUpdateParameters struct.

type AccountsClient 

type AccountsClient struct {
	BaseClient
}

AccountsClient is the these APIs allow end users to operate on Azure Machine Learning Team Account resources. They support CRUD operations for Azure Machine Learning Team Accounts.

func NewAccountsClient 

func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI 

func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient

NewAccountsClientWithBaseURI creates an instance of the AccountsClient 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 (AccountsClient) CreateOrUpdate 

func (client AccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, parameters Account) (result Account, err error)

CreateOrUpdate creates or updates a team account with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account. parameters - the parameters for creating or updating a machine learning team account.

func (AccountsClient) CreateOrUpdatePreparer 

func (client AccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters Account) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AccountsClient) CreateOrUpdateResponder 

func (client AccountsClient) CreateOrUpdateResponder(resp *http.Response) (result Account, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (AccountsClient) CreateOrUpdateSender 

func (client AccountsClient) 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 (AccountsClient) Delete 

func (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)

Delete deletes a machine learning team account. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account.

func (AccountsClient) DeletePreparer 

func (client AccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder 

func (client AccountsClient) 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 (AccountsClient) DeleteSender 

func (client AccountsClient) 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 (AccountsClient) Get 

func (client AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)

Get gets the properties of the specified machine learning team account. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account.

func (AccountsClient) GetPreparer 

func (client AccountsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AccountsClient) GetResponder 

func (client AccountsClient) GetResponder(resp *http.Response) (result Account, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AccountsClient) GetSender 

func (client AccountsClient) 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 (AccountsClient) List 

func (client AccountsClient) List(ctx context.Context) (result AccountListResultPage, err error)

List lists all the available machine learning team accounts under the specified subscription.

func (AccountsClient) ListByResourceGroup 

func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AccountListResultPage, err error)

ListByResourceGroup lists all the available machine learning team accounts under the specified resource group. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs.

func (AccountsClient) ListByResourceGroupComplete 

func (client AccountsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AccountListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (AccountsClient) ListByResourceGroupPreparer 

func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder 

func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result AccountListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (AccountsClient) ListByResourceGroupSender 

func (client AccountsClient) 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 (AccountsClient) ListComplete 

func (client AccountsClient) ListComplete(ctx context.Context) (result AccountListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (AccountsClient) ListPreparer 

func (client AccountsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (AccountsClient) ListResponder 

func (client AccountsClient) ListResponder(resp *http.Response) (result AccountListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AccountsClient) ListSender 

func (client AccountsClient) 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 (AccountsClient) Update 

func (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, parameters AccountUpdateParameters) (result Account, err error)

Update updates a machine learning team account with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account. parameters - the parameters for updating a machine learning team account.

func (AccountsClient) UpdatePreparer 

func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder 

func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (AccountsClient) UpdateSender 

func (client AccountsClient) 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.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Experimentation.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

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

type ErrorResponse 

type ErrorResponse struct {
	// Code - error code
	Code *string `json:"code,omitempty"`
	// Message - error message
	Message *string `json:"message,omitempty"`
}

ErrorResponse the error response send when an operation fails.

type 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"`
}

Operation azure Machine Learning team account REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - The resource provider name: Microsoft.MachineLearningExperimentation
	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"`
}

OperationDisplay display name of operation

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of AML team account operations supported by the AML team account resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationListResult an array of operations supported by the resource provider.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the these APIs allow end users to operate on Azure Machine Learning Team Account resources. They support CRUD operations for Azure Machine Learning Team Accounts.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

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 (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)

List lists all of the available Azure Machine Learning Team Accounts REST API operations.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

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 (OperationsClient) ListSender 

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.

type Project 

type Project struct {
	autorest.Response `json:"-"`
	// ProjectProperties - The properties of the Project.
	*ProjectProperties `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"`
}

Project an object that represents a machine learning project.

func (Project) MarshalJSON 

func (p Project) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Project.

func (*Project) UnmarshalJSON 

func (p *Project) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Project struct.

type ProjectListResult 

type ProjectListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of projects. Since this list may be incomplete, the nextLink field should be used to request the next list of projects.
	Value *[]Project `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next list of projects.
	NextLink *string `json:"nextLink,omitempty"`
}

ProjectListResult the result of a request to list projects.

func (ProjectListResult) IsEmpty 

func (plr ProjectListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ProjectListResultIterator 

type ProjectListResultIterator struct {
	// contains filtered or unexported fields
}

ProjectListResultIterator provides access to a complete listing of Project values.

func NewProjectListResultIterator 

func NewProjectListResultIterator(page ProjectListResultPage) ProjectListResultIterator

Creates a new instance of the ProjectListResultIterator type.

func (*ProjectListResultIterator) Next 

func (iter *ProjectListResultIterator) 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 (*ProjectListResultIterator) NextWithContext 

func (iter *ProjectListResultIterator) 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 (ProjectListResultIterator) NotDone 

func (iter ProjectListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ProjectListResultIterator) Response 

func (iter ProjectListResultIterator) Response() ProjectListResult

Response returns the raw server response from the last page request.

func (ProjectListResultIterator) Value 

func (iter ProjectListResultIterator) Value() Project

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ProjectListResultPage 

type ProjectListResultPage struct {
	// contains filtered or unexported fields
}

ProjectListResultPage contains a page of Project values.

func NewProjectListResultPage 

func NewProjectListResultPage(cur ProjectListResult, getNextPage func(context.Context, ProjectListResult) (ProjectListResult, error)) ProjectListResultPage

Creates a new instance of the ProjectListResultPage type.

func (*ProjectListResultPage) Next 

func (page *ProjectListResultPage) 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 (*ProjectListResultPage) NextWithContext 

func (page *ProjectListResultPage) 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 (ProjectListResultPage) NotDone 

func (page ProjectListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ProjectListResultPage) Response 

func (page ProjectListResultPage) Response() ProjectListResult

Response returns the raw server response from the last page request.

func (ProjectListResultPage) Values 

func (page ProjectListResultPage) Values() []Project

Values returns the slice of values for the current page or nil if there are no values.

type ProjectProperties 

type ProjectProperties struct {
	// Description - The description of this project.
	Description *string `json:"description,omitempty"`
	// AccountID - READ-ONLY; The immutable id of the team account which contains this project.
	AccountID *string `json:"accountId,omitempty"`
	// WorkspaceID - READ-ONLY; The immutable id of the workspace which contains this project.
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// ProjectID - READ-ONLY; The immutable id of this project.
	ProjectID *string `json:"projectId,omitempty"`
	// Gitrepo - The reference to git repo for this project.
	Gitrepo *string `json:"gitrepo,omitempty"`
	// FriendlyName - The friendly name for this project.
	FriendlyName *string `json:"friendlyName,omitempty"`
	// CreationDate - READ-ONLY; The creation date of the project in ISO8601 format.
	CreationDate *date.Time `json:"creationDate,omitempty"`
	// ProvisioningState - READ-ONLY; The current deployment state of project resource. The provisioningState is to indicate states for resource provisioning. Possible values include: 'Creating', 'Succeeded', 'Updating', 'Deleting', 'Failed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

ProjectProperties the properties of a machine learning project.

func (ProjectProperties) MarshalJSON 

func (pp ProjectProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProjectProperties.

type ProjectPropertiesUpdateParameters 

type ProjectPropertiesUpdateParameters struct {
	// FriendlyName - The friendly name for this project.
	FriendlyName *string `json:"friendlyName,omitempty"`
	// Description - The description of this project.
	Description *string `json:"description,omitempty"`
	// Gitrepo - The reference to git repo for this project.
	Gitrepo *string `json:"gitrepo,omitempty"`
}

ProjectPropertiesUpdateParameters the parameters for updating the properties of a project.

type ProjectUpdateParameters 

type ProjectUpdateParameters struct {
	// Tags - The resource tags for the machine learning project.
	Tags map[string]*string `json:"tags"`
	// ProjectPropertiesUpdateParameters - The properties that the project will be updated with.
	*ProjectPropertiesUpdateParameters `json:"properties,omitempty"`
}

ProjectUpdateParameters the parameters for updating a machine learning project.

func (ProjectUpdateParameters) MarshalJSON 

func (pup ProjectUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProjectUpdateParameters.

func (*ProjectUpdateParameters) UnmarshalJSON 

func (pup *ProjectUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ProjectUpdateParameters struct.

type ProjectsClient 

type ProjectsClient struct {
	BaseClient
}

ProjectsClient is the these APIs allow end users to operate on Azure Machine Learning Team Account resources. They support CRUD operations for Azure Machine Learning Team Accounts.

func NewProjectsClient 

func NewProjectsClient(subscriptionID string) ProjectsClient

NewProjectsClient creates an instance of the ProjectsClient client.

func NewProjectsClientWithBaseURI 

func NewProjectsClientWithBaseURI(baseURI string, subscriptionID string) ProjectsClient

NewProjectsClientWithBaseURI creates an instance of the ProjectsClient 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 (ProjectsClient) CreateOrUpdate 

func (client ProjectsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string, parameters Project) (result Project, err error)

CreateOrUpdate creates or updates a project with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace. projectName - the name of the machine learning project under a team account workspace. parameters - the parameters for creating or updating a project.

func (ProjectsClient) CreateOrUpdatePreparer 

func (client ProjectsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string, parameters Project) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProjectsClient) CreateOrUpdateResponder 

func (client ProjectsClient) CreateOrUpdateResponder(resp *http.Response) (result Project, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProjectsClient) CreateOrUpdateSender 

func (client ProjectsClient) 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 (ProjectsClient) Delete 

func (client ProjectsClient) Delete(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string) (result autorest.Response, err error)

Delete deletes a project. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace. projectName - the name of the machine learning project under a team account workspace.

func (ProjectsClient) DeletePreparer 

func (client ProjectsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProjectsClient) DeleteResponder 

func (client ProjectsClient) 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 (ProjectsClient) DeleteSender 

func (client ProjectsClient) 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 (ProjectsClient) Get 

func (client ProjectsClient) Get(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string) (result Project, err error)

Get gets the properties of the specified machine learning project. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace. projectName - the name of the machine learning project under a team account workspace.

func (ProjectsClient) GetPreparer 

func (client ProjectsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProjectsClient) GetResponder 

func (client ProjectsClient) GetResponder(resp *http.Response) (result Project, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ProjectsClient) GetSender 

func (client ProjectsClient) 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 (ProjectsClient) ListByWorkspace 

func (client ProjectsClient) ListByWorkspace(ctx context.Context, accountName string, workspaceName string, resourceGroupName string) (result ProjectListResultPage, err error)

ListByWorkspace lists all the available machine learning projects under the specified workspace. Parameters: accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace. resourceGroupName - the name of the resource group to which the machine learning team account belongs.

func (ProjectsClient) ListByWorkspaceComplete 

func (client ProjectsClient) ListByWorkspaceComplete(ctx context.Context, accountName string, workspaceName string, resourceGroupName string) (result ProjectListResultIterator, err error)

ListByWorkspaceComplete enumerates all values, automatically crossing page boundaries as required.

func (ProjectsClient) ListByWorkspacePreparer 

func (client ProjectsClient) ListByWorkspacePreparer(ctx context.Context, accountName string, workspaceName string, resourceGroupName string) (*http.Request, error)

ListByWorkspacePreparer prepares the ListByWorkspace request.

func (ProjectsClient) ListByWorkspaceResponder 

func (client ProjectsClient) ListByWorkspaceResponder(resp *http.Response) (result ProjectListResult, err error)

ListByWorkspaceResponder handles the response to the ListByWorkspace request. The method always closes the http.Response Body.

func (ProjectsClient) ListByWorkspaceSender 

func (client ProjectsClient) ListByWorkspaceSender(req *http.Request) (*http.Response, error)

ListByWorkspaceSender sends the ListByWorkspace request. The method will close the http.Response Body if it receives an error.

func (ProjectsClient) Update 

func (client ProjectsClient) Update(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string, parameters ProjectUpdateParameters) (result Project, err error)

Update updates a project with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace. projectName - the name of the machine learning project under a team account workspace. parameters - the parameters for updating a machine learning team account.

func (ProjectsClient) UpdatePreparer 

func (client ProjectsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, projectName string, parameters ProjectUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ProjectsClient) UpdateResponder 

func (client ProjectsClient) UpdateResponder(resp *http.Response) (result Project, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ProjectsClient) UpdateSender 

func (client ProjectsClient) 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.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
	// Updating ...
	Updating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type 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"`
}

Resource an Azure resource.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type StorageAccountProperties 

type StorageAccountProperties struct {
	// StorageAccountID - The fully qualified arm Id of the storage account.
	StorageAccountID *string `json:"storageAccountId,omitempty"`
	// AccessKey - The access key to the storage account.
	AccessKey *string `json:"accessKey,omitempty"`
}

StorageAccountProperties the properties of a storage account for a machine learning team account.

type Workspace 

type Workspace struct {
	autorest.Response `json:"-"`
	// WorkspaceProperties - The properties of the machine learning team account workspace.
	*WorkspaceProperties `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"`
}

Workspace an object that represents a machine learning team account workspace.

func (Workspace) MarshalJSON 

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Workspace.

func (*Workspace) UnmarshalJSON 

func (w *Workspace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Workspace struct.

type WorkspaceListResult 

type WorkspaceListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of machine learning team account workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning team accounts.
	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"`
}

WorkspaceListResult the result of a request to list machine learning team account workspaces.

func (WorkspaceListResult) IsEmpty 

func (wlr WorkspaceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type WorkspaceListResultIterator 

type WorkspaceListResultIterator struct {
	// contains filtered or unexported fields
}

WorkspaceListResultIterator provides access to a complete listing of Workspace values.

func NewWorkspaceListResultIterator 

func NewWorkspaceListResultIterator(page WorkspaceListResultPage) WorkspaceListResultIterator

Creates a new instance of the WorkspaceListResultIterator type.

func (*WorkspaceListResultIterator) Next 

func (iter *WorkspaceListResultIterator) 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 (*WorkspaceListResultIterator) NextWithContext 

func (iter *WorkspaceListResultIterator) 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 (WorkspaceListResultIterator) NotDone 

func (iter WorkspaceListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (WorkspaceListResultIterator) Response 

func (iter WorkspaceListResultIterator) Response() WorkspaceListResult

Response returns the raw server response from the last page request.

func (WorkspaceListResultIterator) Value 

func (iter WorkspaceListResultIterator) Value() Workspace

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type WorkspaceListResultPage 

type WorkspaceListResultPage struct {
	// contains filtered or unexported fields
}

WorkspaceListResultPage contains a page of Workspace values.

func NewWorkspaceListResultPage 

func NewWorkspaceListResultPage(cur WorkspaceListResult, getNextPage func(context.Context, WorkspaceListResult) (WorkspaceListResult, error)) WorkspaceListResultPage

Creates a new instance of the WorkspaceListResultPage type.

func (*WorkspaceListResultPage) Next 

func (page *WorkspaceListResultPage) 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 (*WorkspaceListResultPage) NextWithContext 

func (page *WorkspaceListResultPage) 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 (WorkspaceListResultPage) NotDone 

func (page WorkspaceListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (WorkspaceListResultPage) Response 

func (page WorkspaceListResultPage) Response() WorkspaceListResult

Response returns the raw server response from the last page request.

func (WorkspaceListResultPage) Values 

func (page WorkspaceListResultPage) Values() []Workspace

Values returns the slice of values for the current page or nil if there are no values.

type WorkspaceProperties 

type WorkspaceProperties struct {
	// Description - The description of this workspace.
	Description *string `json:"description,omitempty"`
	// AccountID - READ-ONLY; The immutable id of the team account which contains this workspace.
	AccountID *string `json:"accountId,omitempty"`
	// WorkspaceID - READ-ONLY; The immutable id of this workspace.
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// FriendlyName - The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created
	FriendlyName *string `json:"friendlyName,omitempty"`
	// CreationDate - READ-ONLY; The creation date of the machine learning workspace in ISO8601 format.
	CreationDate *date.Time `json:"creationDate,omitempty"`
	// ProvisioningState - READ-ONLY; The current deployment state of team account workspace resource. The provisioningState is to indicate states for resource provisioning. Possible values include: 'Creating', 'Succeeded', 'Updating', 'Deleting', 'Failed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

WorkspaceProperties the properties of a machine learning team account workspace.

func (WorkspaceProperties) MarshalJSON 

func (wp WorkspaceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceProperties.

type WorkspacePropertiesUpdateParameters 

type WorkspacePropertiesUpdateParameters struct {
	// FriendlyName - Friendly name of this workspace.
	FriendlyName *string `json:"friendlyName,omitempty"`
	// Description - Description for this workspace.
	Description *string `json:"description,omitempty"`
}

WorkspacePropertiesUpdateParameters the parameters for updating the properties of a machine learning team account workspace.

type WorkspaceUpdateParameters 

type WorkspaceUpdateParameters struct {
	// Tags - The resource tags for the machine learning team account workspace.
	Tags map[string]*string `json:"tags"`
	// WorkspacePropertiesUpdateParameters - The properties that the machine learning workspace will be updated with.
	*WorkspacePropertiesUpdateParameters `json:"properties,omitempty"`
}

WorkspaceUpdateParameters the parameters for updating a machine learning team account workspace.

func (WorkspaceUpdateParameters) MarshalJSON 

func (wup WorkspaceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceUpdateParameters.

func (*WorkspaceUpdateParameters) UnmarshalJSON 

func (wup *WorkspaceUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WorkspaceUpdateParameters struct.

type WorkspacesClient 

type WorkspacesClient struct {
	BaseClient
}

WorkspacesClient is the these APIs allow end users to operate on Azure Machine Learning Team Account resources. They support CRUD operations for Azure Machine Learning Team Accounts.

func NewWorkspacesClient 

func NewWorkspacesClient(subscriptionID string) WorkspacesClient

NewWorkspacesClient creates an instance of the WorkspacesClient client.

func NewWorkspacesClientWithBaseURI 

func NewWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) WorkspacesClient

NewWorkspacesClientWithBaseURI creates an instance of the WorkspacesClient 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 (WorkspacesClient) CreateOrUpdate 

func (client WorkspacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, parameters Workspace) (result Workspace, err error)

CreateOrUpdate creates or updates a machine learning workspace with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the machine learning team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace. parameters - the parameters for creating or updating a machine learning workspace.

func (WorkspacesClient) CreateOrUpdatePreparer 

func (client WorkspacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, parameters Workspace) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (WorkspacesClient) CreateOrUpdateResponder 

func (client WorkspacesClient) 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 (WorkspacesClient) CreateOrUpdateSender 

func (client WorkspacesClient) 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 (WorkspacesClient) Delete 

func (client WorkspacesClient) Delete(ctx context.Context, resourceGroupName string, accountName 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 team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace.

func (WorkspacesClient) DeletePreparer 

func (client WorkspacesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (WorkspacesClient) DeleteResponder 

func (client WorkspacesClient) 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 (WorkspacesClient) DeleteSender 

func (client WorkspacesClient) 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 (WorkspacesClient) Get 

func (client WorkspacesClient) Get(ctx context.Context, resourceGroupName string, accountName 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 team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace.

func (WorkspacesClient) GetPreparer 

func (client WorkspacesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (WorkspacesClient) GetResponder 

func (client WorkspacesClient) 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 (WorkspacesClient) GetSender 

func (client WorkspacesClient) 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 (WorkspacesClient) ListByAccounts 

func (client WorkspacesClient) ListByAccounts(ctx context.Context, accountName string, resourceGroupName string) (result WorkspaceListResultPage, err error)

ListByAccounts lists all the available machine learning workspaces under the specified team account. Parameters: accountName - the name of the machine learning team account. resourceGroupName - the name of the resource group to which the machine learning team account belongs.

func (WorkspacesClient) ListByAccountsComplete 

func (client WorkspacesClient) ListByAccountsComplete(ctx context.Context, accountName string, resourceGroupName string) (result WorkspaceListResultIterator, err error)

ListByAccountsComplete enumerates all values, automatically crossing page boundaries as required.

func (WorkspacesClient) ListByAccountsPreparer 

func (client WorkspacesClient) ListByAccountsPreparer(ctx context.Context, accountName string, resourceGroupName string) (*http.Request, error)

ListByAccountsPreparer prepares the ListByAccounts request.

func (WorkspacesClient) ListByAccountsResponder 

func (client WorkspacesClient) ListByAccountsResponder(resp *http.Response) (result WorkspaceListResult, err error)

ListByAccountsResponder handles the response to the ListByAccounts request. The method always closes the http.Response Body.

func (WorkspacesClient) ListByAccountsSender 

func (client WorkspacesClient) ListByAccountsSender(req *http.Request) (*http.Response, error)

ListByAccountsSender sends the ListByAccounts request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) Update 

func (client WorkspacesClient) Update(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, parameters WorkspaceUpdateParameters) (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 team account belongs. accountName - the name of the machine learning team account. workspaceName - the name of the machine learning team account workspace. parameters - the parameters for updating a machine learning workspace.

func (WorkspacesClient) UpdatePreparer 

func (client WorkspacesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, workspaceName string, parameters WorkspaceUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (WorkspacesClient) UpdateResponder 

func (client WorkspacesClient) 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 (WorkspacesClient) UpdateSender 

func (client WorkspacesClient) 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.

Source Files

View all Source files

Directories

Path Synopsis
Deprecated: Please note, this package has been deprecated.
 Deprecated: Please note, this package has been deprecated.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.