plans

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

Overview

Name	plans
Type	Resource
Id	azure.app_service.plans

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
extendedLocation	object	Extended Location.
properties	object	AppServicePlan resource specific properties
sku	object	Description of a SKU for a scalable resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
extendedLocation	object	Extended Location.
properties	object	AppServicePlan resource specific properties
sku	object	Description of a SKU for a scalable resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
extendedLocation	object	Extended Location.
properties	object	AppServicePlan resource specific properties
sku	object	Description of a SKU for a scalable resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

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

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 plan.
resourceGroupName	string	Name of the resource group to which the resource belongs.
routeName	string	Name of the Virtual Network route.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
vnetName	string	Name of the Virtual Network.
workerName	string	Name of worker machine, which typically starts with RD.
detailed	boolean	Specify true to return all App Service plan properties. The default is false, which returns a subset of the properties. Retrieval of all properties may increase the API latency.
softRestart	boolean	Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps

SELECT examples

get

Description for Get an App Service plan.

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

list_by_resource_group

Description for Get all App Service plans in a resource group.

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

list

Description for Get all App Service plans for a subscription.

SELECT
id,
name,
extendedLocation,
properties,
sku,
systemData,
type
FROM azure.app_service.plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND detailed = '{{ detailed }}'
;

INSERT examples

create_or_update

Description for Creates or updates an App Service Plan.

INSERT INTO azure.app_service.plans (
data__properties,
data__sku,
data__extendedLocation,
resourceGroupName,
name,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ extendedLocation }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
extendedLocation,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: plans
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the plans resource.
    - name: name
      value: string
      description: Required parameter for the plans resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the plans resource.
    - name: properties
      value: object
      description: |
        AppServicePlan resource specific properties
    - name: sku
      value: object
      description: |
        Description of a SKU for a scalable resource.
    - name: extendedLocation
      value: object
      description: |
        Extended Location.

UPDATE examples

update

Description for Creates or updates an App Service Plan.

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

DELETE examples

delete

Description for Delete an App Service plan.

DELETE FROM azure.app_service.plans
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

restart_web_apps

Description for Restart all apps in an App Service plan.

EXEC azure.app_service.plans.restart_web_apps 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@softRestart={{ softRestart }}
;

list_vnet_route

Description for Get all routes that are associated with a Virtual Network in an App Service plan.

EXEC azure.app_service.plans.list_vnet_route 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@vnetName='{{ vnetName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

get_vnet_route

Description for Get a Virtual Network route in an App Service plan.

EXEC azure.app_service.plans.get_vnet_route 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@vnetName='{{ vnetName }}' --required, 
@routeName='{{ routeName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

reboot_worker

Description for Reboot a worker machine in an App Service plan.

EXEC azure.app_service.plans.reboot_worker 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@workerName='{{ workerName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;