environments_worker_pools

Creates, updates, deletes, gets or lists an environments_worker_pools resource.

Overview

Name	environments_worker_pools
Type	Resource
Id	azure.app_service.environments_worker_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	Core resource properties
sku	object	Description of a SKU for a scalable resource.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	Core resource properties
sku	object	Description of a SKU for a scalable resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, workerPoolName, subscriptionId		Description for Get properties of a worker pool.
list	select	resourceGroupName, name, subscriptionId		Description for Get all worker pools of an App Service Environment.
create_or_update	insert	resourceGroupName, name, workerPoolName, subscriptionId		Description for Create or update a worker pool.
update	update	resourceGroupName, name, workerPoolName, subscriptionId		Description for Create or update a worker pool.

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
name	string	Name of the App Service Environment.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
workerPoolName	string	Name of the worker pool.

SELECT examples

get

Description for Get properties of a worker pool.

SELECT
id,
name,
kind,
properties,
sku,
type
FROM azure.app_service.environments_worker_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND workerPoolName = '{{ workerPoolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Description for Get all worker pools of an App Service Environment.

SELECT
id,
name,
kind,
properties,
sku,
type
FROM azure.app_service.environments_worker_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Create or update a worker pool.

INSERT INTO azure.app_service.environments_worker_pools (
data__kind,
data__properties,
data__sku,
resourceGroupName,
name,
workerPoolName,
subscriptionId
)
SELECT 
'{{ kind }}',
'{{ properties }}',
'{{ sku }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ workerPoolName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
kind,
properties,
sku,
type
;

Manifest

# Description fields are for documentation purposes
- name: environments_worker_pools
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the environments_worker_pools resource.
    - name: name
      value: string
      description: Required parameter for the environments_worker_pools resource.
    - name: workerPoolName
      value: string
      description: Required parameter for the environments_worker_pools resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the environments_worker_pools resource.
    - name: kind
      value: string
      description: |
        Kind of resource.
    - name: properties
      value: object
      description: |
        Core resource properties
    - name: sku
      value: object
      description: |
        Description of a SKU for a scalable resource.

UPDATE examples

update

Description for Create or update a worker pool.

UPDATE azure.app_service.environments_worker_pools
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}',
data__sku = '{{ sku }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND workerPoolName = '{{ workerPoolName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
kind,
properties,
sku,
type;