dedicated_cloud_nodes

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

Overview

Name	dedicated_cloud_nodes
Type	Resource
Id	azure_isv.vmware_cloud_simple.dedicated_cloud_nodes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName}
name	string	{dedicatedCloudNodeName} (pattern: ^a-zA-Z0-9?$)
location	string	Azure region
properties	object	Dedicated Cloud Nodes properties
sku	object	Dedicated Cloud Nodes SKU
tags	object	Dedicated Cloud Nodes tags
type	string	{resourceProviderNamespace}/{resourceType}

list_by_resource_group

successful operation

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName}
name	string	{dedicatedCloudNodeName} (pattern: ^a-zA-Z0-9?$)
location	string	Azure region
properties	object	Dedicated Cloud Nodes properties
sku	object	Dedicated Cloud Nodes SKU
tags	object	Dedicated Cloud Nodes tags
type	string	{resourceProviderNamespace}/{resourceType}

list_by_subscription

successful operation

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName}
name	string	{dedicatedCloudNodeName} (pattern: ^a-zA-Z0-9?$)
location	string	Azure region
properties	object	Dedicated Cloud Nodes properties
sku	object	Dedicated Cloud Nodes SKU
tags	object	Dedicated Cloud Nodes tags
type	string	{resourceProviderNamespace}/{resourceType}

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dedicatedCloudNodeName	api-version	Returns dedicated cloud node
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version, $filter, $top, $skipToken	Returns list of dedicate cloud nodes within resource group
list_by_subscription	select	subscriptionId	api-version, $filter, $top, $skipToken	Returns list of dedicate cloud nodes within subscription
create_or_update	insert	subscriptionId, resourceGroupName, Referer, dedicatedCloudNodeName, data__location	api-version	Returns dedicated cloud node by its name
update	update	subscriptionId, resourceGroupName, dedicatedCloudNodeName	api-version	Patches dedicated node properties
delete	delete	subscriptionId, resourceGroupName, dedicatedCloudNodeName	api-version	Delete dedicated cloud node

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
Referer	string	referer url
dedicatedCloudNodeName	string	dedicated cloud node name
resourceGroupName	string	The name of the resource group
subscriptionId	string	The subscription ID.
$filter	string	The filter to apply on the list operation
$skipToken	string	to be used by nextLink implementation
$top	integer (int32)	The maximum number of record sets to return
api-version	string	Client API version.

SELECT examples

get

Returns dedicated cloud node

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure_isv.vmware_cloud_simple.dedicated_cloud_nodes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dedicatedCloudNodeName = '{{ dedicatedCloudNodeName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Returns list of dedicate cloud nodes within resource group

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure_isv.vmware_cloud_simple.dedicated_cloud_nodes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Returns list of dedicate cloud nodes within subscription

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure_isv.vmware_cloud_simple.dedicated_cloud_nodes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Returns dedicated cloud node by its name

INSERT INTO azure_isv.vmware_cloud_simple.dedicated_cloud_nodes (
data__location,
data__properties,
data__sku,
data__tags,
subscriptionId,
resourceGroupName,
Referer,
dedicatedCloudNodeName,
api-version
)
SELECT 
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ Referer }}',
'{{ dedicatedCloudNodeName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_cloud_nodes
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the dedicated_cloud_nodes resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dedicated_cloud_nodes resource.
    - name: Referer
      value: string
      description: Required parameter for the dedicated_cloud_nodes resource.
    - name: dedicatedCloudNodeName
      value: string
      description: Required parameter for the dedicated_cloud_nodes resource.
    - name: location
      value: string
      description: |
        Azure region
    - name: properties
      value: object
      description: |
        Dedicated Cloud Nodes properties
    - name: sku
      value: object
      description: |
        Dedicated Cloud Nodes SKU
    - name: tags
      value: object
      description: |
        Dedicated Cloud Nodes tags
    - name: api-version
      value: string
      description: Client API version.

UPDATE examples

update

Patches dedicated node properties

UPDATE azure_isv.vmware_cloud_simple.dedicated_cloud_nodes
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dedicatedCloudNodeName = '{{ dedicatedCloudNodeName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Delete dedicated cloud node

DELETE FROM azure_isv.vmware_cloud_simple.dedicated_cloud_nodes
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dedicatedCloudNodeName = '{{ dedicatedCloudNodeName }}' --required
AND api-version = '{{ api-version }}'
;