hcx_enterprise_sites

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

Overview

Name	hcx_enterprise_sites
Type	Resource
Id	azure_isv.avs.hcx_enterprise_sites

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
activationKey	string	The activation key.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	The status of the HCX Enterprise Site. Known values are: "Available", "Consumed", "Deactivated", and "Deleted". (Available, Consumed, Deactivated, Deleted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
activationKey	string	The activation key.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	The status of the HCX Enterprise Site. Known values are: "Available", "Consumed", "Deactivated", and "Deleted". (Available, Consumed, Deactivated, Deleted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_cloud_name, hcx_enterprise_site_name, subscription_id		Get a HcxEnterpriseSite.
list	select	resource_group_name, private_cloud_name, subscription_id		List HcxEnterpriseSite resources by PrivateCloud.
create_or_update	insert	resource_group_name, private_cloud_name, hcx_enterprise_site_name, subscription_id		Create a HcxEnterpriseSite.
create_or_update	replace	resource_group_name, private_cloud_name, hcx_enterprise_site_name, subscription_id		Create a HcxEnterpriseSite.
delete	delete	resource_group_name, private_cloud_name, hcx_enterprise_site_name, subscription_id		Delete a HcxEnterpriseSite.

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
hcx_enterprise_site_name	string	Name of the HCX Enterprise Site. Required.
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a HcxEnterpriseSite.

SELECT
id,
name,
activationKey,
provisioningState,
status,
systemData,
type
FROM azure_isv.avs.hcx_enterprise_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND hcx_enterprise_site_name = '{{ hcx_enterprise_site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List HcxEnterpriseSite resources by PrivateCloud.

SELECT
id,
name,
activationKey,
provisioningState,
status,
systemData,
type
FROM azure_isv.avs.hcx_enterprise_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a HcxEnterpriseSite.

INSERT INTO azure_isv.avs.hcx_enterprise_sites (
properties,
resource_group_name,
private_cloud_name,
hcx_enterprise_site_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ hcx_enterprise_site_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: hcx_enterprise_sites
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hcx_enterprise_sites resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the hcx_enterprise_sites resource.
  - name: hcx_enterprise_site_name
    value: "{{ hcx_enterprise_site_name }}"
    description: Required parameter for the hcx_enterprise_sites resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hcx_enterprise_sites resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      activationKey: "{{ activationKey }}"
      status: "{{ status }}"

REPLACE examples

create_or_update

Create a HcxEnterpriseSite.

REPLACE azure_isv.avs.hcx_enterprise_sites
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND hcx_enterprise_site_name = '{{ hcx_enterprise_site_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a HcxEnterpriseSite.

DELETE FROM azure_isv.avs.hcx_enterprise_sites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND hcx_enterprise_site_name = '{{ hcx_enterprise_site_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;