webservices

package
v59.3.3+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package webservices implements the Azure ARM Webservices service API version 2016-05-01-preview.

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>

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Webservices
	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 AssetItem 

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 *AssetLocation `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"`
}

AssetItem information about an asset associated with the web service.

func (AssetItem) MarshalJSON 

func (ai AssetItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssetItem.

type AssetLocation 

type AssetLocation struct {
	// URI - The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets
	URI *string `json:"uri,omitempty"`
	// Credentials - Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI)
	Credentials *string `json:"credentials,omitempty"`
}

AssetLocation describes the access location for a web service asset.

type AssetType 

type AssetType string

AssetType enumerates the values for asset type. 

const (
	// AssetTypeModule ...
	AssetTypeModule AssetType = "Module"
	// AssetTypeResource ...
	AssetTypeResource AssetType = "Resource"
)

func PossibleAssetTypeValues 

func PossibleAssetTypeValues() []AssetType

PossibleAssetTypeValues returns an array of possible values for the AssetType const type.

type BaseClient 

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

BaseClient is the base client for Webservices.

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 BasicProperties 

type BasicProperties interface {
	AsPropertiesForGraph() (*PropertiesForGraph, bool)
	AsProperties() (*Properties, bool)
}

BasicProperties the set of properties specific to the Azure ML web service resource.

type Client 

type Client struct {
	BaseClient
}

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>

func NewClient 

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

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

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

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, webServiceName string, createOrUpdatePayload WebService) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder 

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

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

