modules

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

Overview

Name	modules
Type	Resource
Id	azure.automation.modules

Fields

vw_modules

Name	Datatype	Description
description	text	field from the properties object
activity_count	text	field from the properties object
automationAccountName	text	field from the properties object
content_link	text	field from the properties object
creation_time	text	field from the properties object
error	text	field from the properties object
etag	text	Gets the etag of the resource.
is_composite	text	field from the properties object
is_global	text	field from the properties object
last_modified_time	text	field from the properties object
location	text	The geo-location where the resource lives
moduleName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
size_in_bytes	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
version	text	field from the properties object

modules

Name	Datatype	Description
etag	string	Gets the etag of the resource.
location	string	The geo-location where the resource lives
properties	object	Definition of the module property type.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	automationAccountName, moduleName, resourceGroupName, subscriptionId	Retrieve the module identified by module name.
list_by_automation_account	SELECT	automationAccountName, resourceGroupName, subscriptionId	Retrieve a list of modules.
create_or_update	INSERT	automationAccountName, moduleName, resourceGroupName, subscriptionId, data__properties	Create or Update the module identified by module name.
delete	DELETE	automationAccountName, moduleName, resourceGroupName, subscriptionId	Delete the module by name.
update	UPDATE	automationAccountName, moduleName, resourceGroupName, subscriptionId	Update the module identified by module name.

SELECT examples

Retrieve a list of modules.

vw_modules

SELECT
description,
activity_count,
automationAccountName,
content_link,
creation_time,
error,
etag,
is_composite,
is_global,
last_modified_time,
location,
moduleName,
provisioning_state,
resourceGroupName,
size_in_bytes,
subscriptionId,
tags,
version
FROM azure.automation.vw_modules
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

modules

SELECT
etag,
location,
properties,
tags
FROM azure.automation.modules
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new modules resource.

All Properties

/*+ create */
INSERT INTO azure.automation.modules (
automationAccountName,
moduleName,
resourceGroupName,
subscriptionId,
data__properties,
properties,
name,
location,
tags
)
SELECT 
'{{ automationAccountName }}',
'{{ moduleName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ name }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: contentLink
          value:
            - name: uri
              value: string
            - name: contentHash
              value:
                - name: algorithm
                  value: string
                - name: value
                  value: string
            - name: version
              value: string
    - name: name
      value: string
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a modules resource.

/*+ update */
UPDATE azure.automation.modules
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
automationAccountName = '{{ automationAccountName }}'
AND moduleName = '{{ moduleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified modules resource.

/*+ delete */
DELETE FROM azure.automation.modules
WHERE automationAccountName = '{{ automationAccountName }}'
AND moduleName = '{{ moduleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';