environments

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

Overview

Name	environments
Type	Resource
Id	azure.app_service.environments

Fields

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	name, resourceGroupName, subscriptionId	Description for Get the properties of an App Service Environment.
get_diagnostics	SELECT	diagnosticsName, name, resourceGroupName, subscriptionId	Description for Get a diagnostics item for an App Service Environment.
get_inbound_network_dependencies_endpoints	SELECT	name, resourceGroupName, subscriptionId	Description for Get the network endpoints of all inbound dependencies of an App Service Environment.
list	SELECT	subscriptionId	Description for Get all App Service Environments for a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Description for Get all App Service Environments in a resource group.
create_or_update	INSERT	name, resourceGroupName, subscriptionId	Description for Create or update an App Service Environment.
delete	DELETE	name, resourceGroupName, subscriptionId	Description for Delete an App Service Environment.
update	UPDATE	name, resourceGroupName, subscriptionId	Description for Create or update an App Service Environment.
approve_or_reject_private_endpoint_connection	EXEC	name, privateEndpointConnectionName, resourceGroupName, subscriptionId	Description for Approves or rejects a private endpoint connection
change_vnet	EXEC	name, resourceGroupName, subscriptionId, data__id	Description for Move an App Service Environment to a different VNET.
reboot	EXEC	name, resourceGroupName, subscriptionId	Description for Reboot all machines in an App Service Environment.
resume	EXEC	name, resourceGroupName, subscriptionId	Description for Resume an App Service Environment.
suspend	EXEC	name, resourceGroupName, subscriptionId	Description for Suspend an App Service Environment.
test_upgrade_available_notification	EXEC	name, resourceGroupName, subscriptionId
upgrade	EXEC	name, resourceGroupName, subscriptionId	Description for Initiate an upgrade of an App Service Environment if one is available.

SELECT examples

Description for Get all App Service Environments for a subscription.

SELECT
name,
diagnosticsOutput
FROM azure.app_service.environments
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

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

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: provisioningState
          value: string
        - name: status
          value: string
        - name: virtualNetwork
          value:
            - name: id
              value: string
            - name: name
              value: string
            - name: type
              value: string
            - name: subnet
              value: string
        - name: internalLoadBalancingMode
          value: string
        - name: multiSize
          value: string
        - name: multiRoleCount
          value: integer
        - name: ipsslAddressCount
          value: integer
        - name: dnsSuffix
          value: string
        - name: maximumNumberOfMachines
          value: integer
        - name: frontEndScaleFactor
          value: integer
        - name: suspended
          value: boolean
        - name: clusterSettings
          value:
            - - name: name
                value: string
              - name: value
                value: string
        - name: userWhitelistedIpRanges
          value:
            - string
        - name: hasLinuxWorkers
          value: boolean
        - name: upgradePreference
          value: string
        - name: dedicatedHostCount
          value: integer
        - name: zoneRedundant
          value: boolean
        - name: customDnsSuffixConfiguration
          value:
            - name: id
              value: string
            - name: name
              value: string
            - name: kind
              value: string
            - name: type
              value: string
            - name: properties
              value:
                - name: provisioningState
                  value: string
                - name: provisioningDetails
                  value: string
                - name: dnsSuffix
                  value: string
                - name: certificateUrl
                  value: string
                - name: keyVaultReferenceIdentity
                  value: string
        - name: networkingConfiguration
          value:
            - name: id
              value: string
            - name: name
              value: string
            - name: kind
              value: string
            - name: type
              value: string
            - name: properties
              value:
                - name: windowsOutboundIpAddresses
                  value:
                    - string
                - name: linuxOutboundIpAddresses
                  value:
                    - string
                - name: externalInboundIpAddresses
                  value:
                    - string
                - name: internalInboundIpAddresses
                  value:
                    - string
                - name: allowNewPrivateEndpointConnections
                  value: boolean
                - name: ftpEnabled
                  value: boolean
                - name: remoteDebugEnabled
                  value: boolean
                - name: inboundIpAddressOverride
                  value: string
        - name: upgradeAvailability
          value: string

UPDATE example

Updates a environments resource.

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

DELETE example

Deletes the specified environments resource.

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