extensions
Creates, updates, deletes, gets or lists an extensions
resource.
Overview
Name | extensions |
Type | Resource |
Id | azure_extras.ag_food_platform.extensions |
Fields
The following fields are returned by SELECT
queries:
- get
- list_by_data_manager_for_agriculture
Name | Datatype | Description |
---|---|---|
eTag | string | The ETag value to implement optimistic concurrency. |
properties | object | Extension resource properties. |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
Name | Datatype | Description |
---|---|---|
eTag | string | The ETag value to implement optimistic concurrency. |
properties | object | Extension resource properties. |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , dataManagerForAgricultureResourceName , extensionId | Get installed extension details by extension id. | |
list_by_data_manager_for_agriculture | select | subscriptionId , resourceGroupName , dataManagerForAgricultureResourceName | extensionIds , extensionCategories , $maxPageSize , $skipToken | Get installed extensions details. |
create_or_update | insert | subscriptionId , resourceGroupName , dataManagerForAgricultureResourceName , extensionId | Install or Update extension. Additional Api Properties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from Additional Api Properties. | |
delete | delete | subscriptionId , resourceGroupName , dataManagerForAgricultureResourceName , extensionId | 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 |
---|---|---|
dataManagerForAgricultureResourceName | string | DataManagerForAgriculture resource name. |
extensionId | string | Id of extension resource. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
$maxPageSize | integer (int32) | Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. |
$skipToken | string | Skip token for getting next set of results. |
extensionCategories | array | Installed extension categories. |
extensionIds | array | Installed extension ids. |
SELECT
examples
- get
- list_by_data_manager_for_agriculture
Get installed extension details by extension id.
SELECT
eTag,
properties,
systemData
FROM azure_extras.ag_food_platform.extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerForAgricultureResourceName = '{{ dataManagerForAgricultureResourceName }}' -- required
AND extensionId = '{{ extensionId }}' -- required
;
Get installed extensions details.
SELECT
eTag,
properties,
systemData
FROM azure_extras.ag_food_platform.extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerForAgricultureResourceName = '{{ dataManagerForAgricultureResourceName }}' -- required
AND extensionIds = '{{ extensionIds }}'
AND extensionCategories = '{{ extensionCategories }}'
AND $maxPageSize = '{{ $maxPageSize }}'
AND $skipToken = '{{ $skipToken }}'
;
INSERT
examples
- create_or_update
- Manifest
Install or Update extension. Additional Api Properties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from Additional Api Properties.
INSERT INTO azure_extras.ag_food_platform.extensions (
data__extensionVersion,
data__additionalApiProperties,
subscriptionId,
resourceGroupName,
dataManagerForAgricultureResourceName,
extensionId
)
SELECT
'{{ extensionVersion }}',
'{{ additionalApiProperties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataManagerForAgricultureResourceName }}',
'{{ extensionId }}'
RETURNING
eTag,
properties,
systemData
;
# Description fields are for documentation purposes
- name: extensions
props:
- name: subscriptionId
value: string (uuid)
description: Required parameter for the extensions resource.
- name: resourceGroupName
value: string
description: Required parameter for the extensions resource.
- name: dataManagerForAgricultureResourceName
value: string
description: Required parameter for the extensions resource.
- name: extensionId
value: string
description: Required parameter for the extensions resource.
- name: extensionVersion
value: string
description: |
Extension Version.
default: null
- name: additionalApiProperties
value: object
description: |
Additional Api Properties.
DELETE
examples
- delete
Uninstall extension.
DELETE FROM azure_extras.ag_food_platform.extensions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataManagerForAgricultureResourceName = '{{ dataManagerForAgricultureResourceName }}' --required
AND extensionId = '{{ extensionId }}' --required
;