extensions

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

Overview

Name	extensions
Type	Resource
Id	azure_extras.agrifood.extensions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
additionalApiProperties	object	Additional api properties.
eTag	string	The ETag value to implement optimistic concurrency.
extensionApiDocsLink	string	Extension api docs link.
extensionAuthLink	string	Extension auth link.
extensionCategory	string	Extension category. e.g. weather/sensor/satellite.
extensionId	string	Extension Id.
installedExtensionVersion	string	Installed extension version.
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_by_farm_beats

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
additionalApiProperties	object	Additional api properties.
eTag	string	The ETag value to implement optimistic concurrency.
extensionApiDocsLink	string	Extension api docs link.
extensionAuthLink	string	Extension auth link.
extensionCategory	string	Extension category. e.g. weather/sensor/satellite.
extensionId	string	Extension Id.
installedExtensionVersion	string	Installed extension version.
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, farm_beats_resource_name, extension_id, subscription_id		Get installed extension details by extension id.
list_by_farm_beats	select	resource_group_name, farm_beats_resource_name, subscription_id	$maxPageSize, $skipToken	Get installed extensions details.
create_or_update	insert	resource_group_name, farm_beats_resource_name, extension_id, subscription_id		Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.
create_or_update	replace	resource_group_name, farm_beats_resource_name, extension_id, subscription_id		Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.
delete	delete	resource_group_name, farm_beats_resource_name, extension_id, subscription_id		Uninstall extension.

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
extension_id	string	Id of extension resource. Required.
farm_beats_resource_name	string	FarmBeats resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$maxPageSize	integer	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. Default value is 50.
$skipToken	string	Skip token for getting next set of results. Default value is None.

SELECT examples

get

Get installed extension details by extension id.

SELECT
id,
name,
additionalApiProperties,
eTag,
extensionApiDocsLink,
extensionAuthLink,
extensionCategory,
extensionId,
installedExtensionVersion,
systemData,
type
FROM azure_extras.agrifood.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' -- required
AND extension_id = '{{ extension_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_farm_beats

Get installed extensions details.

SELECT
id,
name,
additionalApiProperties,
eTag,
extensionApiDocsLink,
extensionAuthLink,
extensionCategory,
extensionId,
installedExtensionVersion,
systemData,
type
FROM azure_extras.agrifood.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $maxPageSize = '{{ $maxPageSize }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.

INSERT INTO azure_extras.agrifood.extensions (
extensionVersion,
additionalApiProperties,
resource_group_name,
farm_beats_resource_name,
extension_id,
subscription_id
)
SELECT 
'{{ extensionVersion }}',
'{{ additionalApiProperties }}',
'{{ resource_group_name }}',
'{{ farm_beats_resource_name }}',
'{{ extension_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: extensions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the extensions resource.
  - name: farm_beats_resource_name
    value: "{{ farm_beats_resource_name }}"
    description: Required parameter for the extensions resource.
  - name: extension_id
    value: "{{ extension_id }}"
    description: Required parameter for the extensions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the extensions resource.
  - name: extensionVersion
    value: "{{ extensionVersion }}"
    description: |
      Extension Version.
  - name: additionalApiProperties
    value: "{{ additionalApiProperties }}"
    description: |
      Additional Api Properties.

REPLACE examples

create_or_update

Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.

REPLACE azure_extras.agrifood.extensions
SET 
extensionVersion = '{{ extensionVersion }}',
additionalApiProperties = '{{ additionalApiProperties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' --required
AND extension_id = '{{ extension_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
systemData,
type;

DELETE examples

delete

Uninstall extension.

DELETE FROM azure_extras.agrifood.extensions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' --required
AND extension_id = '{{ extension_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;