services

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

Overview

Name	services
Type	Resource
Id	azure.spring_apps.services

Fields

vw_services

Name	Datatype	Description
fqdn	text	field from the properties object
identity	text	Managed service identity (either system assigned, or none)
infra_resource_group	text	field from the properties object
location	text	The GEO location of the resource.
maintenance_schedule_configuration	text	field from the properties object
managed_environment_id	text	field from the properties object
marketplace_resource	text	field from the properties object
network_profile	text	field from the properties object
power_state	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
service_id	text	field from the properties object
sku	text	Sku of Azure Spring Apps
subscriptionId	text	field from the properties object
tags	text	Tags of the service which is a list of key value pairs that describe the resource.
version	text	field from the properties object
vnet_addons	text	field from the properties object
zone_redundant	text	field from the properties object

services

Name	Datatype	Description
identity	object	Managed service identity (either system assigned, or none)
location	string	The GEO location of the resource.
properties	object	Service properties payload
sku	object	Sku of Azure Spring Apps
tags	object	Tags of the service which is a list of key value pairs that describe the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serviceName, subscriptionId	Get a Service and its properties.
list	SELECT	resourceGroupName, subscriptionId	Handles requests to list all resources in a resource group.
list_by_subscription	SELECT	subscriptionId	Handles requests to list all resources in a subscription.
create_or_update	INSERT	resourceGroupName, serviceName, subscriptionId	Create a new Service or update an exiting Service.
delete	DELETE	resourceGroupName, serviceName, subscriptionId	Operation to delete a Service.
update	UPDATE	resourceGroupName, serviceName, subscriptionId	Operation to update an exiting Service.
check_name_availability	EXEC	location, subscriptionId, data__name, data__type	Checks that the resource name is valid and is not already in use.
disable_apm_globally	EXEC	resourceGroupName, serviceName, subscriptionId, data__resourceId	Disable an APM globally.
disable_test_endpoint	EXEC	resourceGroupName, serviceName, subscriptionId	Disable test endpoint functionality for a Service.
enable_apm_globally	EXEC	resourceGroupName, serviceName, subscriptionId, data__resourceId	Enable an APM globally.
enable_test_endpoint	EXEC	resourceGroupName, serviceName, subscriptionId	Enable test endpoint functionality for a Service.
flush_vnet_dns_setting	EXEC	resourceGroupName, serviceName, subscriptionId	Flush Virtual Network DNS settings for a VNET injected Service.
regenerate_test_key	EXEC	resourceGroupName, serviceName, subscriptionId, data__keyType	Regenerate a test key for a Service.
start	EXEC	resourceGroupName, serviceName, subscriptionId	Start a Service.
stop	EXEC	resourceGroupName, serviceName, subscriptionId	Stop a Service.

SELECT examples

Handles requests to list all resources in a subscription.

vw_services

SELECT
fqdn,
identity,
infra_resource_group,
location,
maintenance_schedule_configuration,
managed_environment_id,
marketplace_resource,
network_profile,
power_state,
provisioning_state,
resourceGroupName,
serviceName,
service_id,
sku,
subscriptionId,
tags,
version,
vnet_addons,
zone_redundant
FROM azure.spring_apps.vw_services
WHERE subscriptionId = '{{ subscriptionId }}';

services

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.spring_apps.services
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.spring_apps.services (
resourceGroupName,
serviceName,
subscriptionId,
location,
tags,
properties,
identity,
sku
)
SELECT 
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ identity }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: networkProfile
          value:
            - name: serviceRuntimeSubnetId
              value: string
            - name: appSubnetId
              value: string
            - name: serviceCidr
              value: string
            - name: serviceRuntimeNetworkResourceGroup
              value: string
            - name: appNetworkResourceGroup
              value: string
            - name: outboundIPs
              value:
                - name: publicIPs
                  value:
                    - string
            - name: requiredTraffics
              value:
                - - name: protocol
                    value: string
                  - name: port
                    value: integer
                  - name: ips
                    value:
                      - string
                  - name: fqdns
                    value:
                      - string
                  - name: direction
                    value: string
            - name: ingressConfig
              value:
                - name: readTimeoutInSeconds
                  value: integer
            - name: outboundType
              value: string
        - name: vnetAddons
          value:
            - name: logStreamPublicEndpoint
              value: boolean
            - name: dataPlanePublicEndpoint
              value: boolean
            - name: privateStorageAccess
              value: string
            - name: privateDnsZoneId
              value: string
        - name: maintenanceScheduleConfiguration
          value:
            - name: frequency
              value: string
        - name: version
          value: integer
        - name: serviceId
          value: string
        - name: managedEnvironmentId
          value: string
        - name: infraResourceGroup
          value: string
        - name: powerState
          value: string
        - name: zoneRedundant
          value: boolean
        - name: fqdn
          value: string
        - name: marketplaceResource
          value:
            - name: plan
              value: string
            - name: publisher
              value: string
            - name: product
              value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: capacity
          value: integer

UPDATE example

Updates a services resource.

/*+ update */
UPDATE azure.spring_apps.services
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified services resource.

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