plans_vnet_gateways
Creates, updates, deletes, gets or lists a plans_vnet_gateways resource.
Overview
| Name | plans_vnet_gateways |
| Type | Resource |
| Id | azure.app_service.plans_vnet_gateways |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | VnetGateway resource specific properties |
type | string | Resource type. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resourceGroupName, name, vnetName, gatewayName, subscriptionId | Description for Get a Virtual Network gateway. | |
update | replace | resourceGroupName, name, vnetName, gatewayName, subscriptionId | Description for Update a Virtual Network gateway. |
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 |
|---|---|---|
gatewayName | string | Name of the gateway. Only the 'primary' gateway is supported. |
name | string | Name of the App Service plan. |
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). |
vnetName | string | Name of the Virtual Network. |
SELECT examples
- get
Description for Get a Virtual Network gateway.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.plans_vnet_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND vnetName = '{{ vnetName }}' -- required
AND gatewayName = '{{ gatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
REPLACE examples
- update
Description for Update a Virtual Network gateway.
REPLACE azure.app_service.plans_vnet_gateways
SET
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND vnetName = '{{ vnetName }}' --required
AND gatewayName = '{{ gatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
kind,
properties,
type;