private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.ml_services.private_endpoint_connections

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
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	Same as workspace location.
properties	object	Private endpoint connection properties.
sku	object	The resource model definition representing SKU
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object
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
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	Same as workspace location.
properties	object	Private endpoint connection properties.
sku	object	The resource model definition representing SKU
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object
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, privateEndpointConnectionName
list	select	subscriptionId, resourceGroupName, workspaceName
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName
delete	delete	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName

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
privateEndpointConnectionName	string	NRP Private Endpoint Connection Name
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

SELECT examples

get

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

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.ml_services.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list

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

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.ml_services.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.private_endpoint_connections (
data__identity,
data__location,
data__properties,
data__sku,
data__tags,
subscriptionId,
resourceGroupName,
workspaceName,
privateEndpointConnectionName
)
SELECT 
'{{ identity }}',
'{{ location }}',
'{{ properties }}',
'{{ sku }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: workspaceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)
    - name: location
      value: string
      description: |
        Same as workspace location.
    - name: properties
      value: object
      description: |
        Private endpoint connection properties.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: tags
      value: object

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;