Share via

WebServiceProperties interface

  • Reference
Package:
@azure/arm-webservices

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

Properties

assets

Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.
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.
createdOn

Read Only: The date and time when the web service was created. NOTE: This property will not be serialized. It can only be populated by the server.
description

The description of the web service.
diagnostics

Settings controlling the diagnostics traces collection for the web service.
exampleRequest

Defines sample input data for one or more of the service's inputs.
exposeSampleData

When set to true, sample data is included in the web service's swagger definition. The default value is true.
input

Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.
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.
machineLearningWorkspace

Specifies the Machine Learning workspace containing the experiment that is source for the web service.
modifiedOn

Read Only: The date and time when the web service was last modified. NOTE: This property will not be serialized. It can only be populated by the server.
output

Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.
packageType

Polymorphic discriminator, which specifies the different types this object can be
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.
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.
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.
provisioningState

Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. NOTE: This property will not be serialized. It can only be populated by the server.
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.
realtimeConfiguration

Contains the configuration settings for the web service endpoint.
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.
swaggerLocation

Read Only: Contains the URI of the swagger spec associated with this web service. NOTE: This property will not be serialized. It can only be populated by the server.
title

The title of the web service.

Property Details

assets

Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.

assets?: {[propertyName: string]: AssetItem}

Property Value

{[propertyName: string]: AssetItem}

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

Property Value

CommitmentPlan

createdOn

Read Only: The date and time when the web service was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdOn?: Date

Property Value

Date

description

The description of the web service.

description?: string

Property Value

string

diagnostics

Settings controlling the diagnostics traces collection for the web service.

diagnostics?: DiagnosticsConfiguration

Property Value

DiagnosticsConfiguration

exampleRequest

Defines sample input data for one or more of the service's inputs.

exampleRequest?: ExampleRequest

Property Value

ExampleRequest

exposeSampleData

When set to true, sample data is included in the web service's swagger definition. The default value is true.

exposeSampleData?: boolean

Property Value

boolean

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

Property Value

ServiceInputOutputSpecification

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?: WebServiceKeys

Property Value

WebServiceKeys

machineLearningWorkspace

Specifies the Machine Learning workspace containing the experiment that is source for the web service.

machineLearningWorkspace?: MachineLearningWorkspace

Property Value

MachineLearningWorkspace

modifiedOn

Read Only: The date and time when the web service was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedOn?: Date

Property Value

Date

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

Property Value

ServiceInputOutputSpecification

packageType

Polymorphic discriminator, which specifies the different types this object can be

packageType: "Graph"

Property Value

"Graph"

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?: {[propertyName: string]: WebServiceParameter}

Property Value

{[propertyName: string]: WebServiceParameter}

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?: boolean

Property Value

boolean

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

Property Value

BlobLocation

provisioningState

Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

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?: boolean

Property Value

boolean

realtimeConfiguration

Contains the configuration settings for the web service endpoint.

realtimeConfiguration?: RealtimeConfiguration

Property Value

RealtimeConfiguration

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

Property Value

StorageAccount

swaggerLocation

Read Only: Contains the URI of the swagger spec associated with this web service. NOTE: This property will not be serialized. It can only be populated by the server.

swaggerLocation?: string

Property Value

string

title

The title of the web service.

title?: string

Property Value

string