customized_accelerators

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

Overview

Name	customized_accelerators
Type	Resource
Id	azure_extras.app_platform.customized_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]
acceleratorType	string	Type of the customized accelerator. Known values are: "Accelerator" and "Fragment".
description	string	:vartype description: str
displayName	string	:vartype display_name: str
gitRepository	object	Required.
iconUrl	string	:vartype icon_url: str
imports	array	Imports references all imports that this accelerator/fragment depends upon.
provisioningState	string	State of the customized accelerator. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
sku	object	Sku of the customized accelerator resource.
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]
acceleratorType	string	Type of the customized accelerator. Known values are: "Accelerator" and "Fragment".
description	string	:vartype description: str
displayName	string	:vartype display_name: str
gitRepository	object	Required.
iconUrl	string	:vartype icon_url: str
imports	array	Imports references all imports that this accelerator/fragment depends upon.
provisioningState	string	State of the customized accelerator. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
sku	object	Sku of the customized accelerator resource.
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, customized_accelerator_name, subscription_id		Get the customized accelerator.
list	select	resource_group_name, service_name, application_accelerator_name, subscription_id		Handle requests to list all customized accelerators.
create_or_update	insert	resource_group_name, service_name, application_accelerator_name, customized_accelerator_name, subscription_id		Create or update the customized accelerator.
create_or_update	replace	resource_group_name, service_name, application_accelerator_name, customized_accelerator_name, subscription_id		Create or update the customized accelerator.
delete	delete	resource_group_name, service_name, application_accelerator_name, customized_accelerator_name, subscription_id		Delete the customized accelerator.
validate	exec	resource_group_name, service_name, application_accelerator_name, customized_accelerator_name, subscription_id, 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
application_accelerator_name	string	The name of the application accelerator. Required.
customized_accelerator_name	string	The name of the customized 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 customized accelerator.

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

list

Handle requests to list all customized accelerators.

SELECT
id,
name,
acceleratorTags,
acceleratorType,
description,
displayName,
gitRepository,
iconUrl,
imports,
provisioningState,
sku,
systemData,
type
FROM azure_extras.app_platform.customized_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
;

INSERT examples

create_or_update

Create or update the customized accelerator.

INSERT INTO azure_extras.app_platform.customized_accelerators (
properties,
sku,
resource_group_name,
service_name,
application_accelerator_name,
customized_accelerator_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ application_accelerator_name }}',
'{{ customized_accelerator_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: customized_accelerators
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the customized_accelerators resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the customized_accelerators resource.
  - name: application_accelerator_name
    value: "{{ application_accelerator_name }}"
    description: Required parameter for the customized_accelerators resource.
  - name: customized_accelerator_name
    value: "{{ customized_accelerator_name }}"
    description: Required parameter for the customized_accelerators resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the customized_accelerators resource.
  - name: properties
    description: |
      Customized accelerator properties payload.
    value:
      provisioningState: "{{ provisioningState }}"
      acceleratorType: "{{ acceleratorType }}"
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      iconUrl: "{{ iconUrl }}"
      acceleratorTags:
        - "{{ acceleratorTags }}"
      imports:
        - "{{ imports }}"
      gitRepository:
        url: "{{ url }}"
        intervalInSeconds: {{ intervalInSeconds }}
        branch: "{{ branch }}"
        commit: "{{ commit }}"
        gitTag: "{{ gitTag }}"
        authSetting:
          authType: "{{ authType }}"
        subPath: "{{ subPath }}"
  - name: sku
    description: |
      Sku of the customized accelerator resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      capacity: {{ capacity }}

REPLACE examples

create_or_update

Create or update the customized accelerator.

REPLACE azure_extras.app_platform.customized_accelerators
SET 
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND application_accelerator_name = '{{ application_accelerator_name }}' --required
AND customized_accelerator_name = '{{ customized_accelerator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
sku,
systemData,
type;

DELETE examples

delete

Delete the customized accelerator.

DELETE FROM azure_extras.app_platform.customized_accelerators
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND application_accelerator_name = '{{ application_accelerator_name }}' --required
AND customized_accelerator_name = '{{ customized_accelerator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

validate

Check the customized accelerator are valid.

EXEC azure_extras.app_platform.customized_accelerators.validate 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@application_accelerator_name='{{ application_accelerator_name }}' --required, 
@customized_accelerator_name='{{ customized_accelerator_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"acceleratorType": "{{ acceleratorType }}", 
"displayName": "{{ displayName }}", 
"description": "{{ description }}", 
"iconUrl": "{{ iconUrl }}", 
"acceleratorTags": "{{ acceleratorTags }}", 
"gitRepository": "{{ gitRepository }}"
}'
;