runtime_environments

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

Overview

Name	runtime_environments
Type	Resource
Id	azure.automation.runtime_environments

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.
defaultPackages	object	List of Default packages for Environment.
description	string	Gets or sets the description.
location	string	The geo-location where the resource lives. Required.
runtime	object	Runtime properties.
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".

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.
defaultPackages	object	List of Default packages for Environment.
description	string	Gets or sets the description.
location	string	The geo-location where the resource lives. Required.
runtime	object	Runtime properties.
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".

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, runtime_environment_name, subscription_id		Get information about the Runtime Environment.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id		Retrieve a list of RuntimeEnvironments.
create	insert	resource_group_name, automation_account_name, runtime_environment_name, subscription_id, location		Create or update Runtime Environment.
update	update	resource_group_name, automation_account_name, runtime_environment_name, subscription_id		Update an Runtime Environment.
delete	delete	resource_group_name, automation_account_name, runtime_environment_name, subscription_id		Delete the Runtime Environment.

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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
runtime_environment_name	string	The name of the Runtime Environment. Required.
subscription_id	string

SELECT examples

get

Get information about the Runtime Environment.

SELECT
id,
name,
defaultPackages,
description,
location,
runtime,
systemData,
tags,
type
FROM azure.automation.runtime_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND runtime_environment_name = '{{ runtime_environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of RuntimeEnvironments.

SELECT
id,
name,
defaultPackages,
description,
location,
runtime,
systemData,
tags,
type
FROM azure.automation.runtime_environments
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

Create or update Runtime Environment.

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

Manifest

# Description fields are for documentation purposes
- name: runtime_environments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the runtime_environments resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the runtime_environments resource.
  - name: runtime_environment_name
    value: "{{ runtime_environment_name }}"
    description: Required parameter for the runtime_environments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the runtime_environments resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Gets or sets the Runtime Environment properties.
    value:
      runtime:
        language: "{{ language }}"
        version: "{{ version }}"
      defaultPackages: "{{ defaultPackages }}"
      description: "{{ description }}"

UPDATE examples

update

Update an Runtime Environment.

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

DELETE examples

delete

Delete the Runtime Environment.

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