endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.storage_mover.endpoints

Fields

The following fields are returned by SELECT queries:

get

The Endpoint resource.

Name	Datatype	Description
properties	object	The resource specific properties for the Storage Mover resource.
systemData	object	Resource system metadata.

list

The list of Endpoints.

Name	Datatype	Description
properties	object	The resource specific properties for the Storage Mover resource.
systemData	object	Resource system metadata.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, storageMoverName, endpointName		Gets an Endpoint resource.
list	select	subscriptionId, resourceGroupName, storageMoverName		Lists all Endpoints in a Storage Mover.
create_or_update	insert	subscriptionId, resourceGroupName, storageMoverName, endpointName, data__properties		Creates or updates an Endpoint resource, which represents a data transfer source or destination.
update	update	subscriptionId, resourceGroupName, storageMoverName, endpointName		Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged.
delete	delete	subscriptionId, resourceGroupName, storageMoverName, endpointName		Deletes an Endpoint resource.

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
endpointName	string	The name of the Endpoint resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageMoverName	string	The name of the Storage Mover resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets an Endpoint resource.

SELECT
properties,
systemData
FROM azure.storage_mover.endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageMoverName = '{{ storageMoverName }}' -- required
AND endpointName = '{{ endpointName }}' -- required
;

list

Lists all Endpoints in a Storage Mover.

SELECT
properties,
systemData
FROM azure.storage_mover.endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageMoverName = '{{ storageMoverName }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Endpoint resource, which represents a data transfer source or destination.

INSERT INTO azure.storage_mover.endpoints (
data__properties,
subscriptionId,
resourceGroupName,
storageMoverName,
endpointName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageMoverName }}',
'{{ endpointName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the endpoints resource.
    - name: storageMoverName
      value: string
      description: Required parameter for the endpoints resource.
    - name: endpointName
      value: string
      description: Required parameter for the endpoints resource.
    - name: properties
      value: object
      description: |
        The resource specific properties for the Storage Mover resource.

UPDATE examples

update

Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged.

UPDATE azure.storage_mover.endpoints
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
AND endpointName = '{{ endpointName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes an Endpoint resource.

DELETE FROM azure.storage_mover.endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
AND endpointName = '{{ endpointName }}' --required
;