deployment_scripts

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

Overview

Name	deployment_scripts
Type	Resource
Id	azure.resource.deployment_scripts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
identity	object	Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
kind	string	Type of the script. Required. Known values are: "AzurePowerShell" and "AzureCLI".
location	string	The location of the ACI and the storage account for the deployment script. Required.
systemData	object	The system metadata related to this resource.
tags	object	Resource tags.
type	string	Type of this resource.

list_by_resource_group

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
identity	object	Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
kind	string	Type of the script. Required. Known values are: "AzurePowerShell" and "AzureCLI".
location	string	The location of the ACI and the storage account for the deployment script. Required.
systemData	object	The system metadata related to this resource.
tags	object	Resource tags.
type	string	Type of this resource.

list_by_subscription

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
identity	object	Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
kind	string	Type of the script. Required. Known values are: "AzurePowerShell" and "AzureCLI".
location	string	The location of the ACI and the storage account for the deployment script. Required.
systemData	object	The system metadata related to this resource.
tags	object	Resource tags.
type	string	Type of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, script_name, subscription_id		Gets a deployment script with a given name.
list_by_resource_group	select	resource_group_name, subscription_id		Lists deployments scripts.
list_by_subscription	select	subscription_id		Lists all deployment scripts for a given subscription.
create	insert	resource_group_name, script_name, subscription_id, location, kind		Creates a deployment script.
update	update	resource_group_name, script_name, subscription_id		Updates deployment script tags with specified values.
delete	delete	resource_group_name, script_name, subscription_id		Deletes a deployment script. When operation completes, status code 200 returned without content.
get_logs	exec	resource_group_name, script_name, subscription_id		Gets deployment script logs for a given deployment script name.
get_logs_default	exec	resource_group_name, script_name, subscription_id	tail	Gets deployment script logs for a given deployment script 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
script_name	string	Name of the deployment script. Required.
subscription_id	string
tail	integer	The number of lines to show from the tail of the deployment script log. Valid value is a positive number up to 1000. If 'tail' is not provided, all available logs are shown up to container instance log capacity of 4mb. Default value is None.

SELECT examples

get

Gets a deployment script with a given name.

SELECT
id,
name,
identity,
kind,
location,
systemData,
tags,
type
FROM azure.resource.deployment_scripts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND script_name = '{{ script_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists deployments scripts.

SELECT
id,
name,
identity,
kind,
location,
systemData,
tags,
type
FROM azure.resource.deployment_scripts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all deployment scripts for a given subscription.

SELECT
id,
name,
identity,
kind,
location,
systemData,
tags,
type
FROM azure.resource.deployment_scripts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a deployment script.

INSERT INTO azure.resource.deployment_scripts (
identity,
location,
tags,
kind,
resource_group_name,
script_name,
subscription_id
)
SELECT 
'{{ identity }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ script_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployment_scripts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the deployment_scripts resource.
  - name: script_name
    value: "{{ script_name }}"
    description: Required parameter for the deployment_scripts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the deployment_scripts resource.
  - name: identity
    description: |
      Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
    value:
      type: "{{ type }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: location
    value: "{{ location }}"
    description: |
      The location of the ACI and the storage account for the deployment script. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: kind
    value: "{{ kind }}"
    description: |
      Type of the script. Required. Known values are: "AzurePowerShell" and "AzureCLI".

UPDATE examples

update

Updates deployment script tags with specified values.

UPDATE azure.resource.deployment_scripts
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND script_name = '{{ script_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
systemData,
tags,
type;

DELETE examples

delete

Deletes a deployment script. When operation completes, status code 200 returned without content.

DELETE FROM azure.resource.deployment_scripts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND script_name = '{{ script_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_logs

Gets deployment script logs for a given deployment script name.

EXEC azure.resource.deployment_scripts.get_logs 
@resource_group_name='{{ resource_group_name }}' --required, 
@script_name='{{ script_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_logs_default

Gets deployment script logs for a given deployment script name.

EXEC azure.resource.deployment_scripts.get_logs_default 
@resource_group_name='{{ resource_group_name }}' --required, 
@script_name='{{ script_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@tail='{{ tail }}'
;