predefined_accelerators

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

Overview

Name	predefined_accelerators
Type	Resource
Id	azure_extras.app_platform.predefined_accelerators

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
acceleratorTags	array	:vartype accelerator_tags: list[str]
description	string	:vartype description: str
displayName	string	:vartype display_name: str
iconUrl	string	:vartype icon_url: str
provisioningState	string	Provisioning state of the predefined accelerator. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Canceled".
sku	object	Sku of the predefined accelerator resource.
state	string	State of the predefined accelerator. Known values are: "Enabled" and "Disabled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
acceleratorTags	array	:vartype accelerator_tags: list[str]
description	string	:vartype description: str
displayName	string	:vartype display_name: str
iconUrl	string	:vartype icon_url: str
provisioningState	string	Provisioning state of the predefined accelerator. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Canceled".
sku	object	Sku of the predefined accelerator resource.
state	string	State of the predefined accelerator. Known values are: "Enabled" and "Disabled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, application_accelerator_name, predefined_accelerator_name, subscription_id		Get the predefined accelerator.
list	select	resource_group_name, service_name, application_accelerator_name, subscription_id		Handle requests to list all predefined accelerators.
disable	exec	resource_group_name, service_name, application_accelerator_name, predefined_accelerator_name, subscription_id		Disable predefined accelerator.
enable	exec	resource_group_name, service_name, application_accelerator_name, predefined_accelerator_name, subscription_id		Enable predefined accelerator.

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
application_accelerator_name	string	The name of the application accelerator. Required.
predefined_accelerator_name	string	The name of the predefined accelerator. Required.
resource_group_name	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the predefined accelerator.

SELECT
id,
name,
acceleratorTags,
description,
displayName,
iconUrl,
provisioningState,
sku,
state,
systemData,
type
FROM azure_extras.app_platform.predefined_accelerators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND application_accelerator_name = '{{ application_accelerator_name }}' -- required
AND predefined_accelerator_name = '{{ predefined_accelerator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handle requests to list all predefined accelerators.

SELECT
id,
name,
acceleratorTags,
description,
displayName,
iconUrl,
provisioningState,
sku,
state,
systemData,
type
FROM azure_extras.app_platform.predefined_accelerators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND application_accelerator_name = '{{ application_accelerator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

disable

Disable predefined accelerator.

EXEC azure_extras.app_platform.predefined_accelerators.disable 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@application_accelerator_name='{{ application_accelerator_name }}' --required, 
@predefined_accelerator_name='{{ predefined_accelerator_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable

Enable predefined accelerator.

EXEC azure_extras.app_platform.predefined_accelerators.enable 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@application_accelerator_name='{{ application_accelerator_name }}' --required, 
@predefined_accelerator_name='{{ predefined_accelerator_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;