dedicated_cloud_nodes

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

Overview

Name	dedicated_cloud_nodes
Type	Resource
Id	azure_isv.vmwarecloudsimple.dedicated_cloud_nodes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName}.
name	string	{dedicatedCloudNodeName}.
availabilityZoneId	string	Availability Zone id, e.g. "az1".
availabilityZoneName	string	Availability Zone name, e.g. "Availability Zone 1".
cloudRackName	string	VMWare Cloud Rack Name.
created	string (date-time)	date time the resource was created.
location	string	Azure region. Required.
nodesCount	integer	count of nodes to create.
placementGroupId	string	Placement Group id, e.g. "n1".
placementGroupName	string	Placement Name, e.g. "Placement Group 1".
privateCloudId	string	Private Cloud Id.
privateCloudName	string	Resource Pool Name.
provisioningState	string	The provisioning status of the resource.
purchaseId	string	purchase id.
sku	object	Dedicated Cloud Nodes SKU.
skuDescription	object
status	string	Node status, indicates is private cloud set up on this node or not. Known values are: "unused" and "used".
tags	object	Dedicated Cloud Nodes tags.
type	string	{resourceProviderNamespace}/{resourceType}.
vmwareClusterName	string	VMWare Cluster Name.

list_by_resource_group

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName}.
name	string	{dedicatedCloudNodeName}.
availabilityZoneId	string	Availability Zone id, e.g. "az1".
availabilityZoneName	string	Availability Zone name, e.g. "Availability Zone 1".
cloudRackName	string	VMWare Cloud Rack Name.
created	string (date-time)	date time the resource was created.
location	string	Azure region. Required.
nodesCount	integer	count of nodes to create.
placementGroupId	string	Placement Group id, e.g. "n1".
placementGroupName	string	Placement Name, e.g. "Placement Group 1".
privateCloudId	string	Private Cloud Id.
privateCloudName	string	Resource Pool Name.
provisioningState	string	The provisioning status of the resource.
purchaseId	string	purchase id.
sku	object	Dedicated Cloud Nodes SKU.
skuDescription	object
status	string	Node status, indicates is private cloud set up on this node or not. Known values are: "unused" and "used".
tags	object	Dedicated Cloud Nodes tags.
type	string	{resourceProviderNamespace}/{resourceType}.
vmwareClusterName	string	VMWare Cluster Name.

list_by_subscription

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName}.
name	string	{dedicatedCloudNodeName}.
availabilityZoneId	string	Availability Zone id, e.g. "az1".
availabilityZoneName	string	Availability Zone name, e.g. "Availability Zone 1".
cloudRackName	string	VMWare Cloud Rack Name.
created	string (date-time)	date time the resource was created.
location	string	Azure region. Required.
nodesCount	integer	count of nodes to create.
placementGroupId	string	Placement Group id, e.g. "n1".
placementGroupName	string	Placement Name, e.g. "Placement Group 1".
privateCloudId	string	Private Cloud Id.
privateCloudName	string	Resource Pool Name.
provisioningState	string	The provisioning status of the resource.
purchaseId	string	purchase id.
sku	object	Dedicated Cloud Nodes SKU.
skuDescription	object
status	string	Node status, indicates is private cloud set up on this node or not. Known values are: "unused" and "used".
tags	object	Dedicated Cloud Nodes tags.
type	string	{resourceProviderNamespace}/{resourceType}.
vmwareClusterName	string	VMWare Cluster Name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dedicated_cloud_node_name, subscription_id		Implements dedicated cloud node GET method. Returns dedicated cloud node.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top, $skipToken	Implements list of dedicated cloud nodes within RG method. Returns list of dedicate cloud nodes within resource group.
list_by_subscription	select	subscription_id	$filter, $top, $skipToken	Implements list of dedicated cloud nodes within subscription method. Returns list of dedicate cloud nodes within subscription.
create_or_update	insert	resource_group_name, dedicated_cloud_node_name, subscription_id, Referer, location		Implements dedicated cloud node PUT method. Returns dedicated cloud node by its name.
update	update	resource_group_name, dedicated_cloud_node_name, subscription_id		Implements dedicated cloud node PATCH method. Patches dedicated node properties.
create_or_update	replace	resource_group_name, dedicated_cloud_node_name, subscription_id, Referer, location		Implements dedicated cloud node PUT method. Returns dedicated cloud node by its name.
delete	delete	resource_group_name, dedicated_cloud_node_name, subscription_id		Implements dedicated cloud node DELETE method. 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. Required.
dedicated_cloud_node_name	string	dedicated cloud node name. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$filter	string	The filter to apply on the list operation. Default value is None.
$skipToken	string	to be used by nextLink implementation. Default value is None.
$top	integer	The maximum number of record sets to return. Default value is None.

