dev_tool_portals

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

Overview

Name	dev_tool_portals
Type	Resource
Id	azure.spring_apps.dev_tool_portals

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Dev Tool Portal.

Name	Datatype	Description
properties	object	Dev Tool Portal properties payload

list

Success. The response describes the list of Dev Tool Portal resources in the Service.

Name	Datatype	Description
properties	object	Dev Tool Portal properties payload

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, devToolPortalName		Get the Application Live and its properties.
list	select	subscriptionId, resourceGroupName, serviceName		Handles requests to list all resources in a Service.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, devToolPortalName		Create the default Dev Tool Portal or update the existing Dev Tool Portal.
delete	delete	subscriptionId, resourceGroupName, serviceName, devToolPortalName		Disable the default Dev Tool Portal.

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
devToolPortalName	string	The name of Dev Tool Portal.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get the Application Live and its properties.

SELECT
properties
FROM azure.spring_apps.dev_tool_portals
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND devToolPortalName = '{{ devToolPortalName }}' -- required
;

list

Handles requests to list all resources in a Service.

SELECT
properties
FROM azure.spring_apps.dev_tool_portals
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

INSERT examples

create_or_update

Create the default Dev Tool Portal or update the existing Dev Tool Portal.

INSERT INTO azure.spring_apps.dev_tool_portals (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
devToolPortalName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ devToolPortalName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: dev_tool_portals
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the dev_tool_portals resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dev_tool_portals resource.
    - name: serviceName
      value: string
      description: Required parameter for the dev_tool_portals resource.
    - name: devToolPortalName
      value: string
      description: Required parameter for the dev_tool_portals resource.
    - name: properties
      value: object
      description: |
        Dev Tool Portal properties payload

DELETE examples

delete

Disable the default Dev Tool Portal.

DELETE FROM azure.spring_apps.dev_tool_portals
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND devToolPortalName = '{{ devToolPortalName }}' --required
;