script_cmdlets

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

Overview

Name	script_cmdlets
Type	Resource
Id	azure_isv.avs.script_cmdlets

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.
audience	string	Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers. Known values are: "Automation" and "Any". (Automation, Any)
description	string	Description of the scripts functionality.
parameters	array	Parameters the script will accept.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeout	string	Recommended time limit for execution.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
audience	string	Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers. Known values are: "Automation" and "Any". (Automation, Any)
description	string	Description of the scripts functionality.
parameters	array	Parameters the script will accept.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeout	string	Recommended time limit for execution.
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, private_cloud_name, script_package_name, script_cmdlet_name, subscription_id		Get a ScriptCmdlet.
list	select	resource_group_name, private_cloud_name, script_package_name, subscription_id		List ScriptCmdlet resources by ScriptPackage.

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
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
script_cmdlet_name	string	Name of the script cmdlet. Required.
script_package_name	string	Name of the script package. Required.
subscription_id	string

SELECT examples

get

Get a ScriptCmdlet.

SELECT
id,
name,
audience,
description,
parameters,
provisioningState,
systemData,
timeout,
type
FROM azure_isv.avs.script_cmdlets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND script_package_name = '{{ script_package_name }}' -- required
AND script_cmdlet_name = '{{ script_cmdlet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List ScriptCmdlet resources by ScriptPackage.

SELECT
id,
name,
audience,
description,
parameters,
provisioningState,
systemData,
timeout,
type
FROM azure_isv.avs.script_cmdlets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND script_package_name = '{{ script_package_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;