SELECT examples

get

Implements dedicated cloud node GET method. Returns dedicated cloud node.

SELECT
id,
name,
availabilityZoneId,
availabilityZoneName,
cloudRackName,
created,
location,
nodesCount,
placementGroupId,
placementGroupName,
privateCloudId,
privateCloudName,
provisioningState,
purchaseId,
sku,
skuDescription,
status,
tags,
type,
vmwareClusterName
FROM azure_isv.vmwarecloudsimple.dedicated_cloud_nodes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dedicated_cloud_node_name = '{{ dedicated_cloud_node_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements list of dedicated cloud nodes within RG method. Returns list of dedicate cloud nodes within resource group.

SELECT
id,
name,
availabilityZoneId,
availabilityZoneName,
cloudRackName,
created,
location,
nodesCount,
placementGroupId,
placementGroupName,
privateCloudId,
privateCloudName,
provisioningState,
purchaseId,
sku,
skuDescription,
status,
tags,
type,
vmwareClusterName
FROM azure_isv.vmwarecloudsimple.dedicated_cloud_nodes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Implements list of dedicated cloud nodes within subscription method. Returns list of dedicate cloud nodes within subscription.

SELECT
id,
name,
availabilityZoneId,
availabilityZoneName,
cloudRackName,
created,
location,
nodesCount,
placementGroupId,
placementGroupName,
privateCloudId,
privateCloudName,
provisioningState,
purchaseId,
sku,
skuDescription,
status,
tags,
type,
vmwareClusterName
FROM azure_isv.vmwarecloudsimple.dedicated_cloud_nodes
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Implements dedicated cloud node PUT method. Returns dedicated cloud node by its name.

INSERT INTO azure_isv.vmwarecloudsimple.dedicated_cloud_nodes (
location,
sku,
tags,
properties,
resource_group_name,
dedicated_cloud_node_name,
subscription_id,
Referer
)
SELECT 
'{{ location }}' /* required */,
'{{ sku }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dedicated_cloud_node_name }}',
'{{ subscription_id }}',
'{{ Referer }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_cloud_nodes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dedicated_cloud_nodes resource.
  - name: dedicated_cloud_node_name
    value: "{{ dedicated_cloud_node_name }}"
    description: Required parameter for the dedicated_cloud_nodes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dedicated_cloud_nodes resource.
  - name: Referer
    value: "{{ Referer }}"
    description: Required parameter for the dedicated_cloud_nodes resource.
  - name: location
    value: "{{ location }}"
    description: |
      Azure region. Required.
  - name: sku
    description: |
      Dedicated Cloud Nodes SKU.
    value:
      capacity: "{{ capacity }}"
      description: "{{ description }}"
      family: "{{ family }}"
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Dedicated Cloud Nodes tags.
  - name: properties
    value:
      availabilityZoneId: "{{ availabilityZoneId }}"
      nodesCount: {{ nodesCount }}
      placementGroupId: "{{ placementGroupId }}"
      purchaseId: "{{ purchaseId }}"
      skuDescription:
        id: "{{ id }}"
        name: "{{ name }}"

UPDATE examples

update

Implements dedicated cloud node PATCH method. Patches dedicated node properties.

UPDATE azure_isv.vmwarecloudsimple.dedicated_cloud_nodes
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dedicated_cloud_node_name = '{{ dedicated_cloud_node_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

Implements dedicated cloud node PUT method. Returns dedicated cloud node by its name.

REPLACE azure_isv.vmwarecloudsimple.dedicated_cloud_nodes
SET 
location = '{{ location }}',
sku = '{{ sku }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dedicated_cloud_node_name = '{{ dedicated_cloud_node_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND Referer = '{{ Referer }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Implements dedicated cloud node DELETE method. Delete dedicated cloud node.

DELETE FROM azure_isv.vmwarecloudsimple.dedicated_cloud_nodes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dedicated_cloud_node_name = '{{ dedicated_cloud_node_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;