environments

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

Overview

Name	environments
Type	Resource
Id	azure.app_service.environments

Fields

The following fields are returned by SELECT queries:

get_diagnostics

Name	Datatype	Description
name	string	Name/identifier of the diagnostics.
diagnosticsOutput	string	Diagnostics output.

get

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
properties	object	Description of an App Service Environment.
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"

get_inbound_network_dependencies_endpoints

Name	Datatype	Description
description	string	Short text describing the purpose of the network traffic.
endpoints	array	The IP addresses that network traffic will originate from in cidr notation.
ports	array	The ports that network traffic will arrive to the App Service Environment at.

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
properties	object	Description of an App Service Environment.
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
properties	object	Description of an App Service Environment.
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_diagnostics	select	resourceGroupName, name, diagnosticsName, subscriptionId		Description for Get a diagnostics item for an App Service Environment.
get	select	resourceGroupName, name, subscriptionId		Description for Get the properties of an App Service Environment.
get_inbound_network_dependencies_endpoints	select	resourceGroupName, name, subscriptionId		Description for Get the network endpoints of all inbound dependencies of an App Service Environment.
list_by_resource_group	select	resourceGroupName, subscriptionId		Description for Get all App Service Environments in a resource group.
list	select	subscriptionId		Description for Get all App Service Environments for a subscription.
create_or_update	insert	resourceGroupName, name, subscriptionId		Description for Create or update an App Service Environment.
update	update	resourceGroupName, name, subscriptionId		Description for Create or update an App Service Environment.
delete	delete	resourceGroupName, name, subscriptionId	forceDelete	Description for Delete an App Service Environment.
change_vnet	exec	resourceGroupName, name, subscriptionId, id		Description for Move an App Service Environment to a different VNET.
test_upgrade_available_notification	exec	resourceGroupName, name, subscriptionId
upgrade	exec	resourceGroupName, name, subscriptionId		Description for Initiate an upgrade of an App Service Environment if one is available.
approve_or_reject_private_endpoint_connection	exec	resourceGroupName, name, privateEndpointConnectionName, subscriptionId		Description for Approves or rejects a private endpoint connection
reboot	exec	resourceGroupName, name, subscriptionId		Description for Reboot all machines in an App Service Environment.
resume	exec	resourceGroupName, name, subscriptionId		Description for Resume an App Service Environment.
suspend	exec	resourceGroupName, name, subscriptionId		Description for Suspend an App Service Environment.

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
diagnosticsName	string	Name of the diagnostics item.
name	string	Name of the App Service Environment.
privateEndpointConnectionName	string
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).
forceDelete	boolean	Specify true to force the deletion even if the App Service Environment contains resources. The default is false.

SELECT examples

get_diagnostics

Description for Get a diagnostics item for an App Service Environment.

SELECT
name,
diagnosticsOutput
FROM azure.app_service.environments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND diagnosticsName = '{{ diagnosticsName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

get

Description for Get the properties of an App Service Environment.

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

get_inbound_network_dependencies_endpoints

Description for Get the network endpoints of all inbound dependencies of an App Service Environment.

SELECT
description,
endpoints,
ports
FROM azure.app_service.environments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

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

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

list

Description for Get all App Service Environments for a subscription.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.app_service.environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Create or update an App Service Environment.

INSERT INTO azure.app_service.environments (
data__properties,
resourceGroupName,
name,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: environments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the environments resource.
    - name: name
      value: string
      description: Required parameter for the environments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the environments resource.
    - name: properties
      value: object
      description: |
        Description of an App Service Environment.

UPDATE examples

update

Description for Create or update an App Service Environment.

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

DELETE examples

delete

Description for Delete an App Service Environment.

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

Lifecycle Methods

change_vnet

Description for Move an App Service Environment to a different VNET.

EXEC azure.app_service.environments.change_vnet 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"id": "{{ id }}", 
"subnet": "{{ subnet }}"
}'
;

test_upgrade_available_notification

OK

EXEC azure.app_service.environments.test_upgrade_available_notification 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

upgrade

Description for Initiate an upgrade of an App Service Environment if one is available.

EXEC azure.app_service.environments.upgrade 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

approve_or_reject_private_endpoint_connection

Description for Approves or rejects a private endpoint connection

EXEC azure.app_service.environments.approve_or_reject_private_endpoint_connection 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

reboot

Description for Reboot all machines in an App Service Environment.

EXEC azure.app_service.environments.reboot 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

resume

Description for Resume an App Service Environment.

EXEC azure.app_service.environments.resume 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

suspend

Description for Suspend an App Service Environment.

EXEC azure.app_service.environments.suspend 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;