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

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.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. "HCI"
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

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.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. "HCI"
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	resource_uri, edge_device_name		Get a EdgeDevice.
list	select	resource_uri		List EdgeDevice resources by parent.
create_or_update	insert	resource_uri, edge_device_name, kind		Create a EdgeDevice.
create_or_update	replace	resource_uri, edge_device_name, kind		Create a EdgeDevice.
delete	delete	resource_uri, edge_device_name		Delete a EdgeDevice.
validate	exec	resource_uri, edge_device_name, 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
edge_device_name	string	Name of Device. Default value is "default".
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get a EdgeDevice.

SELECT
id,
name,
kind,
systemData,
type
FROM azure_stack.azure_stack_hci.edge_devices
WHERE resource_uri = '{{ resource_uri }}' -- required
AND edge_device_name = '{{ edge_device_name }}' -- required
;

list

List EdgeDevice resources by parent.

SELECT
id,
name,
kind,
systemData,
type
FROM azure_stack.azure_stack_hci.edge_devices
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create_or_update

Create a EdgeDevice.

INSERT INTO azure_stack.azure_stack_hci.edge_devices (
kind,
resource_uri,
edge_device_name
)
SELECT 
'{{ kind }}' /* required */,
'{{ resource_uri }}',
'{{ edge_device_name }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: edge_devices
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the edge_devices resource.
  - name: edge_device_name
    value: "{{ edge_device_name }}"
    description: Required parameter for the edge_devices resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. "HCI"

REPLACE examples

create_or_update

Create a EdgeDevice.

REPLACE azure_stack.azure_stack_hci.edge_devices
SET 
kind = '{{ kind }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND edge_device_name = '{{ edge_device_name }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
kind,
systemData,
type;

DELETE examples

delete

Delete a EdgeDevice.

DELETE FROM azure_stack.azure_stack_hci.edge_devices
WHERE resource_uri = '{{ resource_uri }}' --required
AND edge_device_name = '{{ edge_device_name }}' --required
;

Lifecycle Methods

validate

A long-running resource action.

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