application_gateways

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

Overview

Name	application_gateways
Type	Resource
Id	azure.network.application_gateways

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns an ApplicationGateway resource.

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
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of the application gateway, if configured.
properties	object	Properties of the application gateway.
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"
zones	array	A list of availability zones denoting where the resource needs to come from.

list

Success. The operation returns a list of ApplicationGateway resources.

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
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of the application gateway, if configured.
properties	object	Properties of the application gateway.
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"
zones	array	A list of availability zones denoting where the resource needs to come from.

list_all

Success. The operation returns a list of ApplicationGateway resources.

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
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of the application gateway, if configured.
properties	object	Properties of the application gateway.
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"
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, applicationGatewayName, subscriptionId		Gets the specified application gateway.
list	select	resourceGroupName, subscriptionId		Lists all application gateways in a resource group.
list_all	select	subscriptionId		Gets all the application gateways in a subscription.
create_or_update	insert	resourceGroupName, applicationGatewayName, subscriptionId		Creates or updates the specified application gateway.
delete	delete	resourceGroupName, applicationGatewayName, subscriptionId		Deletes the specified application gateway.
update_tags	exec	resourceGroupName, applicationGatewayName, subscriptionId		Updates the specified application gateway tags.
start	exec	resourceGroupName, applicationGatewayName, subscriptionId		Starts the specified application gateway.
stop	exec	resourceGroupName, applicationGatewayName, subscriptionId		Stops the specified application gateway in a resource group.
backend_health	exec	resourceGroupName, applicationGatewayName, subscriptionId	$expand	Gets the backend health of the specified application gateway in a resource group.
backend_health_on_demand	exec	resourceGroupName, applicationGatewayName, subscriptionId	$expand	Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

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
applicationGatewayName	string	The name of the application gateway.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

SELECT examples

get

Gets the specified application gateway.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type,
zones
FROM azure.network.application_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationGatewayName = '{{ applicationGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all application gateways in a resource group.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type,
zones
FROM azure.network.application_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_all

Gets all the application gateways in a subscription.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type,
zones
FROM azure.network.application_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified application gateway.

INSERT INTO azure.network.application_gateways (
data__properties,
data__zones,
data__identity,
resourceGroupName,
applicationGatewayName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ zones }}',
'{{ identity }}',
'{{ resourceGroupName }}',
'{{ applicationGatewayName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
identity,
properties,
systemData,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: application_gateways
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the application_gateways resource.
    - name: applicationGatewayName
      value: string
      description: Required parameter for the application_gateways resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the application_gateways resource.
    - name: properties
      value: object
      description: |
        Properties of the application gateway.
    - name: zones
      value: array
      description: |
        A list of availability zones denoting where the resource needs to come from.
    - name: identity
      value: object
      description: |
        The identity of the application gateway, if configured.

DELETE examples

delete

Deletes the specified application gateway.

DELETE FROM azure.network.application_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationGatewayName = '{{ applicationGatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates the specified application gateway tags.

EXEC azure.network.application_gateways.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@applicationGatewayName='{{ applicationGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

start

Starts the specified application gateway.

EXEC azure.network.application_gateways.start 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@applicationGatewayName='{{ applicationGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

stop

Stops the specified application gateway in a resource group.

EXEC azure.network.application_gateways.stop 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@applicationGatewayName='{{ applicationGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

backend_health

Gets the backend health of the specified application gateway in a resource group.

EXEC azure.network.application_gateways.backend_health 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@applicationGatewayName='{{ applicationGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@$expand='{{ $expand }}'
;

backend_health_on_demand

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

EXEC azure.network.application_gateways.backend_health_on_demand 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@applicationGatewayName='{{ applicationGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@$expand='{{ $expand }}' 
@@json=
'{
"protocol": "{{ protocol }}", 
"host": "{{ host }}", 
"path": "{{ path }}", 
"timeout": {{ timeout }}, 
"pickHostNameFromBackendHttpSettings": {{ pickHostNameFromBackendHttpSettings }}, 
"match": "{{ match }}", 
"backendAddressPool": "{{ backendAddressPool }}", 
"backendHttpSettings": "{{ backendHttpSettings }}"
}'
;