api_portals

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

Overview

Name	api_portals
Type	Resource
Id	azure.spring_apps.api_portals

Fields

vw_api_portals

Name	Datatype	Description
apiPortalName	text	field from the properties object
api_try_out_enabled_state	text	field from the properties object
gateway_ids	text	field from the properties object
https_only	text	field from the properties object
instances	text	field from the properties object
provisioning_state	text	field from the properties object
public	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_requests	text	field from the properties object
serviceName	text	field from the properties object
sku	text	Sku of Azure Spring Apps
source_urls	text	field from the properties object
sso_properties	text	field from the properties object
subscriptionId	text	field from the properties object
url	text	field from the properties object

api_portals

Name	Datatype	Description
properties	object	API portal properties payload
sku	object	Sku of Azure Spring Apps

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiPortalName, resourceGroupName, serviceName, subscriptionId	Get the API portal and its properties.
list	SELECT	resourceGroupName, serviceName, subscriptionId	Handles requests to list all resources in a Service.
create_or_update	INSERT	apiPortalName, resourceGroupName, serviceName, subscriptionId	Create the default API portal or update the existing API portal.
delete	DELETE	apiPortalName, resourceGroupName, serviceName, subscriptionId	Delete the default API portal.
validate_domain	EXEC	apiPortalName, resourceGroupName, serviceName, subscriptionId, data__name	Check the domains are valid as well as not in use.

SELECT examples

Handles requests to list all resources in a Service.

vw_api_portals

SELECT
apiPortalName,
api_try_out_enabled_state,
gateway_ids,
https_only,
instances,
provisioning_state,
public,
resourceGroupName,
resource_requests,
serviceName,
sku,
source_urls,
sso_properties,
subscriptionId,
url
FROM azure.spring_apps.vw_api_portals
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

api_portals

SELECT
properties,
sku
FROM azure.spring_apps.api_portals
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.spring_apps.api_portals (
apiPortalName,
resourceGroupName,
serviceName,
subscriptionId,
properties,
sku
)
SELECT 
'{{ apiPortalName }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: public
          value: boolean
        - name: url
          value: string
        - name: httpsOnly
          value: boolean
        - name: gatewayIds
          value:
            - string
        - name: sourceUrls
          value:
            - string
        - name: ssoProperties
          value:
            - name: scope
              value:
                - string
            - name: clientId
              value: string
            - name: clientSecret
              value: string
            - name: issuerUri
              value: string
        - name: resourceRequests
          value:
            - name: cpu
              value: string
            - name: memory
              value: string
        - name: instances
          value:
            - - name: name
                value: string
              - name: status
                value: string
        - name: apiTryOutEnabledState
          value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: capacity
          value: integer

DELETE example

Deletes the specified api_portals resource.

/*+ delete */
DELETE FROM azure.spring_apps.api_portals
WHERE apiPortalName = '{{ apiPortalName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';