power_shell72_modules

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

Overview

Name	power_shell72_modules
Type	Resource
Id	azure.automation.power_shell72_modules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	Gets the etag of the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets the module properties.
tags	object	Resource tags.

list_by_automation_account

Name	Datatype	Description
etag	string	Gets the etag of the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets the module properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, moduleName, subscriptionId		Retrieve the module identified by module name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId		Retrieve a list of PowerShell72 modules.
create_or_update	insert	resourceGroupName, automationAccountName, moduleName, subscriptionId, data__properties		Create or Update the module identified by module name.
update	update	resourceGroupName, automationAccountName, moduleName, subscriptionId		Update the module identified by module name.
delete	delete	resourceGroupName, automationAccountName, moduleName, subscriptionId		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
automationAccountName	string	The name of the automation account.
moduleName	string	The name of module.
resourceGroupName	string	Name of an Azure Resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Retrieve the module identified by module name.

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

list_by_automation_account

Retrieve a list of PowerShell72 modules.

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

INSERT examples

create_or_update

Create or Update the module identified by module name.

INSERT INTO azure.automation.power_shell72_modules (
data__properties,
data__name,
data__location,
data__tags,
resourceGroupName,
automationAccountName,
moduleName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ moduleName }}',
'{{ subscriptionId }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: power_shell72_modules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the power_shell72_modules resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the power_shell72_modules resource.
    - name: moduleName
      value: string
      description: Required parameter for the power_shell72_modules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the power_shell72_modules resource.
    - name: properties
      value: object
      description: |
        Sets the module create properties.
    - name: name
      value: string
      description: |
        Sets name of the resource.
    - name: location
      value: string
      description: |
        Sets the location of the resource.
    - name: tags
      value: object
      description: |
        Sets the tags attached to the resource.

UPDATE examples

update

Update the module identified by module name.

UPDATE azure.automation.power_shell72_modules
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND moduleName = '{{ moduleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
etag,
location,
properties,
tags;

DELETE examples

delete

Delete the module by name.

DELETE FROM azure.automation.power_shell72_modules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND moduleName = '{{ moduleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;