python3_packages

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

Overview

Name	python3_packages
Type	Resource
Id	azure.automation.python3_packages

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, packageName, subscriptionId		Retrieve the python 3 package identified by package name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId		Retrieve a list of python 3 packages.
create_or_update	insert	resourceGroupName, automationAccountName, packageName, subscriptionId, data__properties		Create or Update the python 3 package identified by package name.
update	update	resourceGroupName, automationAccountName, packageName, subscriptionId		Update the python 3 package identified by package name.
delete	delete	resourceGroupName, automationAccountName, packageName, subscriptionId		Delete the python 3 package 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.
packageName	string	The python package name.
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 python 3 package identified by package name.

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

list_by_automation_account

Retrieve a list of python 3 packages.

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

INSERT examples

create_or_update

Create or Update the python 3 package identified by package name.

INSERT INTO azure.automation.python3_packages (
data__properties,
data__tags,
resourceGroupName,
automationAccountName,
packageName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ packageName }}',
'{{ subscriptionId }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: python3_packages
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the python3_packages resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the python3_packages resource.
    - name: packageName
      value: string
      description: Required parameter for the python3_packages resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the python3_packages resource.
    - name: properties
      value: object
      description: |
        Gets or sets the module create properties.
    - name: tags
      value: object
      description: |
        Gets or sets the tags attached to the resource.

UPDATE examples

update

Update the python 3 package identified by package name.

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

DELETE examples

delete

Delete the python 3 package by name.

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