edge_devices

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

Overview

Name	edge_devices
Type	Resource
Id	azure_stack.azure_stack_hci.edge_devices

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri, edgeDeviceName		Get a EdgeDevice
list	select	resourceUri		List EdgeDevice resources by parent
create_or_update	insert	resourceUri, edgeDeviceName		Create a EdgeDevice
delete	delete	resourceUri, edgeDeviceName		Delete a EdgeDevice
validate	exec	resourceUri, edgeDeviceName, edgeDeviceIds		A long-running resource action.

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
edgeDeviceName	string	Name of Device
resourceUri	string	The fully qualified Azure Resource manager identifier of the resource.

SELECT examples

get

Get a EdgeDevice

SELECT
properties
FROM azure_stack.azure_stack_hci.edge_devices
WHERE resourceUri = '{{ resourceUri }}' -- required
AND edgeDeviceName = '{{ edgeDeviceName }}' -- required
;

list

List EdgeDevice resources by parent

SELECT
properties
FROM azure_stack.azure_stack_hci.edge_devices
WHERE resourceUri = '{{ resourceUri }}' -- required
;

INSERT examples

create_or_update

Create a EdgeDevice

INSERT INTO azure_stack.azure_stack_hci.edge_devices (
data__properties,
resourceUri,
edgeDeviceName
)
SELECT 
'{{ properties }}',
'{{ resourceUri }}',
'{{ edgeDeviceName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: edge_devices
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the edge_devices resource.
    - name: edgeDeviceName
      value: string
      description: Required parameter for the edge_devices resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a EdgeDevice

DELETE FROM azure_stack.azure_stack_hci.edge_devices
WHERE resourceUri = '{{ resourceUri }}' --required
AND edgeDeviceName = '{{ edgeDeviceName }}' --required
;

Lifecycle Methods

validate

A long-running resource action.

EXEC azure_stack.azure_stack_hci.edge_devices.validate 
@resourceUri='{{ resourceUri }}' --required, 
@edgeDeviceName='{{ edgeDeviceName }}' --required 
@@json=
'{
"edgeDeviceIds": "{{ edgeDeviceIds }}", 
"additionalInfo": "{{ additionalInfo }}"
}'
;