hcx_enterprise_sites

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

Overview

Name	hcx_enterprise_sites
Type	Resource
Id	azure_isv.vmware.hcx_enterprise_sites

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The properties of an HCX Enterprise Site resource
type	string	Resource type.

list

successful operation

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The properties of an HCX Enterprise Site resource
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, privateCloudName, hcxEnterpriseSiteName
list	select	subscriptionId, resourceGroupName, privateCloudName
create_or_update	insert	subscriptionId, resourceGroupName, privateCloudName, hcxEnterpriseSiteName
delete	delete	subscriptionId, resourceGroupName, privateCloudName, hcxEnterpriseSiteName

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
hcxEnterpriseSiteName	string	Name of the HCX Enterprise Site in the private cloud
privateCloudName	string	Name of the private cloud
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

successful operation

SELECT
id,
name,
properties,
type
FROM azure_isv.vmware.hcx_enterprise_sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateCloudName = '{{ privateCloudName }}' -- required
AND hcxEnterpriseSiteName = '{{ hcxEnterpriseSiteName }}' -- required
;

list

successful operation

SELECT
id,
name,
properties,
type
FROM azure_isv.vmware.hcx_enterprise_sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateCloudName = '{{ privateCloudName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure_isv.vmware.hcx_enterprise_sites (
subscriptionId,
resourceGroupName,
privateCloudName,
hcxEnterpriseSiteName
)
SELECT 
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ privateCloudName }}',
'{{ hcxEnterpriseSiteName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: hcx_enterprise_sites
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the hcx_enterprise_sites resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the hcx_enterprise_sites resource.
    - name: privateCloudName
      value: string
      description: Required parameter for the hcx_enterprise_sites resource.
    - name: hcxEnterpriseSiteName
      value: string
      description: Required parameter for the hcx_enterprise_sites resource.

DELETE examples

delete

No description available.

DELETE FROM azure_isv.vmware.hcx_enterprise_sites
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND privateCloudName = '{{ privateCloudName }}' --required
AND hcxEnterpriseSiteName = '{{ hcxEnterpriseSiteName }}' --required
;