const (
// DefaultBaseURI is the default URI used for the service Webservices
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.
AssetItem information about an asset associated with the web service.
type AssetItem struct {
// Name - Asset's friendly name.
Name *string `json:"name,omitempty"`
// ID - Asset's Id.
ID *string `json:"id,omitempty"`
// Type - Asset's type. Possible values include: 'AssetTypeModule', 'AssetTypeResource'
Type AssetType `json:"type,omitempty"`
// LocationInfo - Access information for the asset.
LocationInfo *BlobLocation `json:"locationInfo,omitempty"`
// InputPorts - Information about the asset's input ports.
InputPorts map[string]*InputPort `json:"inputPorts"`
// OutputPorts - Information about the asset's output ports.
OutputPorts map[string]*OutputPort `json:"outputPorts"`
// Metadata - If the asset is a custom module, this holds the module's metadata.
Metadata map[string]*string `json:"metadata"`
// Parameters - If the asset is a custom module, this holds the module's parameters.
Parameters *[]ModuleAssetParameter `json:"parameters,omitempty"`
}
func (ai AssetItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AssetItem.
AssetType enumerates the values for asset type.
type AssetType string
const (
// AssetTypeModule ...
AssetTypeModule AssetType = "Module"
// AssetTypeResource ...
AssetTypeResource AssetType = "Resource"
)
func PossibleAssetTypeValues() []AssetType
PossibleAssetTypeValues returns an array of possible values for the AssetType const type.
AsyncOperationErrorInfo the error detail information for async operation
type AsyncOperationErrorInfo struct {
// Code - READ-ONLY; The error code.
Code *string `json:"code,omitempty"`
// Target - READ-ONLY; The error target.
Target *string `json:"target,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"message,omitempty"`
// Details - READ-ONLY; An array containing error information.
Details *[]AsyncOperationErrorInfo `json:"details,omitempty"`
}
func (aoei AsyncOperationErrorInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AsyncOperationErrorInfo.
AsyncOperationStatus azure async operation status.
type AsyncOperationStatus struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; Async operation id.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Async operation name.
Name *string `json:"name,omitempty"`
// ProvisioningState - READ-ONLY; Read Only: The provisioning state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', 'Failed'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// StartTime - READ-ONLY; The date time that the async operation started.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; The date time that the async operation finished.
EndTime *date.Time `json:"endTime,omitempty"`
// PercentComplete - READ-ONLY; Async operation progress.
PercentComplete *float64 `json:"percentComplete,omitempty"`
// ErrorInfo - READ-ONLY; If the async operation fails, this structure contains the error details.
ErrorInfo *AsyncOperationErrorInfo `json:"errorInfo,omitempty"`
}
func (aos AsyncOperationStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AsyncOperationStatus.
BaseClient is the base client for Webservices.
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).
BasicProperties the set of properties specific to the Azure ML web service resource.
type BasicProperties interface {
AsPropertiesForGraph() (*PropertiesForGraph, bool)
AsProperties() (*Properties, bool)
}
BlobLocation describes the access location for a blob.
type BlobLocation struct {
// URI - The URI from which the blob is accessible from. For example, aml://abc for system assets or https://xyz for user assets or payload.
URI *string `json:"uri,omitempty"`
// Credentials - Access credentials for the blob, if applicable (e.g. blob specified by storage account connection string + blob URI)
Credentials *string `json:"credentials,omitempty"`
}
Client is the these APIs allow end users to operate on Azure Machine Learning Web Services resources. They support the following operations:<ul><li>Create or update a web service</li><li>Get a web service</li><li>Patch a web service</li><li>Delete a web service</li><li>Get All Web Services in a Resource Group </li><li>Get All Web Services in a Subscription</li><li>Get Web Services Keys</li></ul>
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, webServiceName string, createOrUpdatePayload WebService) (result CreateOrUpdateFuture, err error)
CreateOrUpdate create or update a web service. This call will overwrite an existing web service. Note that there is no warning or confirmation. This is a nonrecoverable operation. If your intent is to create a new web service, call the Get operation first to verify that it does not exist. Parameters: resourceGroupName - name of the resource group in which the web service is located. webServiceName - the name of the web service. createOrUpdatePayload - the payload that is used to create or update the web service.
func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, webServiceName string, createOrUpdatePayload WebService) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client Client) CreateOrUpdateResponder(resp *http.Response) (result WebService, 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) (future CreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client Client) CreateRegionalProperties(ctx context.Context, resourceGroupName string, webServiceName string, region string) (result CreateRegionalPropertiesFuture, err error)
CreateRegionalProperties creates an encrypted credentials parameter blob for the specified region. To get the web service from a region other than the region in which it has been created, you must first call Create Regional Web Services Properties to create a copy of the encrypted credential parameter blob in that region. You only need to do this before the first time that you get the web service in the new region. Parameters: resourceGroupName - name of the resource group in which the web service is located. webServiceName - the name of the web service. region - the region for which encrypted credential parameters are created.
func (client Client) CreateRegionalPropertiesPreparer(ctx context.Context, resourceGroupName string, webServiceName string, region string) (*http.Request, error)
CreateRegionalPropertiesPreparer prepares the CreateRegionalProperties request.
func (client Client) CreateRegionalPropertiesResponder(resp *http.Response) (result AsyncOperationStatus, err error)
CreateRegionalPropertiesResponder handles the response to the CreateRegionalProperties request. The method always closes the http.Response Body.
func (client Client) CreateRegionalPropertiesSender(req *http.Request) (future CreateRegionalPropertiesFuture, err error)
CreateRegionalPropertiesSender sends the CreateRegionalProperties request. The method will close the http.Response Body if it receives an error.
func (client Client) Get(ctx context.Context, resourceGroupName string, webServiceName string, region string) (result WebService, err error)
Get gets the Web Service Definition as specified by a subscription, resource group, and name. Note that the storage credentials and web service keys are not returned by this call. To get the web service access keys, call List Keys. Parameters: resourceGroupName - name of the resource group in which the web service is located. webServiceName - the name of the web service. region - the region for which encrypted credential parameters are valid.
func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, webServiceName string, region string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client Client) GetResponder(resp *http.Response) (result WebService, 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) ListByResourceGroup(ctx context.Context, resourceGroupName string, skiptoken string) (result PaginatedWebServicesListPage, err error)
ListByResourceGroup gets the web services in the specified resource group. Parameters: resourceGroupName - name of the resource group in which the web service is located. skiptoken - continuation token for pagination.
func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, skiptoken string) (result PaginatedWebServicesListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, skiptoken string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client Client) ListByResourceGroupResponder(resp *http.Response) (result PaginatedWebServicesList, 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) ListBySubscriptionID(ctx context.Context, skiptoken string) (result PaginatedWebServicesListPage, err error)
ListBySubscriptionID gets the web services in the specified subscription. Parameters: skiptoken - continuation token for pagination.
func (client Client) ListBySubscriptionIDComplete(ctx context.Context, skiptoken string) (result PaginatedWebServicesListIterator, err error)
ListBySubscriptionIDComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListBySubscriptionIDPreparer(ctx context.Context, skiptoken string) (*http.Request, error)
ListBySubscriptionIDPreparer prepares the ListBySubscriptionID request.
func (client Client) ListBySubscriptionIDResponder(resp *http.Response) (result PaginatedWebServicesList, err error)
ListBySubscriptionIDResponder handles the response to the ListBySubscriptionID request. The method always closes the http.Response Body.
func (client Client) ListBySubscriptionIDSender(req *http.Request) (*http.Response, error)
ListBySubscriptionIDSender sends the ListBySubscriptionID request. The method will close the http.Response Body if it receives an error.
func (client Client) ListKeys(ctx context.Context, resourceGroupName string, webServiceName string) (result Keys, err error)
ListKeys gets the access keys for the specified web service. Parameters: resourceGroupName - name of the resource group in which the web service is located. webServiceName - the name of the web service.
func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, webServiceName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (client Client) ListKeysResponder(resp *http.Response) (result Keys, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
func (client Client) ListKeysSender(req *http.Request) (*http.Response, error)
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (client Client) Patch(ctx context.Context, resourceGroupName string, webServiceName string, patchPayload PatchedWebService) (result PatchFuture, err error)
Patch modifies an existing web service resource. The PATCH API call is an asynchronous operation. To determine whether it has completed successfully, you must perform a Get operation. Parameters: resourceGroupName - name of the resource group in which the web service is located. webServiceName - the name of the web service. patchPayload - the payload to use to patch the web service.
func (client Client) PatchPreparer(ctx context.Context, resourceGroupName string, webServiceName string, patchPayload PatchedWebService) (*http.Request, error)
PatchPreparer prepares the Patch request.
func (client Client) PatchResponder(resp *http.Response) (result WebService, err error)
PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.
func (client Client) PatchSender(req *http.Request) (future PatchFuture, err error)
PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.
func (client Client) Remove(ctx context.Context, resourceGroupName string, webServiceName string) (result RemoveFuture, err error)
Remove deletes the specified web service. Parameters: resourceGroupName - name of the resource group in which the web service is located. webServiceName - the name of the web service.
func (client Client) RemovePreparer(ctx context.Context, resourceGroupName string, webServiceName string) (*http.Request, error)
RemovePreparer prepares the Remove request.
func (client Client) RemoveResponder(resp *http.Response) (result autorest.Response, err error)
RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.
func (client Client) RemoveSender(req *http.Request) (future RemoveFuture, err error)
RemoveSender sends the Remove request. The method will close the http.Response Body if it receives an error.
ColumnFormat enumerates the values for column format.
type ColumnFormat string
const (
// Byte ...
Byte ColumnFormat = "Byte"
// Char ...
Char ColumnFormat = "Char"
// Complex128 ...
Complex128 ColumnFormat = "Complex128"
// Complex64 ...
Complex64 ColumnFormat = "Complex64"
// DateTime ...
DateTime ColumnFormat = "Date-time"
// DateTimeOffset ...
DateTimeOffset ColumnFormat = "Date-timeOffset"
// Double ...
Double ColumnFormat = "Double"
// Duration ...
Duration ColumnFormat = "Duration"
// Float ...
Float ColumnFormat = "Float"
// Int16 ...
Int16 ColumnFormat = "Int16"
// Int32 ...
Int32 ColumnFormat = "Int32"
// Int64 ...
Int64 ColumnFormat = "Int64"
// Int8 ...
Int8 ColumnFormat = "Int8"
// Uint16 ...
Uint16 ColumnFormat = "Uint16"
// Uint32 ...
Uint32 ColumnFormat = "Uint32"
// Uint64 ...
Uint64 ColumnFormat = "Uint64"
// Uint8 ...
Uint8 ColumnFormat = "Uint8"
)
func PossibleColumnFormatValues() []ColumnFormat
PossibleColumnFormatValues returns an array of possible values for the ColumnFormat const type.
ColumnSpecification swagger 2.0 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/
type ColumnSpecification struct {
// Type - Data type of the column. Possible values include: 'Boolean', 'Integer', 'Number', 'String'
Type ColumnType `json:"type,omitempty"`
// Format - Additional format information for the data type. Possible values include: 'Byte', 'Char', 'Complex64', 'Complex128', 'DateTime', 'DateTimeOffset', 'Double', 'Duration', 'Float', 'Int8', 'Int16', 'Int32', 'Int64', 'Uint8', 'Uint16', 'Uint32', 'Uint64'
Format ColumnFormat `json:"format,omitempty"`
// Enum - If the data type is categorical, this provides the list of accepted categories.
Enum *[]interface{} `json:"enum,omitempty"`
// XMsIsnullable - Flag indicating if the type supports null values or not.
XMsIsnullable *bool `json:"x-ms-isnullable,omitempty"`
// XMsIsordered - Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column.
XMsIsordered *bool `json:"x-ms-isordered,omitempty"`
}
ColumnType enumerates the values for column type.
type ColumnType string
const (
// Boolean ...
Boolean ColumnType = "Boolean"
// Integer ...
Integer ColumnType = "Integer"
// Number ...
Number ColumnType = "Number"
// String ...
String ColumnType = "String"
)
func PossibleColumnTypeValues() []ColumnType
PossibleColumnTypeValues returns an array of possible values for the ColumnType const type.
CommitmentPlan information about the machine learning commitment plan associated with the web service.
type CommitmentPlan struct {
// ID - Specifies the Azure Resource Manager ID of the commitment plan associated with the web service.
ID *string `json:"id,omitempty"`
}
CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (WebService, error)
}
func (future *CreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CreateRegionalPropertiesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreateRegionalPropertiesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (AsyncOperationStatus, error)
}
func (future *CreateRegionalPropertiesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiagnosticsConfiguration diagnostics settings for an Azure ML web service.
type DiagnosticsConfiguration struct {
// Level - Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr). Possible values include: 'None', 'Error', 'All'
Level DiagnosticsLevel `json:"level,omitempty"`
// Expiry - Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited.
Expiry *date.Time `json:"expiry,omitempty"`
}
DiagnosticsLevel enumerates the values for diagnostics level.
type DiagnosticsLevel string
const (
// All ...
All DiagnosticsLevel = "All"
// Error ...
Error DiagnosticsLevel = "Error"
// None ...
None DiagnosticsLevel = "None"
)
func PossibleDiagnosticsLevelValues() []DiagnosticsLevel
PossibleDiagnosticsLevelValues returns an array of possible values for the DiagnosticsLevel const type.
ExampleRequest sample input data for the service's input(s).
type ExampleRequest struct {
// Inputs - Sample input data for the web service's input(s) given as an input name to sample input values matrix map.
Inputs map[string][][]interface{} `json:"inputs"`
// GlobalParameters - Sample input data for the web service's global parameters
GlobalParameters map[string]interface{} `json:"globalParameters"`
}
func (er ExampleRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExampleRequest.
GraphEdge defines an edge within the web service's graph.
type GraphEdge struct {
// SourceNodeID - The source graph node's identifier.
SourceNodeID *string `json:"sourceNodeId,omitempty"`
// SourcePortID - The identifier of the source node's port that the edge connects from.
SourcePortID *string `json:"sourcePortId,omitempty"`
// TargetNodeID - The destination graph node's identifier.
TargetNodeID *string `json:"targetNodeId,omitempty"`
// TargetPortID - The identifier of the destination node's port that the edge connects into.
TargetPortID *string `json:"targetPortId,omitempty"`
}
GraphNode specifies a node in the web service graph. The node can either be an input, output or asset node, so only one of the corresponding id properties is populated at any given time.
type GraphNode struct {
// AssetID - The id of the asset represented by this node.
AssetID *string `json:"assetId,omitempty"`
// InputID - The id of the input element represented by this node.
InputID *string `json:"inputId,omitempty"`
// OutputID - The id of the output element represented by this node.
OutputID *string `json:"outputId,omitempty"`
// Parameters - If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime.
Parameters map[string]*Parameter `json:"parameters"`
}
func (gn GraphNode) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GraphNode.
GraphPackage defines the graph of modules making up the machine learning solution.
type GraphPackage struct {
// Nodes - The set of nodes making up the graph, provided as a nodeId to GraphNode map
Nodes map[string]*GraphNode `json:"nodes"`
// Edges - The list of edges making up the graph.
Edges *[]GraphEdge `json:"edges,omitempty"`
// GraphParameters - The collection of global parameters for the graph, given as a global parameter name to GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level.
GraphParameters map[string]*GraphParameter `json:"graphParameters"`
}
func (gp GraphPackage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GraphPackage.
GraphParameter defines a global parameter in the graph.
type GraphParameter struct {
// Description - Description of this graph parameter.
Description *string `json:"description,omitempty"`
// Type - Graph parameter's type. Possible values include: 'ParameterTypeString', 'ParameterTypeInt', 'ParameterTypeFloat', 'ParameterTypeEnumerated', 'ParameterTypeScript', 'ParameterTypeMode', 'ParameterTypeCredential', 'ParameterTypeBoolean', 'ParameterTypeDouble', 'ParameterTypeColumnPicker', 'ParameterTypeParameterRange', 'ParameterTypeDataGatewayName'
Type ParameterType `json:"type,omitempty"`
// Links - Association links for this parameter to nodes in the graph.
Links *[]GraphParameterLink `json:"links,omitempty"`
}
GraphParameterLink association link for a graph global parameter to a node in the graph.
type GraphParameterLink struct {
// NodeID - The graph node's identifier
NodeID *string `json:"nodeId,omitempty"`
// ParameterKey - The identifier of the node parameter that the global parameter maps to.
ParameterKey *string `json:"parameterKey,omitempty"`
}
InputPort asset input port
type InputPort struct {
// Type - Port data type. Possible values include: 'Dataset'
Type InputPortType `json:"type,omitempty"`
}
InputPortType enumerates the values for input port type.
type InputPortType string
const (
// Dataset ...
Dataset InputPortType = "Dataset"
)
func PossibleInputPortTypeValues() []InputPortType
PossibleInputPortTypeValues returns an array of possible values for the InputPortType const type.
Keys access keys for the web service calls.
type Keys struct {
autorest.Response `json:"-"`
// Primary - The primary access key.
Primary *string `json:"primary,omitempty"`
// Secondary - The secondary access key.
Secondary *string `json:"secondary,omitempty"`
}
MachineLearningWorkspace information about the machine learning workspace containing the experiment that is source for the web service.
type MachineLearningWorkspace struct {
// ID - Specifies the workspace ID of the machine learning workspace associated with the web service
ID *string `json:"id,omitempty"`
}
ModeValueInfo nested parameter definition.
type ModeValueInfo struct {
// InterfaceString - The interface string name for the nested parameter.
InterfaceString *string `json:"interfaceString,omitempty"`
// Parameters - The definition of the parameter.
Parameters *[]ModuleAssetParameter `json:"parameters,omitempty"`
}
ModuleAssetParameter parameter definition for a module asset.
type ModuleAssetParameter struct {
// Name - Parameter name.
Name *string `json:"name,omitempty"`
// ParameterType - Parameter type.
ParameterType *string `json:"parameterType,omitempty"`
// ModeValuesInfo - Definitions for nested interface parameters if this is a complex module parameter.
ModeValuesInfo map[string]*ModeValueInfo `json:"modeValuesInfo"`
}
func (mapVar ModuleAssetParameter) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ModuleAssetParameter.
OperationDisplayInfo the API operation info.
type OperationDisplayInfo struct {
// Description - READ-ONLY; The description of the operation.
Description *string `json:"description,omitempty"`
// Operation - READ-ONLY; The action that users can perform, based on their permission level.
Operation *string `json:"operation,omitempty"`
// Provider - READ-ONLY; The service provider.
Provider *string `json:"provider,omitempty"`
// Resource - READ-ONLY; The resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
}
func (odi OperationDisplayInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplayInfo.
OperationEntity an API operation.
type OperationEntity struct {
// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}.
Name *string `json:"name,omitempty"`
// Display - The API operation info.
Display *OperationDisplayInfo `json:"display,omitempty"`
}
func (oe OperationEntity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationEntity.
OperationEntityListResult the list of REST API operations.
type OperationEntityListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of operations.
Value *[]OperationEntity `json:"value,omitempty"`
}
func (oelr OperationEntityListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationEntityListResult.
OperationsClient is the these APIs allow end users to operate on Azure Machine Learning Web Services resources. They support the following operations:<ul><li>Create or update a web service</li><li>Get a web service</li><li>Patch a web service</li><li>Delete a web service</li><li>Get All Web Services in a Resource Group </li><li>Get All Web Services in a Subscription</li><li>Get Web Services Keys</li></ul>
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 OperationEntityListResult, err error)
List lists all the available 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 OperationEntityListResult, 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.
OutputPort asset output port
type OutputPort struct {
// Type - Port data type. Possible values include: 'OutputPortTypeDataset'
Type OutputPortType `json:"type,omitempty"`
}
OutputPortType enumerates the values for output port type.
type OutputPortType string
const (
// OutputPortTypeDataset ...
OutputPortTypeDataset OutputPortType = "Dataset"
)
func PossibleOutputPortTypeValues() []OutputPortType
PossibleOutputPortTypeValues returns an array of possible values for the OutputPortType const type.
PackageType enumerates the values for package type.
type PackageType string
const (
// PackageTypeGraph ...
PackageTypeGraph PackageType = "Graph"
// PackageTypeWebServiceProperties ...
PackageTypeWebServiceProperties PackageType = "WebServiceProperties"
)
func PossiblePackageTypeValues() []PackageType
PossiblePackageTypeValues returns an array of possible values for the PackageType const type.
PaginatedWebServicesList paginated list of web services.
type PaginatedWebServicesList struct {
autorest.Response `json:"-"`
// Value - An array of web service objects.
Value *[]WebService `json:"value,omitempty"`
// NextLink - A continuation link (absolute URI) to the next page of results in the list.
NextLink *string `json:"nextLink,omitempty"`
}
func (pwsl PaginatedWebServicesList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
PaginatedWebServicesListIterator provides access to a complete listing of WebService values.
type PaginatedWebServicesListIterator struct {
// contains filtered or unexported fields
}
func NewPaginatedWebServicesListIterator(page PaginatedWebServicesListPage) PaginatedWebServicesListIterator
Creates a new instance of the PaginatedWebServicesListIterator type.
func (iter *PaginatedWebServicesListIterator) 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 *PaginatedWebServicesListIterator) 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 PaginatedWebServicesListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PaginatedWebServicesListIterator) Response() PaginatedWebServicesList
Response returns the raw server response from the last page request.
func (iter PaginatedWebServicesListIterator) Value() WebService
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PaginatedWebServicesListPage contains a page of WebService values.
type PaginatedWebServicesListPage struct {
// contains filtered or unexported fields
}
func NewPaginatedWebServicesListPage(cur PaginatedWebServicesList, getNextPage func(context.Context, PaginatedWebServicesList) (PaginatedWebServicesList, error)) PaginatedWebServicesListPage
Creates a new instance of the PaginatedWebServicesListPage type.
func (page *PaginatedWebServicesListPage) 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 *PaginatedWebServicesListPage) 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 PaginatedWebServicesListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PaginatedWebServicesListPage) Response() PaginatedWebServicesList
Response returns the raw server response from the last page request.
func (page PaginatedWebServicesListPage) Values() []WebService
Values returns the slice of values for the current page or nil if there are no values.
Parameter web Service Parameter object for node and global parameter
type Parameter struct {
// Value - The parameter value
Value interface{} `json:"value,omitempty"`
// CertificateThumbprint - If the parameter value in 'value' field is encrypted, the thumbprint of the certificate should be put here.
CertificateThumbprint *string `json:"certificateThumbprint,omitempty"`
}
ParameterType enumerates the values for parameter type.
type ParameterType string
const (
// ParameterTypeBoolean ...
ParameterTypeBoolean ParameterType = "Boolean"
// ParameterTypeColumnPicker ...
ParameterTypeColumnPicker ParameterType = "ColumnPicker"
// ParameterTypeCredential ...
ParameterTypeCredential ParameterType = "Credential"
// ParameterTypeDataGatewayName ...
ParameterTypeDataGatewayName ParameterType = "DataGatewayName"
// ParameterTypeDouble ...
ParameterTypeDouble ParameterType = "Double"
// ParameterTypeEnumerated ...
ParameterTypeEnumerated ParameterType = "Enumerated"
// ParameterTypeFloat ...
ParameterTypeFloat ParameterType = "Float"
// ParameterTypeInt ...
ParameterTypeInt ParameterType = "Int"
// ParameterTypeMode ...
ParameterTypeMode ParameterType = "Mode"
// ParameterTypeParameterRange ...
ParameterTypeParameterRange ParameterType = "ParameterRange"
// ParameterTypeScript ...
ParameterTypeScript ParameterType = "Script"
// ParameterTypeString ...
ParameterTypeString ParameterType = "String"
)
func PossibleParameterTypeValues() []ParameterType
PossibleParameterTypeValues returns an array of possible values for the ParameterType const type.
PatchFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PatchFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (WebService, error)
}
func (future *PatchFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PatchedResource azure resource.
type PatchedResource struct {
// ID - READ-ONLY; Specifies the resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Specifies the name of the resource.
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Specifies the location of the resource.
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Specifies the type of the resource.
Type *string `json:"type,omitempty"`
// Tags - Contains resource tags defined as key/value pairs.
Tags map[string]*string `json:"tags"`
}
func (pr PatchedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchedResource.
PatchedWebService instance of an Patched Azure ML web service resource.
type PatchedWebService struct {
// Properties - Contains the property payload that describes the web service.
Properties BasicProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Specifies the resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Specifies the name of the resource.
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Specifies the location of the resource.
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Specifies the type of the resource.
Type *string `json:"type,omitempty"`
// Tags - Contains resource tags defined as key/value pairs.
Tags map[string]*string `json:"tags"`
}
func (pws PatchedWebService) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchedWebService.
func (pws *PatchedWebService) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PatchedWebService struct.
Properties the set of properties specific to the Azure ML web service resource.
type Properties struct {
// Title - The title of the web service.
Title *string `json:"title,omitempty"`
// Description - The description of the web service.
Description *string `json:"description,omitempty"`
// CreatedOn - READ-ONLY; Read Only: The date and time when the web service was created.
CreatedOn *date.Time `json:"createdOn,omitempty"`
// ModifiedOn - READ-ONLY; Read Only: The date and time when the web service was last modified.
ModifiedOn *date.Time `json:"modifiedOn,omitempty"`
// ProvisioningState - READ-ONLY; Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', 'Failed'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// Keys - Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations.
Keys *Keys `json:"keys,omitempty"`
// ReadOnly - When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.
ReadOnly *bool `json:"readOnly,omitempty"`
// SwaggerLocation - READ-ONLY; Read Only: Contains the URI of the swagger spec associated with this web service.
SwaggerLocation *string `json:"swaggerLocation,omitempty"`
// ExposeSampleData - When set to true, sample data is included in the web service's swagger definition. The default value is true.
ExposeSampleData *bool `json:"exposeSampleData,omitempty"`
// RealtimeConfiguration - Contains the configuration settings for the web service endpoint.
RealtimeConfiguration *RealtimeConfiguration `json:"realtimeConfiguration,omitempty"`
// Diagnostics - Settings controlling the diagnostics traces collection for the web service.
Diagnostics *DiagnosticsConfiguration `json:"diagnostics,omitempty"`
// StorageAccount - Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail.
StorageAccount *StorageAccount `json:"storageAccount,omitempty"`
// MachineLearningWorkspace - Specifies the Machine Learning workspace containing the experiment that is source for the web service.
MachineLearningWorkspace *MachineLearningWorkspace `json:"machineLearningWorkspace,omitempty"`
// CommitmentPlan - Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations.
CommitmentPlan *CommitmentPlan `json:"commitmentPlan,omitempty"`
// Input - Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.
Input *ServiceInputOutputSpecification `json:"input,omitempty"`
// Output - Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.
Output *ServiceInputOutputSpecification `json:"output,omitempty"`
// ExampleRequest - Defines sample input data for one or more of the service's inputs.
ExampleRequest *ExampleRequest `json:"exampleRequest,omitempty"`
// Assets - Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.
Assets map[string]*AssetItem `json:"assets"`
// Parameters - The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.
Parameters map[string]*Parameter `json:"parameters"`
// PayloadsInBlobStorage - When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.
PayloadsInBlobStorage *bool `json:"payloadsInBlobStorage,omitempty"`
// PayloadsLocation - The URI of the payload blob. This parameter contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.
PayloadsLocation *BlobLocation `json:"payloadsLocation,omitempty"`
// PackageType - Possible values include: 'PackageTypeWebServiceProperties', 'PackageTypeGraph'
PackageType PackageType `json:"packageType,omitempty"`
}
func (p Properties) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for Properties.
func (p Properties) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for Properties.
func (p Properties) AsPropertiesForGraph() (*PropertiesForGraph, bool)
AsPropertiesForGraph is the BasicProperties implementation for Properties.
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
PropertiesForGraph properties specific to a Graph based web service.
type PropertiesForGraph struct {
// Package - The definition of the graph package making up this web service.
Package *GraphPackage `json:"package,omitempty"`
// Title - The title of the web service.
Title *string `json:"title,omitempty"`
// Description - The description of the web service.
Description *string `json:"description,omitempty"`
// CreatedOn - READ-ONLY; Read Only: The date and time when the web service was created.
CreatedOn *date.Time `json:"createdOn,omitempty"`
// ModifiedOn - READ-ONLY; Read Only: The date and time when the web service was last modified.
ModifiedOn *date.Time `json:"modifiedOn,omitempty"`
// ProvisioningState - READ-ONLY; Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', 'Failed'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// Keys - Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations.
Keys *Keys `json:"keys,omitempty"`
// ReadOnly - When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.
ReadOnly *bool `json:"readOnly,omitempty"`
// SwaggerLocation - READ-ONLY; Read Only: Contains the URI of the swagger spec associated with this web service.
SwaggerLocation *string `json:"swaggerLocation,omitempty"`
// ExposeSampleData - When set to true, sample data is included in the web service's swagger definition. The default value is true.
ExposeSampleData *bool `json:"exposeSampleData,omitempty"`
// RealtimeConfiguration - Contains the configuration settings for the web service endpoint.
RealtimeConfiguration *RealtimeConfiguration `json:"realtimeConfiguration,omitempty"`
// Diagnostics - Settings controlling the diagnostics traces collection for the web service.
Diagnostics *DiagnosticsConfiguration `json:"diagnostics,omitempty"`
// StorageAccount - Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail.
StorageAccount *StorageAccount `json:"storageAccount,omitempty"`
// MachineLearningWorkspace - Specifies the Machine Learning workspace containing the experiment that is source for the web service.
MachineLearningWorkspace *MachineLearningWorkspace `json:"machineLearningWorkspace,omitempty"`
// CommitmentPlan - Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations.
CommitmentPlan *CommitmentPlan `json:"commitmentPlan,omitempty"`
// Input - Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.
Input *ServiceInputOutputSpecification `json:"input,omitempty"`
// Output - Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.
Output *ServiceInputOutputSpecification `json:"output,omitempty"`
// ExampleRequest - Defines sample input data for one or more of the service's inputs.
ExampleRequest *ExampleRequest `json:"exampleRequest,omitempty"`
// Assets - Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.
Assets map[string]*AssetItem `json:"assets"`
// Parameters - The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.
Parameters map[string]*Parameter `json:"parameters"`
// PayloadsInBlobStorage - When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.
PayloadsInBlobStorage *bool `json:"payloadsInBlobStorage,omitempty"`
// PayloadsLocation - The URI of the payload blob. This parameter contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.
PayloadsLocation *BlobLocation `json:"payloadsLocation,omitempty"`
// PackageType - Possible values include: 'PackageTypeWebServiceProperties', 'PackageTypeGraph'
PackageType PackageType `json:"packageType,omitempty"`
}
func (pfg PropertiesForGraph) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for PropertiesForGraph.
func (pfg PropertiesForGraph) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for PropertiesForGraph.
func (pfg PropertiesForGraph) AsPropertiesForGraph() (*PropertiesForGraph, bool)
AsPropertiesForGraph is the BasicProperties implementation for PropertiesForGraph.
func (pfg PropertiesForGraph) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PropertiesForGraph.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// Failed ...
Failed ProvisioningState = "Failed"
// Provisioning ...
Provisioning ProvisioningState = "Provisioning"
// Succeeded ...
Succeeded ProvisioningState = "Succeeded"
// Unknown ...
Unknown ProvisioningState = "Unknown"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
RealtimeConfiguration holds the available configuration options for an Azure ML web service endpoint.
type RealtimeConfiguration struct {
// MaxConcurrentCalls - Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200.
MaxConcurrentCalls *int32 `json:"maxConcurrentCalls,omitempty"`
}
RemoveFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RemoveFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *RemoveFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Resource azure resource.
type Resource struct {
// ID - READ-ONLY; Specifies the resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Specifies the name of the resource.
Name *string `json:"name,omitempty"`
// Location - Specifies the location of the resource.
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Specifies the type of the resource.
Type *string `json:"type,omitempty"`
// Tags - Contains resource tags defined as key/value pairs.
Tags map[string]*string `json:"tags"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ServiceInputOutputSpecification the swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/
type ServiceInputOutputSpecification struct {
// Title - The title of your Swagger schema.
Title *string `json:"title,omitempty"`
// Description - The description of the Swagger schema.
Description *string `json:"description,omitempty"`
// Type - The type of the entity described in swagger. Always 'object'.
Type *string `json:"type,omitempty"`
// Properties - Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification.
Properties map[string]*TableSpecification `json:"properties"`
}
func (sios ServiceInputOutputSpecification) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceInputOutputSpecification.
StorageAccount access information for a storage account.
type StorageAccount struct {
// Name - Specifies the name of the storage account.
Name *string `json:"name,omitempty"`
// Key - Specifies the key used to access the storage account.
Key *string `json:"key,omitempty"`
}
TableSpecification the swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/
type TableSpecification struct {
// Title - Swagger schema title.
Title *string `json:"title,omitempty"`
// Description - Swagger schema description.
Description *string `json:"description,omitempty"`
// Type - The type of the entity described in swagger.
Type *string `json:"type,omitempty"`
// Format - The format, if 'type' is not 'object'
Format *string `json:"format,omitempty"`
// Properties - The set of columns within the data table.
Properties map[string]*ColumnSpecification `json:"properties"`
}
func (ts TableSpecification) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TableSpecification.
WebService instance of an Azure ML web service resource.
type WebService struct {
autorest.Response `json:"-"`
// Properties - Contains the property payload that describes the web service.
Properties BasicProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Specifies the resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Specifies the name of the resource.
Name *string `json:"name,omitempty"`
// Location - Specifies the location of the resource.
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Specifies the type of the resource.
Type *string `json:"type,omitempty"`
// Tags - Contains resource tags defined as key/value pairs.
Tags map[string]*string `json:"tags"`
}
func (ws WebService) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebService.
func (ws *WebService) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for WebService struct.
| Name | Synopsis |
|---|---|
| .. | |
| webservicesapi | Deprecated: Please note, this package has been deprecated. |