plans

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

Overview

Name	plans
Type	Resource
Id	azure.app_service.plans

Fields

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
extendedLocation	object	Extended Location.
kind	string	Kind of resource.
location	string	Resource Location.
properties	object	AppServicePlan resource specific properties
sku	object	Description of a SKU for a scalable resource.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	name, resourceGroupName, subscriptionId	Description for Get an App Service plan.
list	SELECT	subscriptionId	Description for Get all App Service plans for a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Description for Get all App Service plans in a resource group.
create_or_update	INSERT	name, resourceGroupName, subscriptionId	Description for Creates or updates an App Service Plan.
delete	DELETE	name, resourceGroupName, subscriptionId	Description for Delete an App Service plan.
update	UPDATE	name, resourceGroupName, subscriptionId	Description for Creates or updates an App Service Plan.
get_vnet_route	EXEC	name, resourceGroupName, routeName, subscriptionId, vnetName	Description for Get a Virtual Network route in an App Service plan.
list_vnet_route	EXEC	name, resourceGroupName, subscriptionId, vnetName	Description for Get all routes that are associated with a Virtual Network in an App Service plan.
reboot_worker	EXEC	name, resourceGroupName, subscriptionId, workerName	Description for Reboot a worker machine in an App Service plan.
restart_web_apps	EXEC	name, resourceGroupName, subscriptionId	Description for Restart all apps in an App Service plan.

SELECT examples

Description for Get all App Service plans for a subscription.

SELECT
id,
name,
extendedLocation,
kind,
location,
properties,
sku,
tags,
type
FROM azure.app_service.plans
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new plans resource.

All Properties

/*+ create */
INSERT INTO azure.app_service.plans (
name,
resourceGroupName,
subscriptionId,
kind,
location,
tags,
properties,
sku,
extendedLocation
)
SELECT 
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ kind }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ sku }}',
'{{ extendedLocation }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: kind
      value: string
    - name: location
      value: string
    - name: type
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: workerTierName
          value: string
        - name: status
          value: string
        - name: subscription
          value: string
        - name: hostingEnvironmentProfile
          value:
            - name: id
              value: string
            - name: name
              value: string
            - name: type
              value: string
        - name: maximumNumberOfWorkers
          value: integer
        - name: numberOfWorkers
          value: integer
        - name: geoRegion
          value: string
        - name: perSiteScaling
          value: boolean
        - name: elasticScaleEnabled
          value: boolean
        - name: maximumElasticWorkerCount
          value: integer
        - name: numberOfSites
          value: integer
        - name: isSpot
          value: boolean
        - name: spotExpirationTime
          value: string
        - name: freeOfferExpirationTime
          value: string
        - name: resourceGroup
          value: string
        - name: reserved
          value: boolean
        - name: isXenon
          value: boolean
        - name: hyperV
          value: boolean
        - name: targetWorkerCount
          value: integer
        - name: targetWorkerSizeId
          value: integer
        - name: provisioningState
          value: string
        - name: kubeEnvironmentProfile
          value:
            - name: id
              value: string
            - name: name
              value: string
            - name: type
              value: string
        - name: zoneRedundant
          value: boolean
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
        - name: skuCapacity
          value:
            - name: minimum
              value: integer
            - name: maximum
              value: integer
            - name: elasticMaximum
              value: integer
            - name: default
              value: integer
            - name: scaleType
              value: string
        - name: locations
          value:
            - string
        - name: capabilities
          value:
            - - name: name
                value: string
              - name: value
                value: string
              - name: reason
                value: string
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string

UPDATE example

Updates a plans resource.

/*+ update */
UPDATE azure.app_service.plans
SET 
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified plans resource.

/*+ delete */
DELETE FROM azure.app_service.plans
WHERE name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';