customized_accelerators

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

Overview

Name	customized_accelerators
Type	Resource
Id	azure.spring_apps.customized_accelerators

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding customized accelerator.

Name	Datatype	Description
properties	object	Customized accelerator properties payload
sku	object	Sku of the customized accelerator resource

list

Success. The response describes the list of customized accelerators.

Name	Datatype	Description
properties	object	Customized accelerator properties payload
sku	object	Sku of the customized 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, customizedAcceleratorName		Get the customized accelerator.
list	select	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName		Handle requests to list all customized accelerators.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName, customizedAcceleratorName		Create or update the customized accelerator.
delete	delete	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName, customizedAcceleratorName		Delete the customized accelerator.
validate	exec	subscriptionId, resourceGroupName, serviceName, applicationAcceleratorName, customizedAcceleratorName, gitRepository		Check the customized accelerator are valid.

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.
customizedAcceleratorName	string	The name of the customized 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 customized accelerator.

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

list

Handle requests to list all customized accelerators.

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

INSERT examples

create_or_update

Create or update the customized accelerator.

INSERT INTO azure.spring_apps.customized_accelerators (
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
serviceName,
applicationAcceleratorName,
customizedAcceleratorName
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ applicationAcceleratorName }}',
'{{ customizedAcceleratorName }}'
RETURNING
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: customized_accelerators
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the customized_accelerators resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the customized_accelerators resource.
    - name: serviceName
      value: string
      description: Required parameter for the customized_accelerators resource.
    - name: applicationAcceleratorName
      value: string
      description: Required parameter for the customized_accelerators resource.
    - name: customizedAcceleratorName
      value: string
      description: Required parameter for the customized_accelerators resource.
    - name: properties
      value: object
      description: |
        Customized accelerator properties payload
    - name: sku
      value: object
      description: |
        Sku of the customized accelerator resource

DELETE examples

delete

Delete the customized accelerator.

DELETE FROM azure.spring_apps.customized_accelerators
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND applicationAcceleratorName = '{{ applicationAcceleratorName }}' --required
AND customizedAcceleratorName = '{{ customizedAcceleratorName }}' --required
;

Lifecycle Methods

validate

Check the customized accelerator are valid.

EXEC azure.spring_apps.customized_accelerators.validate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@applicationAcceleratorName='{{ applicationAcceleratorName }}' --required, 
@customizedAcceleratorName='{{ customizedAcceleratorName }}' --required 
@@json=
'{
"acceleratorType": "{{ acceleratorType }}", 
"displayName": "{{ displayName }}", 
"description": "{{ description }}", 
"iconUrl": "{{ iconUrl }}", 
"acceleratorTags": "{{ acceleratorTags }}", 
"gitRepository": "{{ gitRepository }}"
}'
;