endpoint_deployments

Creates, updates, deletes, gets or lists an endpoint_deployments resource.

Overview

Name	endpoint_deployments
Type	Resource
Id	azure.ml_services.endpoint_deployments

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

get_in_workspace

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, endpointName, deploymentName
list	select	subscriptionId, resourceGroupName, workspaceName, endpointName
get_in_workspace	select	subscriptionId, resourceGroupName, workspaceName	endpointType, $skip
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, endpointName, deploymentName, data__properties
delete	delete	subscriptionId, resourceGroupName, workspaceName, endpointName, deploymentName

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
deploymentName	string	Name of the deployment resource
endpointName	string	Name of the endpoint resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	Azure Machine Learning Workspace Name
$skip	string	Continuation token for pagination.
endpointType	string	Endpoint type filter

SELECT examples

get

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.endpoint_deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND endpointName = '{{ endpointName }}' -- required
AND deploymentName = '{{ deploymentName }}' -- required
;

list

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.endpoint_deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND endpointName = '{{ endpointName }}' -- required
;

get_in_workspace

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.endpoint_deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND endpointType = '{{ endpointType }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.endpoint_deployments (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
endpointName,
deploymentName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ endpointName }}',
'{{ deploymentName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: endpoint_deployments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the endpoint_deployments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the endpoint_deployments resource.
    - name: workspaceName
      value: string
      description: Required parameter for the endpoint_deployments resource.
    - name: endpointName
      value: string
      description: Required parameter for the endpoint_deployments resource.
    - name: deploymentName
      value: string
      description: Required parameter for the endpoint_deployments resource.
    - name: properties
      value: object

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.endpoint_deployments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND endpointName = '{{ endpointName }}' --required
AND deploymentName = '{{ deploymentName }}' --required
;