python3_package
Creates, updates, deletes, gets or lists a python3_package resource.
Overview
| Name | python3_package |
| Type | Resource |
| Id | azure.automation.python3_package |
Fields
The following fields are returned by SELECT queries:
- get
- 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. |
| 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, package_name, subscription_id | Retrieve the python 3 package identified by package name. | |
list_by_automation_account | select | resource_group_name, automation_account_name, subscription_id | Retrieve a list of python 3 packages. | |
create_or_update | insert | resource_group_name, automation_account_name, package_name, subscription_id, properties | Create or Update the python 3 package identified by package name. | |
update | update | resource_group_name, automation_account_name, package_name, subscription_id | Update the python 3 package identified by package name. | |
create_or_update | replace | resource_group_name, automation_account_name, package_name, subscription_id, properties | Create or Update the python 3 package identified by package name. | |
delete | delete | resource_group_name, automation_account_name, package_name, subscription_id | 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 |
|---|---|---|
automation_account_name | string | The name of the automation account. Required. |
package_name | string | The python package name. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples
- get
- list_by_automation_account
Retrieve the python 3 package identified by package name.
SELECT
id,
name,
activityCount,
contentLink,
creationTime,
description,
error,
etag,
isComposite,
isGlobal,
lastModifiedTime,
location,
provisioningState,
sizeInBytes,
systemData,
tags,
type,
version
FROM azure.automation.python3_package
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND package_name = '{{ package_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Retrieve a list of python 3 packages.
SELECT
id,
name,
activityCount,
contentLink,
creationTime,
description,
error,
etag,
isComposite,
isGlobal,
lastModifiedTime,
location,
provisioningState,
sizeInBytes,
systemData,
tags,
type,
version
FROM azure.automation.python3_package
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
- Manifest
Create or Update the python 3 package identified by package name.
INSERT INTO azure.automation.python3_package (
properties,
tags,
resource_group_name,
automation_account_name,
package_name,
subscription_id
)
SELECT
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ package_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;
# Description fields are for documentation purposes
- name: python3_package
props:
- name: resource_group_name
value: "{{ resource_group_name }}"
description: Required parameter for the python3_package resource.
- name: automation_account_name
value: "{{ automation_account_name }}"
description: Required parameter for the python3_package resource.
- name: package_name
value: "{{ package_name }}"
description: Required parameter for the python3_package resource.
- name: subscription_id
value: "{{ subscription_id }}"
description: Required parameter for the python3_package resource.
- name: properties
description: |
Gets or sets the module create properties. Required.
value:
contentLink:
uri: "{{ uri }}"
contentHash:
algorithm: "{{ algorithm }}"
value: "{{ value }}"
version: "{{ version }}"
- name: tags
value: "{{ tags }}"
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_package
SET
tags = '{{ tags }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND package_name = '{{ package_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 python 3 package identified by package name.
REPLACE azure.automation.python3_package
SET
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND package_name = '{{ package_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 python 3 package by name.
DELETE FROM azure.automation.python3_package
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND package_name = '{{ package_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;