predefined_accelerators

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

Overview

Name	predefined_accelerators
Type	Resource
Id	azure.spring_apps.predefined_accelerators

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding predefined accelerator.

Name	Datatype	Description
properties	object	Predefined accelerator properties payload
sku	object	Sku of the predefined accelerator resource

list

Success. The response describes the list of predefined accelerators.

Name	Datatype	Description
properties	object	Predefined accelerator properties payload
sku	object	Sku of the predefined accelerator resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName, predefinedAcceleratorName		Get the predefined accelerator.
list	select	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName		Handle requests to list all predefined accelerators.
disable	exec	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName, predefinedAcceleratorName		Disable predefined accelerator.
enable	exec	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName, predefinedAcceleratorName		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
applicationAcceleratorName	string	The name of the application accelerator.
predefinedAcceleratorName	string	The name of the predefined accelerator.
resourceGroupName	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.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get the predefined accelerator.

SELECT
properties,
sku
FROM azure.spring_apps.predefined_accelerators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND applicationAcceleratorName = '{{ applicationAcceleratorName }}' -- required
AND predefinedAcceleratorName = '{{ predefinedAcceleratorName }}' -- required
;

list

Handle requests to list all predefined accelerators.

SELECT
properties,
sku
FROM azure.spring_apps.predefined_accelerators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND applicationAcceleratorName = '{{ applicationAcceleratorName }}' -- required
;

Lifecycle Methods

disable

Disable predefined accelerator.

EXEC azure.spring_apps.predefined_accelerators.disable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@applicationAcceleratorName='{{ applicationAcceleratorName }}' --required, 
@predefinedAcceleratorName='{{ predefinedAcceleratorName }}' --required
;

enable

Enable predefined accelerator.

EXEC azure.spring_apps.predefined_accelerators.enable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@applicationAcceleratorName='{{ applicationAcceleratorName }}' --required, 
@predefinedAcceleratorName='{{ predefinedAcceleratorName }}' --required
;