func (client Client) Get(ctx context.Context, resourceGroupName string, webServiceName 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.

func (Client) GetPreparer 

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

GetPreparer prepares the Get request.

func (Client) GetResponder 

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

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

func (client Client) List(ctx context.Context, skiptoken string) (result PaginatedWebServicesListPage, err error)

List gets the web services in the specified subscription. Parameters: skiptoken - continuation token for pagination.

func (Client) ListByResourceGroup 

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

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

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder 

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

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

func (client Client) ListComplete(ctx context.Context, skiptoken string) (result PaginatedWebServicesListIterator, err error)

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

func (Client) ListKeys 

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

func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, webServiceName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (Client) ListKeysResponder 

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

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

func (client Client) ListPreparer(ctx context.Context, skiptoken string) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder 

func (client Client) ListResponder(resp *http.Response) (result PaginatedWebServicesList, err error)

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

func (Client) ListSender 

func (client Client) ListSender(req *http.Request) (*http.Response, error)

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

func (Client) Patch 

func (client Client) Patch(ctx context.Context, resourceGroupName string, webServiceName string, patchPayload WebService) (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) PatchPreparer 

func (client Client) PatchPreparer(ctx context.Context, resourceGroupName string, webServiceName string, patchPayload WebService) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (Client) PatchResponder 

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

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

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

func (client Client) RemovePreparer(ctx context.Context, resourceGroupName string, webServiceName string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (Client) RemoveResponder 

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

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.

type ColumnFormat 

type ColumnFormat string

ColumnFormat enumerates the values for column format. 

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 

func PossibleColumnFormatValues() []ColumnFormat

PossibleColumnFormatValues returns an array of possible values for the ColumnFormat const type.

type ColumnSpecification 

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

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 ColumnType 

type ColumnType string

ColumnType enumerates the values for column type. 

const (
	// Boolean ...
	Boolean ColumnType = "Boolean"
	// Integer ...
	Integer ColumnType = "Integer"
	// Number ...
	Number ColumnType = "Number"
	// String ...
	String ColumnType = "String"
)

func PossibleColumnTypeValues 

func PossibleColumnTypeValues() []ColumnType

PossibleColumnTypeValues returns an array of possible values for the ColumnType const type.

type CommitmentPlan 

type CommitmentPlan struct {
	// ID - Specifies the Azure Resource Manager ID of the commitment plan associated with the web service.
	ID *string `json:"id,omitempty"`
}

CommitmentPlan information about the machine learning commitment plan associated with the web service.

type CreateOrUpdateFuture 

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

CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CreateOrUpdateFuture) UnmarshalJSON 

func (future *CreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DiagnosticsConfiguration 

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

DiagnosticsConfiguration diagnostics settings for an Azure ML web service.

type DiagnosticsLevel 

type DiagnosticsLevel string

DiagnosticsLevel enumerates the values for diagnostics level. 

const (
	// All ...
	All DiagnosticsLevel = "All"
	// Error ...
	Error DiagnosticsLevel = "Error"
	// None ...
	None DiagnosticsLevel = "None"
)

func PossibleDiagnosticsLevelValues 

func PossibleDiagnosticsLevelValues() []DiagnosticsLevel

PossibleDiagnosticsLevelValues returns an array of possible values for the DiagnosticsLevel const type.

type ExampleRequest 

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

ExampleRequest sample input data for the service's input(s).

func (ExampleRequest) MarshalJSON 

func (er ExampleRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ExampleRequest.

type GraphEdge 

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

GraphEdge defines an edge within the web service's graph.

type GraphNode 

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]*string `json:"parameters"`
}

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.

func (GraphNode) MarshalJSON 

func (gn GraphNode) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GraphNode.

type GraphPackage 

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

GraphPackage defines the graph of modules making up the machine learning solution.

func (GraphPackage) MarshalJSON 

func (gp GraphPackage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GraphPackage.

type GraphParameter 

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

GraphParameter defines a global parameter 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"`
}

GraphParameterLink association link for a graph global parameter to a node in the graph.

type InputPort 

type InputPort struct {
	// Type - Port data type. Possible values include: 'Dataset'
	Type InputPortType `json:"type,omitempty"`
}

InputPort asset input port

type InputPortType 

type InputPortType string

InputPortType enumerates the values for input port type. 

const (
	// Dataset ...
	Dataset InputPortType = "Dataset"
)

func PossibleInputPortTypeValues 

func PossibleInputPortTypeValues() []InputPortType

PossibleInputPortTypeValues returns an array of possible values for the InputPortType const type.

type Keys 

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

Keys access keys for the web service calls.

type MachineLearningWorkspace 

type MachineLearningWorkspace struct {
	// ID - Specifies the workspace ID of the machine learning workspace associated with the web service
	ID *string `json:"id,omitempty"`
}

MachineLearningWorkspace information about the machine learning workspace containing the experiment that is source for the web service.

type ModeValueInfo 

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

ModeValueInfo nested parameter definition.

type ModuleAssetParameter 

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

ModuleAssetParameter parameter definition for a module asset.

func (ModuleAssetParameter) MarshalJSON 

func (mapVar ModuleAssetParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ModuleAssetParameter.

type OutputPort 

type OutputPort struct {
	// Type - Port data type. Possible values include: 'OutputPortTypeDataset'
	Type OutputPortType `json:"type,omitempty"`
}

OutputPort asset output port

type OutputPortType 

type OutputPortType string

OutputPortType enumerates the values for output port type. 

const (
	// OutputPortTypeDataset ...
	OutputPortTypeDataset OutputPortType = "Dataset"
)

func PossibleOutputPortTypeValues 

func PossibleOutputPortTypeValues() []OutputPortType

PossibleOutputPortTypeValues returns an array of possible values for the OutputPortType const type.

type PackageType 

type PackageType string

PackageType enumerates the values for package type. 

const (
	// PackageTypeGraph ...
	PackageTypeGraph PackageType = "Graph"
	// PackageTypeWebServiceProperties ...
	PackageTypeWebServiceProperties PackageType = "WebServiceProperties"
)

func PossiblePackageTypeValues 

func PossiblePackageTypeValues() []PackageType

PossiblePackageTypeValues returns an array of possible values for the PackageType const type.

type PaginatedWebServicesList 

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

PaginatedWebServicesList paginated list of web services.

func (PaginatedWebServicesList) IsEmpty 

func (pwsl PaginatedWebServicesList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PaginatedWebServicesListIterator 

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

PaginatedWebServicesListIterator provides access to a complete listing of WebService values.

func NewPaginatedWebServicesListIterator 

func NewPaginatedWebServicesListIterator(page PaginatedWebServicesListPage) PaginatedWebServicesListIterator

Creates a new instance of the PaginatedWebServicesListIterator type.

func (*PaginatedWebServicesListIterator) Next 

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 (*PaginatedWebServicesListIterator) NextWithContext 

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 (PaginatedWebServicesListIterator) NotDone 

func (iter PaginatedWebServicesListIterator) NotDone() bool

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

func (PaginatedWebServicesListIterator) Response 

func (iter PaginatedWebServicesListIterator) Response() PaginatedWebServicesList

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

func (PaginatedWebServicesListIterator) Value 

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.

type PaginatedWebServicesListPage 

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

PaginatedWebServicesListPage contains a page of WebService values.

func NewPaginatedWebServicesListPage 

func NewPaginatedWebServicesListPage(cur PaginatedWebServicesList, getNextPage func(context.Context, PaginatedWebServicesList) (PaginatedWebServicesList, error)) PaginatedWebServicesListPage

Creates a new instance of the PaginatedWebServicesListPage type.

func (*PaginatedWebServicesListPage) Next 

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 (*PaginatedWebServicesListPage) NextWithContext 

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 (PaginatedWebServicesListPage) NotDone 

func (page PaginatedWebServicesListPage) NotDone() bool

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

func (PaginatedWebServicesListPage) Response 

func (page PaginatedWebServicesListPage) Response() PaginatedWebServicesList

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

func (PaginatedWebServicesListPage) Values 

func (page PaginatedWebServicesListPage) Values() []WebService

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

type ParameterType 

type ParameterType string

ParameterType enumerates the values for parameter type. 

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 

func PossibleParameterTypeValues() []ParameterType

PossibleParameterTypeValues returns an array of possible values for the ParameterType const type.

type PatchFuture 

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

PatchFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PatchFuture) UnmarshalJSON 

func (future *PatchFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Properties 

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]*string `json:"parameters"`
	// PackageType - Possible values include: 'PackageTypeWebServiceProperties', 'PackageTypeGraph'
	PackageType PackageType `json:"packageType,omitempty"`
}

Properties the set of properties specific to the Azure ML web service resource.

func (Properties) AsBasicProperties 

func (p Properties) AsBasicProperties() (BasicProperties, bool)

AsBasicProperties is the BasicProperties implementation for Properties.

func (Properties) AsProperties 

func (p Properties) AsProperties() (*Properties, bool)

AsProperties is the BasicProperties implementation for Properties.

func (Properties) AsPropertiesForGraph 

func (p Properties) AsPropertiesForGraph() (*PropertiesForGraph, bool)

AsPropertiesForGraph is the BasicProperties implementation for Properties.

func (Properties) MarshalJSON 

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

MarshalJSON is the custom marshaler for Properties.

type PropertiesForGraph 

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]*string `json:"parameters"`
	// PackageType - Possible values include: 'PackageTypeWebServiceProperties', 'PackageTypeGraph'
	PackageType PackageType `json:"packageType,omitempty"`
}

