web_services

Creates, updates, deletes, gets or lists a web_services resource.

Overview

Name	web_services
Type	Resource
Id	azure.machine_learning.web_services

Fields

The following fields are returned by SELECT queries:

get

Success. The response includes the Provisioning State and the Azure-AsyncOperation header. To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. For more informationFor more information about Asynchronous Operations, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-async-operations.

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
location	string	Specifies the location of the resource.
properties	object	Contains the property payload that describes the web service.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

list_by_resource_group

Success. The response includes a paginated array of web service objects and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/. Note that the web service objects are sparsely populated to conserve space in the response content. To get the full web service object, call the GET operation on the web service.

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
location	string	Specifies the location of the resource.
properties	object	Contains the property payload that describes the web service.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

list_by_subscription_id

Success. The response includes a paginated array of web service objects and a URI to the next set of results, if any. Note that the web service objects are sparsely populated to conserve space in the response content. To get the full web service object, call the GET operation on the web service.

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
location	string	Specifies the location of the resource.
properties	object	Contains the property payload that describes the web service.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, webServiceName, subscriptionId	region	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.
list_by_resource_group	select	resourceGroupName, subscriptionId	$skiptoken	Gets the web services in the specified resource group.
list_by_subscription_id	select	subscriptionId	$skiptoken	Gets the web services in the specified subscription.
create_or_update	insert	resourceGroupName, webServiceName, subscriptionId, data__properties		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.
patch	update	resourceGroupName, webServiceName, subscriptionId		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.
remove	exec	resourceGroupName, webServiceName, subscriptionId		Deletes the specified web service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	Name of the resource group in which the web service is located.
subscriptionId	string	The Azure subscription ID.
webServiceName	string	The name of the web service.
$skiptoken	string	Continuation token for pagination.
region	string	The region for which encrypted credential parameters are valid.

SELECT examples

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.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.machine_learning.web_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND webServiceName = '{{ webServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND region = '{{ region }}'
;

list_by_resource_group

Gets the web services in the specified resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.machine_learning.web_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription_id

Gets the web services in the specified subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.machine_learning.web_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

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.

INSERT INTO azure.machine_learning.web_services (
data__location,
data__tags,
data__properties,
resourceGroupName,
webServiceName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ webServiceName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_services
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the web_services resource.
    - name: webServiceName
      value: string
      description: Required parameter for the web_services resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the web_services resource.
    - name: location
      value: string
      description: |
        Specifies the location of the resource.
    - name: tags
      value: object
      description: |
        Contains resource tags defined as key/value pairs.
    - name: properties
      value: object
      description: |
        Contains the property payload that describes the web service.

UPDATE examples

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.

UPDATE azure.machine_learning.web_services
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND webServiceName = '{{ webServiceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

Lifecycle Methods

remove

Deletes the specified web service.

EXEC azure.machine_learning.web_services.remove 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@webServiceName='{{ webServiceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;