api_portals

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

Overview

Name	api_portals
Type	Resource
Id	azure.spring_apps.api_portals

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding API portal.

Name	Datatype	Description
properties	object	API portal properties payload
sku	object	Sku of the API portal resource

list

Success. The response describes the list of API portals in the Service.

Name	Datatype	Description
properties	object	API portal properties payload
sku	object	Sku of the API portal resource

Methods

The following methods are available for this resource:

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

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
apiPortalName	string	The name of API 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 API portal and its properties.

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

list

Handles requests to list all resources in a Service.

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

INSERT examples

create_or_update

Create the default API portal or update the existing API portal.

INSERT INTO azure.spring_apps.api_portals (
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
serviceName,
apiPortalName
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ apiPortalName }}'
RETURNING
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: api_portals
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the api_portals resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_portals resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_portals resource.
    - name: apiPortalName
      value: string
      description: Required parameter for the api_portals resource.
    - name: properties
      value: object
      description: |
        API portal properties payload
    - name: sku
      value: object
      description: |
        Sku of the API portal resource

DELETE examples

delete

Delete the default API portal.

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

Lifecycle Methods

validate_domain

Check the domains are valid as well as not in use.

EXEC azure.spring_apps.api_portals.validate_domain 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@apiPortalName='{{ apiPortalName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;