PropertiesForGraph properties specific to a Graph based web service.

func (PropertiesForGraph) AsBasicProperties 

func (pfg PropertiesForGraph) AsBasicProperties() (BasicProperties, bool)

AsBasicProperties is the BasicProperties implementation for PropertiesForGraph.

func (PropertiesForGraph) AsProperties 

func (pfg PropertiesForGraph) AsProperties() (*Properties, bool)

AsProperties is the BasicProperties implementation for PropertiesForGraph.

func (PropertiesForGraph) AsPropertiesForGraph 

func (pfg PropertiesForGraph) AsPropertiesForGraph() (*PropertiesForGraph, bool)

AsPropertiesForGraph is the BasicProperties implementation for PropertiesForGraph.

func (PropertiesForGraph) MarshalJSON 

func (pfg PropertiesForGraph) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PropertiesForGraph.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Provisioning ...
	Provisioning ProvisioningState = "Provisioning"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
	// Unknown ...
	Unknown ProvisioningState = "Unknown"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

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

type RealtimeConfiguration 

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

RealtimeConfiguration holds the available configuration options for an Azure ML web service endpoint.

type RemoveFuture 

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

RemoveFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*RemoveFuture) UnmarshalJSON 

func (future *RemoveFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty"`
	// Name - 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"`
}

Resource ...

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type ServiceInputOutputSpecification 

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

ServiceInputOutputSpecification the swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/

func (ServiceInputOutputSpecification) MarshalJSON 

func (sios ServiceInputOutputSpecification) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceInputOutputSpecification.

type StorageAccount 

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

StorageAccount access information for a storage account.

type TableSpecification 

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

TableSpecification the swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/

func (TableSpecification) MarshalJSON 

func (ts TableSpecification) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TableSpecification.

type WebService 

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

WebService instance of an Azure ML web service resource.

func (WebService) MarshalJSON 

func (ws WebService) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WebService.

func (*WebService) UnmarshalJSON 

func (ws *WebService) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WebService struct.

Source Files

View all Source files

Directories

Path Synopsis

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.