agri_service

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

Overview

Name	agri_service
Type	Resource
Id	azure_extras.agriculture_platform.agri_service

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.
config	object	Config of the AgriService instance.
dataConnectorCredentials	array	Data connector credentials of AgriService instance.
identity	object	The managed service identities assigned to this resource.
installedSolutions	array	AgriService installed solutions.
location	string	The geo-location where the resource lives. Required.
managedOnBehalfOfConfiguration	object	Managed On Behalf Of Configuration.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
config	object	Config of the AgriService instance.
dataConnectorCredentials	array	Data connector credentials of AgriService instance.
identity	object	The managed service identities assigned to this resource.
installedSolutions	array	AgriService installed solutions.
location	string	The geo-location where the resource lives. Required.
managedOnBehalfOfConfiguration	object	Managed On Behalf Of Configuration.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
config	object	Config of the AgriService instance.
dataConnectorCredentials	array	Data connector credentials of AgriService instance.
identity	object	The managed service identities assigned to this resource.
installedSolutions	array	AgriService installed solutions.
location	string	The geo-location where the resource lives. Required.
managedOnBehalfOfConfiguration	object	Managed On Behalf Of Configuration.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, agri_service_resource_name, subscription_id		Get a AgriServiceResource.
list_by_resource_group	select	resource_group_name, subscription_id		List AgriServiceResource resources by resource group.
list_by_subscription	select	subscription_id		List AgriServiceResource resources by subscription ID.
create_or_update	insert	resource_group_name, agri_service_resource_name, subscription_id, location		Create a AgriServiceResource.
update	update	resource_group_name, agri_service_resource_name, subscription_id		Update a AgriServiceResource.
create_or_update	replace	resource_group_name, agri_service_resource_name, subscription_id, location		Create a AgriServiceResource.
delete	delete	resource_group_name, agri_service_resource_name, subscription_id		Delete a AgriServiceResource.
list_available_solutions	exec	resource_group_name, agri_service_resource_name, subscription_id		Returns the list of available agri solutions.

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
agri_service_resource_name	string	The name of the AgriService resource. 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 AgriServiceResource.

SELECT
id,
name,
config,
dataConnectorCredentials,
identity,
installedSolutions,
location,
managedOnBehalfOfConfiguration,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.agriculture_platform.agri_service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND agri_service_resource_name = '{{ agri_service_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List AgriServiceResource resources by resource group.

SELECT
id,
name,
config,
dataConnectorCredentials,
identity,
installedSolutions,
location,
managedOnBehalfOfConfiguration,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.agriculture_platform.agri_service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List AgriServiceResource resources by subscription ID.

SELECT
id,
name,
config,
dataConnectorCredentials,
identity,
installedSolutions,
location,
managedOnBehalfOfConfiguration,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.agriculture_platform.agri_service
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a AgriServiceResource.

INSERT INTO azure_extras.agriculture_platform.agri_service (
tags,
location,
properties,
identity,
sku,
resource_group_name,
agri_service_resource_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ agri_service_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: agri_service
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the agri_service resource.
  - name: agri_service_resource_name
    value: "{{ agri_service_resource_name }}"
    description: Required parameter for the agri_service resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the agri_service resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      config:
        instanceUri: "{{ instanceUri }}"
        version: "{{ version }}"
        appServiceResourceId: "{{ appServiceResourceId }}"
        cosmosDbResourceId: "{{ cosmosDbResourceId }}"
        storageAccountResourceId: "{{ storageAccountResourceId }}"
        keyVaultResourceId: "{{ keyVaultResourceId }}"
        redisCacheResourceId: "{{ redisCacheResourceId }}"
      managedOnBehalfOfConfiguration:
        moboBrokerResources:
          - id: "{{ id }}"
      dataConnectorCredentials:
        - key: "{{ key }}"
          value:
            kind: "{{ kind }}"
            clientId: "{{ clientId }}"
            keyVaultUri: "{{ keyVaultUri }}"
            keyName: "{{ keyName }}"
            keyVersion: "{{ keyVersion }}"
      installedSolutions:
        - key: "{{ key }}"
          value:
            applicationName: "{{ applicationName }}"
            partnerId: "{{ partnerId }}"
            marketPlacePublisherId: "{{ marketPlacePublisherId }}"
            saasSubscriptionId: "{{ saasSubscriptionId }}"
            saasSubscriptionName: "{{ saasSubscriptionName }}"
            planId: "{{ planId }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      The SKU (Stock Keeping Unit) assigned to this resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}

UPDATE examples

update

Update a AgriServiceResource.

UPDATE azure_extras.agriculture_platform.agri_service
SET 
identity = '{{ identity }}',
sku = '{{ sku }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND agri_service_resource_name = '{{ agri_service_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a AgriServiceResource.

REPLACE azure_extras.agriculture_platform.agri_service
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND agri_service_resource_name = '{{ agri_service_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a AgriServiceResource.

DELETE FROM azure_extras.agriculture_platform.agri_service
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND agri_service_resource_name = '{{ agri_service_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_available_solutions

Returns the list of available agri solutions.

EXEC azure_extras.agriculture_platform.agri_service.list_available_solutions 
@resource_group_name='{{ resource_group_name }}' --required, 
@agri_service_resource_name='{{ agri_service_resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;