dedicated_cloud_services

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

Overview

Name	dedicated_cloud_services
Type	Resource
Id	azure_isv.vmwarecloudsimple.dedicated_cloud_services

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName}.
name	string	{dedicatedCloudServiceName}.
gatewaySubnet	string	gateway Subnet for the account. It will collect the subnet address and always treat it as /28.
isAccountOnboarded	string	indicates whether account onboarded or not in a given region. Known values are: "notOnBoarded", "onBoarded", "onBoardingFailed", and "onBoarding".
location	string	Azure region. Required.
nodes	integer	total nodes purchased.
serviceURL	string	link to a service management web portal.
tags	object	The list of tags.
type	string	{resourceProviderNamespace}/{resourceType}.

list_by_resource_group

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName}.
name	string	{dedicatedCloudServiceName}.
gatewaySubnet	string	gateway Subnet for the account. It will collect the subnet address and always treat it as /28.
isAccountOnboarded	string	indicates whether account onboarded or not in a given region. Known values are: "notOnBoarded", "onBoarded", "onBoardingFailed", and "onBoarding".
location	string	Azure region. Required.
nodes	integer	total nodes purchased.
serviceURL	string	link to a service management web portal.
tags	object	The list of tags.
type	string	{resourceProviderNamespace}/{resourceType}.

list_by_subscription

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName}.
name	string	{dedicatedCloudServiceName}.
gatewaySubnet	string	gateway Subnet for the account. It will collect the subnet address and always treat it as /28.
isAccountOnboarded	string	indicates whether account onboarded or not in a given region. Known values are: "notOnBoarded", "onBoarded", "onBoardingFailed", and "onBoarding".
location	string	Azure region. Required.
nodes	integer	total nodes purchased.
serviceURL	string	link to a service management web portal.
tags	object	The list of tags.
type	string	{resourceProviderNamespace}/{resourceType}.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dedicated_cloud_service_name, subscription_id		Implements dedicatedCloudService GET method. Returns Dedicate Cloud Service.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top, $skipToken	Implements list of dedicatedCloudService objects within RG method. Returns list of dedicated cloud services within a resource group.
list_by_subscription	select	subscription_id	$filter, $top, $skipToken	Implements list of dedicatedCloudService objects within subscription method. Returns list of dedicated cloud services within a subscription.
create_or_update	insert	resource_group_name, dedicated_cloud_service_name, subscription_id, location		Implements dedicated cloud service PUT method. Create dedicate cloud service.
update	update	resource_group_name, dedicated_cloud_service_name, subscription_id		Implements dedicatedCloudService PATCH method. Patch dedicated cloud service's properties.
create_or_update	replace	resource_group_name, dedicated_cloud_service_name, subscription_id, location		Implements dedicated cloud service PUT method. Create dedicate cloud service.
delete	delete	resource_group_name, dedicated_cloud_service_name, subscription_id		Implements dedicatedCloudService DELETE method. Delete dedicate cloud service.

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
dedicated_cloud_service_name	string	dedicated cloud service 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 dedicatedCloudService GET method. Returns Dedicate Cloud Service.

SELECT
id,
name,
gatewaySubnet,
isAccountOnboarded,
location,
nodes,
serviceURL,
tags,
type
FROM azure_isv.vmwarecloudsimple.dedicated_cloud_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dedicated_cloud_service_name = '{{ dedicated_cloud_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements list of dedicatedCloudService objects within RG method. Returns list of dedicated cloud services within a resource group.

SELECT
id,
name,
gatewaySubnet,
isAccountOnboarded,
location,
nodes,
serviceURL,
tags,
type
FROM azure_isv.vmwarecloudsimple.dedicated_cloud_services
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 dedicatedCloudService objects within subscription method. Returns list of dedicated cloud services within a subscription.

SELECT
id,
name,
gatewaySubnet,
isAccountOnboarded,
location,
nodes,
serviceURL,
tags,
type
FROM azure_isv.vmwarecloudsimple.dedicated_cloud_services
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Implements dedicated cloud service PUT method. Create dedicate cloud service.

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

Manifest

# Description fields are for documentation purposes
- name: dedicated_cloud_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dedicated_cloud_services resource.
  - name: dedicated_cloud_service_name
    value: "{{ dedicated_cloud_service_name }}"
    description: Required parameter for the dedicated_cloud_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dedicated_cloud_services resource.
  - name: location
    value: "{{ location }}"
    description: |
      Azure region. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      The list of tags.
  - name: properties
    value:
      gatewaySubnet: "{{ gatewaySubnet }}"

UPDATE examples

update

Implements dedicatedCloudService PATCH method. Patch dedicated cloud service's properties.

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

REPLACE examples

create_or_update

Implements dedicated cloud service PUT method. Create dedicate cloud service.

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

DELETE examples

delete

Implements dedicatedCloudService DELETE method. Delete dedicate cloud service.

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