class Azure::MachineLearning::Mgmt::V2017_01_01::Models::WebServiceProperties

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

Attributes

assets[RW]

@return [Hash{String => AssetItem}] Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.

commitment_plan[RW]

@return [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.

created_on[RW]

@return [DateTime] Read Only: The date and time when the web service was created.

description[RW]

@return [String] The description of the web service.

diagnostics[RW]

@return [DiagnosticsConfiguration] Settings controlling the diagnostics traces collection for the web service.

example_request[RW]

@return [ExampleRequest] Defines sample input data for one or more of the service's inputs.

expose_sample_data[RW]

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

input[RW]

@return [ServiceInputOutputSpecification] Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.

keys[RW]

@return [WebServiceKeys] 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.

machine_learning_workspace[RW]

@return [MachineLearningWorkspace] Specifies the Machine Learning workspace containing the experiment that is source for the web service.

modified_on[RW]

@return [DateTime] Read Only: The date and time when the web service was last modified.

output[RW]

@return [ServiceInputOutputSpecification] Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.

packageType[RW]
parameters[RW]

@return [Hash{String => WebServiceParameter}] 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.

payloads_in_blob_storage[RW]

@return [Boolean] 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.

payloads_location[RW]

@return [BlobLocation] The URI of the payload blob. This paramater contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.

provisioning_state[RW]

@return [ProvisioningState] Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', 'Failed'

read_only[RW]

@return [Boolean] 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.

realtime_configuration[RW]

@return [RealtimeConfiguration] Contains the configuration settings for the web service endpoint.

storage_account[RW]

@return [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.

swagger_location[RW]

@return [String] Read Only: Contains the URI of the swagger spec associated with this web service.

title[RW]

@return [String] The title of the web service.

Private Class Methods

mapper() click to toggle source

Mapper for WebServiceProperties class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb, line 133
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'WebServiceProperties',
    type: {
      name: 'Composite',
      polymorphic_discriminator: 'packageType',
      uber_parent: 'WebServiceProperties',
      class_name: 'WebServiceProperties',
      model_properties: {
        title: {
          client_side_validation: true,
          required: false,
          serialized_name: 'title',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        created_on: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'createdOn',
          type: {
            name: 'DateTime'
          }
        },
        modified_on: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'modifiedOn',
          type: {
            name: 'DateTime'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'provisioningState',
          type: {
            name: 'String'
          }
        },
        keys: {
          client_side_validation: true,
          required: false,
          serialized_name: 'keys',
          type: {
            name: 'Composite',
            class_name: 'WebServiceKeys'
          }
        },
        read_only: {
          client_side_validation: true,
          required: false,
          serialized_name: 'readOnly',
          type: {
            name: 'Boolean'
          }
        },
        swagger_location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'swaggerLocation',
          type: {
            name: 'String'
          }
        },
        expose_sample_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'exposeSampleData',
          type: {
            name: 'Boolean'
          }
        },
        realtime_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'realtimeConfiguration',
          type: {
            name: 'Composite',
            class_name: 'RealtimeConfiguration'
          }
        },
        diagnostics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'diagnostics',
          type: {
            name: 'Composite',
            class_name: 'DiagnosticsConfiguration'
          }
        },
        storage_account: {
          client_side_validation: true,
          required: false,
          serialized_name: 'storageAccount',
          type: {
            name: 'Composite',
            class_name: 'StorageAccount'
          }
        },
        machine_learning_workspace: {
          client_side_validation: true,
          required: false,
          serialized_name: 'machineLearningWorkspace',
          type: {
            name: 'Composite',
            class_name: 'MachineLearningWorkspace'
          }
        },
        commitment_plan: {
          client_side_validation: true,
          required: false,
          serialized_name: 'commitmentPlan',
          type: {
            name: 'Composite',
            class_name: 'CommitmentPlan'
          }
        },
        input: {
          client_side_validation: true,
          required: false,
          serialized_name: 'input',
          type: {
            name: 'Composite',
            class_name: 'ServiceInputOutputSpecification'
          }
        },
        output: {
          client_side_validation: true,
          required: false,
          serialized_name: 'output',
          type: {
            name: 'Composite',
            class_name: 'ServiceInputOutputSpecification'
          }
        },
        example_request: {
          client_side_validation: true,
          required: false,
          serialized_name: 'exampleRequest',
          type: {
            name: 'Composite',
            class_name: 'ExampleRequest'
          }
        },
        assets: {
          client_side_validation: true,
          required: false,
          serialized_name: 'assets',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AssetItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AssetItem'
                }
            }
          }
        },
        parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'parameters',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'WebServiceParameterElementType',
                type: {
                  name: 'Composite',
                  class_name: 'WebServiceParameter'
                }
            }
          }
        },
        payloads_in_blob_storage: {
          client_side_validation: true,
          required: false,
          serialized_name: 'payloadsInBlobStorage',
          type: {
            name: 'Boolean'
          }
        },
        payloads_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'payloadsLocation',
          type: {
            name: 'Composite',
            class_name: 'BlobLocation'
          }
        }
      }
    }
  }
end
new() click to toggle source
# File lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb, line 18
def initialize
  @packageType = "WebServiceProperties"
end