appliances

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

Overview

Name	appliances
Type	Resource
Id	azure.resource_connector.appliances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to an Appliance
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to an Appliance
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to an Appliance
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Gets the details of an Appliance with a specified resource group and name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.
list_by_subscription	select	subscriptionId		Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance
create_or_update	insert	subscriptionId, resourceGroupName, resourceName		Creates or updates an Appliance in the specified Subscription and Resource Group.
update	update	subscriptionId, resourceGroupName, resourceName		Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.
delete	delete	subscriptionId, resourceGroupName, resourceName		Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	Appliances name.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the details of an Appliance with a specified resource group and name.

SELECT
identity,
location,
properties,
tags
FROM azure.resource_connector.appliances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.

SELECT
identity,
location,
properties,
tags
FROM azure.resource_connector.appliances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance

SELECT
identity,
location,
properties,
tags
FROM azure.resource_connector.appliances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Appliance in the specified Subscription and Resource Group.

INSERT INTO azure.resource_connector.appliances (
data__identity,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: appliances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the appliances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the appliances resource.
    - name: resourceName
      value: string
      description: Required parameter for the appliances resource.
    - name: identity
      value: object
      description: |
        Identity for the resource.
    - name: properties
      value: object
      description: |
        The set of properties specific to an Appliance
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.

UPDATE azure.resource_connector.appliances
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.

DELETE FROM azure.resource_connector.appliances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;