addons

Creates, updates, deletes, gets or lists an addons resource.

Overview

Name	addons
Type	Resource
Id	azure_isv.avs.addons

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.
addonType	string	Addon type. Required. Known values are: "SRM", "VR", "HCX", and "Arc".
provisioningState	string	The state of the addon provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Cancelled, Building, Deleting, Updating)
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.
addonType	string	Addon type. Required. Known values are: "SRM", "VR", "HCX", and "Arc".
provisioningState	string	The state of the addon provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Cancelled, Building, Deleting, Updating)
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, addon_name, subscription_id		Get a Addon.
list	select	resource_group_name, private_cloud_name, subscription_id		List Addon resources by PrivateCloud.
create_or_update	insert	resource_group_name, private_cloud_name, addon_name, subscription_id		Create a Addon.
create_or_update	replace	resource_group_name, private_cloud_name, addon_name, subscription_id		Create a Addon.
delete	delete	resource_group_name, private_cloud_name, addon_name, subscription_id		Delete a Addon.

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
addon_name	string	Name of the addon. 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 Addon.

SELECT
id,
name,
addonType,
provisioningState,
systemData,
type
FROM azure_isv.avs.addons
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND addon_name = '{{ addon_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Addon resources by PrivateCloud.

SELECT
id,
name,
addonType,
provisioningState,
systemData,
type
FROM azure_isv.avs.addons
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 Addon.

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

Manifest

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

REPLACE examples

create_or_update

Create a Addon.

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

DELETE examples

delete

Delete a Addon.

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