dev_tool_portals

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

Overview

Name	dev_tool_portals
Type	Resource
Id	azure_extras.app_platform.dev_tool_portals

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
components	array	Collection of components belong to Dev Tool Portal.
features	object	Settings for Dev Tool Portal.
provisioningState	string	State of the Dev Tool Portal. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
public	boolean	Indicates whether the resource exposes public endpoint.
ssoProperties	object	Single sign-on related configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.
url	string	URL of the resource, exposed when 'public' is true.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
components	array	Collection of components belong to Dev Tool Portal.
features	object	Settings for Dev Tool Portal.
provisioningState	string	State of the Dev Tool Portal. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
public	boolean	Indicates whether the resource exposes public endpoint.
ssoProperties	object	Single sign-on related configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.
url	string	URL of the resource, exposed when 'public' is true.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, dev_tool_portal_name, subscription_id		Get the Application Live and its properties.
list	select	resource_group_name, service_name, subscription_id		Handles requests to list all resources in a Service.
create_or_update	insert	resource_group_name, service_name, dev_tool_portal_name, subscription_id		Create the default Dev Tool Portal or update the existing Dev Tool Portal.
create_or_update	replace	resource_group_name, service_name, dev_tool_portal_name, subscription_id		Create the default Dev Tool Portal or update the existing Dev Tool Portal.
delete	delete	resource_group_name, service_name, dev_tool_portal_name, subscription_id		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
dev_tool_portal_name	string	The name of Dev Tool Portal. Required.
resource_group_name	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. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the Application Live and its properties.

SELECT
id,
name,
components,
features,
provisioningState,
public,
ssoProperties,
systemData,
type,
url
FROM azure_extras.app_platform.dev_tool_portals
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND dev_tool_portal_name = '{{ dev_tool_portal_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handles requests to list all resources in a Service.

SELECT
id,
name,
components,
features,
provisioningState,
public,
ssoProperties,
systemData,
type,
url
FROM azure_extras.app_platform.dev_tool_portals
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.app_platform.dev_tool_portals (
properties,
resource_group_name,
service_name,
dev_tool_portal_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ dev_tool_portal_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dev_tool_portals
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dev_tool_portals resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the dev_tool_portals resource.
  - name: dev_tool_portal_name
    value: "{{ dev_tool_portal_name }}"
    description: Required parameter for the dev_tool_portals resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dev_tool_portals resource.
  - name: properties
    description: |
      Dev Tool Portal properties payload.
    value:
      provisioningState: "{{ provisioningState }}"
      components:
        - name: "{{ name }}"
          resourceRequests:
            cpu: "{{ cpu }}"
            memory: "{{ memory }}"
            instanceCount: {{ instanceCount }}
          instances: "{{ instances }}"
      public: {{ public }}
      url: "{{ url }}"
      ssoProperties:
        scopes:
          - "{{ scopes }}"
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        metadataUrl: "{{ metadataUrl }}"
      features:
        applicationAccelerator:
          state: "{{ state }}"
          route: "{{ route }}"
        applicationLiveView:
          state: "{{ state }}"
          route: "{{ route }}"

REPLACE examples

create_or_update

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

REPLACE azure_extras.app_platform.dev_tool_portals
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND dev_tool_portal_name = '{{ dev_tool_portal_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Disable the default Dev Tool Portal.

DELETE FROM azure_extras.app_platform.dev_tool_portals
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND dev_tool_portal_name = '{{ dev_tool_portal_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;