module

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

Overview

Name	module
Type	Resource
Id	azure.automation.module

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.
activityCount	integer	Gets or sets the activity count of the module.
contentLink	object	Gets or sets the contentLink of the module.
creationTime	string (date-time)	Gets or sets the creation time.
description	string	Gets or sets the description.
error	object	Gets or sets the error info of the module.
etag	string	Gets or sets the etag of the resource.
isComposite	boolean	Gets or sets type of module, if its composite or not.
isGlobal	boolean	Gets or sets the isGlobal flag of the module.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the module. Known values are: "Created", "Creating", "StartingImportModuleRunbook", "RunningImportModuleRunbook", "ContentRetrieved", "ContentDownloaded", "ContentValidated", "ConnectionTypeImported", "ContentStored", "ModuleDataStored", "ActivitiesStored", "ModuleImportRunbookComplete", "Succeeded", "Failed", "Canceled", and "Updating". (Created, Creating, StartingImportModuleRunbook, RunningImportModuleRunbook, ContentRetrieved, ContentDownloaded, ContentValidated, ConnectionTypeImported, ContentStored, ModuleDataStored, ActivitiesStored, ModuleImportRunbookComplete, Succeeded, Failed, Canceled, Updating)
sizeInBytes	integer	Gets or sets the size in bytes of the module.
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".
version	string	Gets or sets the version of the module.

list_by_automation_account

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.
activityCount	integer	Gets or sets the activity count of the module.
contentLink	object	Gets or sets the contentLink of the module.
creationTime	string (date-time)	Gets or sets the creation time.
description	string	Gets or sets the description.
error	object	Gets or sets the error info of the module.
etag	string	Gets or sets the etag of the resource.
isComposite	boolean	Gets or sets type of module, if its composite or not.
isGlobal	boolean	Gets or sets the isGlobal flag of the module.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the module. Known values are: "Created", "Creating", "StartingImportModuleRunbook", "RunningImportModuleRunbook", "ContentRetrieved", "ContentDownloaded", "ContentValidated", "ConnectionTypeImported", "ContentStored", "ModuleDataStored", "ActivitiesStored", "ModuleImportRunbookComplete", "Succeeded", "Failed", "Canceled", and "Updating". (Created, Creating, StartingImportModuleRunbook, RunningImportModuleRunbook, ContentRetrieved, ContentDownloaded, ContentValidated, ConnectionTypeImported, ContentStored, ModuleDataStored, ActivitiesStored, ModuleImportRunbookComplete, Succeeded, Failed, Canceled, Updating)
sizeInBytes	integer	Gets or sets the size in bytes of the module.
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".
version	string	Gets or sets the version of the module.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, automation_account_name, module_name, subscription_id		Retrieve the module identified by module name.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id		Retrieve a list of modules.
create_or_update	insert	resource_group_name, automation_account_name, module_name, subscription_id, properties		Create or Update the module identified by module name.
update	update	resource_group_name, automation_account_name, module_name, subscription_id		Update the module identified by module name.
create_or_update	replace	resource_group_name, automation_account_name, module_name, subscription_id, properties		Create or Update the module identified by module name.
delete	delete	resource_group_name, automation_account_name, module_name, subscription_id		Delete the module by name.

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
automation_account_name	string	The name of the automation account. Required.
module_name	string	The module name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieve the module identified by module name.

SELECT
id,
name,
activityCount,
contentLink,
creationTime,
description,
error,
etag,
isComposite,
isGlobal,
lastModifiedTime,
location,
provisioningState,
sizeInBytes,
systemData,
tags,
type,
version
FROM azure.automation.module
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND module_name = '{{ module_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of modules.

SELECT
id,
name,
activityCount,
contentLink,
creationTime,
description,
error,
etag,
isComposite,
isGlobal,
lastModifiedTime,
location,
provisioningState,
sizeInBytes,
systemData,
tags,
type,
version
FROM azure.automation.module
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update the module identified by module name.

INSERT INTO azure.automation.module (
properties,
name,
location,
tags,
resource_group_name,
automation_account_name,
module_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ module_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: module
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the module resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the module resource.
  - name: module_name
    value: "{{ module_name }}"
    description: Required parameter for the module resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the module resource.
  - name: properties
    description: |
      Gets or sets the module create properties. Required.
    value:
      contentLink:
        uri: "{{ uri }}"
        contentHash:
          algorithm: "{{ algorithm }}"
          value: "{{ value }}"
        version: "{{ version }}"
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets name of the resource.
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the tags attached to the resource.

UPDATE examples

update

Update the module identified by module name.

UPDATE azure.automation.module
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND module_name = '{{ module_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or Update the module identified by module name.

REPLACE azure.automation.module
SET 
properties = '{{ properties }}',
name = '{{ name }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND module_name = '{{ module_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the module by name.

DELETE FROM azure.automation.module
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND module_name = '{{ module_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;